Class stored in SpatialCells for spatial Psf fitting. More...

#include <PsfCandidate.h>

Inheritance diagram for lsst::meas::algorithms::PsfCandidate< PixelT >:

Public Types
typedef std::shared_ptr< PsfCandidate< PixelT > >	Ptr

typedef std::shared_ptr< const PsfCandidate< PixelT > >	ConstPtr

typedef std::vector< Ptr >	PtrList

typedef afw::image::MaskedImage< PixelT >	MaskedImageT

enum	Status { BAD = 0 , GOOD = 1 , UNKNOWN = 2 }

Public Member Functions
	PsfCandidate (std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure)
	Construct a PsfCandidate from a specified source and image.

	PsfCandidate (std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure, double xCenter, double yCenter)
	Construct a PsfCandidate from a specified source, image and xyCenter.

virtual	~PsfCandidate ()
	Destructor.

double	getCandidateRating () const
	Return Cell rating.

std::shared_ptr< afw::table::SourceRecord >	getSource () const
	Return the original Source.

double	getAmplitude () const
	Return the best-fit amplitude.

void	setAmplitude (double amplitude)
	Set the best-fit amplitude.

void	setPsfColorValue (double psfColorValue)
	Set psf color value to use for PSF fit.

double	getPsfColorValue () const
	Return psf color value to use for PSF fit.

void	setPsfColorType (std::string psfColorType)
	Set psf color type to use for PSF fit.

std::string	getPsfColorType () const
	Return psf color type to use for PSF fit.

double	getVar () const
	Return the variance in use when fitting this object.

void	setVar (double var)
	Set the variance to use when fitting this object.

std::shared_ptr< afw::image::MaskedImage< PixelT > const >	getMaskedImage () const
	Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

std::shared_ptr< afw::image::MaskedImage< PixelT > const >	getMaskedImage (int width, int height) const
	Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

std::shared_ptr< afw::image::MaskedImage< PixelT > >	getOffsetImage (std::string const algorithm, unsigned int buffer) const
	Return an offset version of the image of the source.

double	getChi2 () const
	Return the candidate's chi^2.

void	setChi2 (double chi2)
	Set the candidate's chi^2.

float	getXCenter () const
	Return the object's column-centre.

float	getYCenter () const
	Return the object's row-centre.

virtual bool	instantiate ()
	Do anything needed to make this candidate usable.

virtual void	setCandidateRating (double)
	Set the candidate's rating.

int	getId () const
	Return the candidate's unique ID.

Status	getStatus () const
	Return the candidate's status.

void	setStatus (Status status)
	Set the candidate's status.

virtual bool	isBad () const
	Is this candidate unacceptable?

Static Public Member Functions
static int	getBorderWidth ()
	Return the number of pixels being ignored around the candidate image's edge.

static void	setBorderWidth (int border)
	Set the number of pixels to ignore around the candidate image's edge.

static void	setPixelThreshold (float threshold)
	Set threshold for rejecting pixels unconnected with the central footprint.

static float	getPixelThreshold ()
	Get threshold for rejecting pixels unconnected with the central footprint.

static void	setMaskBlends (bool doMaskBlends)
	Set whether blends are masked.

static bool	getMaskBlends ()
	Get whether blends are masked.

static void	setWidth (int width)
	Set the width of the image that getImage should return.

static int	getWidth ()
	Return the width of the image that getImage should return.

static void	setHeight (int height)
	Set the height of the image that getImage should return.

static int	getHeight ()
	Return the height of the image that getImage should return.

Detailed Description

template<typename PixelT>
class lsst::meas::algorithms::PsfCandidate< PixelT >

Class stored in SpatialCells for spatial Psf fitting.

PsfCandidate is a detection that may turn out to be a PSF. We'll assign them to sets of SpatialCells; these sets will then be used to fit a spatial model to the PSF.

Definition at line 57 of file PsfCandidate.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PixelT>

typedef std::shared_ptr<const PsfCandidate<PixelT> > lsst::meas::algorithms::PsfCandidate< PixelT >::ConstPtr

Definition at line 60 of file PsfCandidate.h.

◆ MaskedImageT

template<typename PixelT>

typedef afw::image::MaskedImage<PixelT> lsst::meas::algorithms::PsfCandidate< PixelT >::MaskedImageT

Definition at line 63 of file PsfCandidate.h.

◆ Ptr

template<typename PixelT>

typedef std::shared_ptr<PsfCandidate<PixelT> > lsst::meas::algorithms::PsfCandidate< PixelT >::Ptr

Definition at line 59 of file PsfCandidate.h.

◆ PtrList

template<typename PixelT>

typedef std::vector<Ptr> lsst::meas::algorithms::PsfCandidate< PixelT >::PtrList

Definition at line 61 of file PsfCandidate.h.

Member Enumeration Documentation

◆ Status

enum lsst::afw::math::SpatialCellCandidate::Status

inherited

Enumerator
BAD
GOOD
UNKNOWN

Definition at line 72 of file SpatialCell.h.

72{ BAD = 0, GOOD = 1, UNKNOWN = 2 };

lsst::afw::math::SpatialCellCandidate::BAD

@ BAD

Definition SpatialCell.h:72

lsst::afw::math::SpatialCellCandidate::UNKNOWN

@ UNKNOWN

Definition SpatialCell.h:72

lsst::afw::math::SpatialCellCandidate::GOOD

@ GOOD

Definition SpatialCell.h:72

Constructor & Destructor Documentation

◆ PsfCandidate() [1/2]

template<typename PixelT>

lsst::meas::algorithms::PsfCandidate< PixelT >::PsfCandidate	(	std::shared_ptr< afw::table::SourceRecord > const &	source,
		std::shared_ptr< afw::image::Exposure< PixelT > const >	parentExposure )

inline

Construct a PsfCandidate from a specified source and image.

The x/yCenter is set to source.getX/YAstrom()

Parameters

source	The detected Source
parentExposure	The image wherein lie the Sources

Definition at line 70 of file PsfCandidate.h.

            : afw::math::SpatialCellImageCandidate(source->getX(), source->getY()),
              _parentExposure(parentExposure),
              _offsetImage(),
              _source(source),
              _image(nullptr),
              _amplitude(0.0),
              _var(1.0),
              _psfColorValue(std::numeric_limits<double>::quiet_NaN()),
              _psfColorType() {}

◆ PsfCandidate() [2/2]

template<typename PixelT>

lsst::meas::algorithms::PsfCandidate< PixelT >::PsfCandidate	(	std::shared_ptr< afw::table::SourceRecord > const &	source,
		std::shared_ptr< afw::image::Exposure< PixelT > const >	parentExposure,
		double	xCenter,
		double	yCenter )

inline

Construct a PsfCandidate from a specified source, image and xyCenter.

Parameters

source	The detected Source
parentExposure	The image wherein lie the Sources
xCenter	the desired x center
yCenter	the desired y center

Definition at line 87 of file PsfCandidate.h.

            : afw::math::SpatialCellImageCandidate(xCenter, yCenter),
              _parentExposure(parentExposure),
              _offsetImage(),
              _source(source),
              _image(nullptr),
              _amplitude(0.0),
              _var(1.0),
              _psfColorValue(std::numeric_limits<double>::quiet_NaN()),
              _psfColorType() {}

◆ ~PsfCandidate()

template<typename PixelT>

virtual lsst::meas::algorithms::PsfCandidate< PixelT >::~PsfCandidate ( )

inlinevirtual

Destructor.

Definition at line 104 of file PsfCandidate.h.

104{};

Member Function Documentation

◆ getAmplitude()

template<typename PixelT>

double lsst::meas::algorithms::PsfCandidate< PixelT >::getAmplitude ( ) const

inline

Return the best-fit amplitude.

Definition at line 117 of file PsfCandidate.h.

117{ return _amplitude; }

◆ getBorderWidth()

template<typename PixelT>

int lsst::meas::algorithms::PsfCandidate< PixelT >::getBorderWidth ( )

static

Return the number of pixels being ignored around the candidate image's edge.

Definition at line 298 of file PsfCandidate.cc.

                                         {
    return _border;
}

◆ getCandidateRating()

template<typename PixelT>

double lsst::meas::algorithms::PsfCandidate< PixelT >::getCandidateRating ( ) const

inlinevirtual

Return Cell rating.

Note: Required method for use by SpatialCell

Implements lsst::afw::math::SpatialCellCandidate.

Definition at line 111 of file PsfCandidate.h.

111{ return _source->getPsfInstFlux(); }

◆ getChi2()

double lsst::afw::math::SpatialCellImageCandidate::getChi2 ( ) const

inlineinherited

Return the candidate's chi^2.

Definition at line 146 of file SpatialCell.h.

146{ return _chi2; }

◆ getHeight()

static int lsst::afw::math::SpatialCellImageCandidate::getHeight ( )

inlinestaticinherited

Return the height of the image that getImage should return.

Definition at line 143 of file SpatialCell.h.

143{ return _height; }

◆ getId()

int lsst::afw::math::SpatialCellCandidate::getId ( ) const

inlineinherited

Return the candidate's unique ID.

Definition at line 102 of file SpatialCell.h.

102{ return _id; }

◆ getMaskBlends()

template<typename PixelT>

bool lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskBlends ( )

static

Get whether blends are masked.

Definition at line 323 of file PsfCandidate.cc.

                                         {
    return _doMaskBlends;
}

◆ getMaskedImage() [1/2]

template<typename PixelT>

std::shared_ptr< afw::image::MaskedImage< PixelT > const > lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskedImage ( ) const

Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

Definition at line 291 of file PsfCandidate.cc.

                                           {
    int const width = getWidth() == 0 ? _defaultWidth : getWidth();
    int const height = getHeight() == 0 ? _defaultWidth : getHeight();
    return getMaskedImage(width, height);
}

◆ getMaskedImage() [2/2]

template<typename PixelT>

std::shared_ptr< afw::image::MaskedImage< PixelT > const > lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskedImage	(	int	width,
		int	height ) const

Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

Definition at line 277 of file PsfCandidate.cc.

                                                                {
    if (!_image || (width != _image->getWidth() || height != _image->getHeight())) {
        _image = extractImage(width, height);
    }
    return _image;
}

◆ getOffsetImage()

template<typename PixelT>

std::shared_ptr< afw::image::MaskedImage< PixelT > > lsst::meas::algorithms::PsfCandidate< PixelT >::getOffsetImage	(	std::string const	algorithm,
		unsigned int	buffer ) const

Return an offset version of the image of the source.

The returned image has been offset to put the centre of the object in the centre of a pixel.

Definition at line 334 of file PsfCandidate.cc.

                                             {
    unsigned int const width = getWidth() == 0 ? _defaultWidth : getWidth();
    unsigned int const height = getHeight() == 0 ? _defaultWidth : getHeight();
    if (_offsetImage && static_cast<unsigned int>(_offsetImage->getWidth()) == width + 2 * buffer &&
        static_cast<unsigned int>(_offsetImage->getHeight()) == height + 2 * buffer) {
        return _offsetImage;
    }
 
    std::shared_ptr<MaskedImageT> image = extractImage(width + 2 * buffer, height + 2 * buffer);
 
    double const xcen = getXCenter(), ycen = getYCenter();
    double const dx = afw::image::positionToIndex(xcen, true).second;
    double const dy = afw::image::positionToIndex(ycen, true).second;
 
    std::shared_ptr<MaskedImageT> offset = afw::math::offsetImage(*image, -dx, -dy, algorithm);
    geom::Point2I llc(buffer, buffer);
    geom::Extent2I dims(width, height);
    geom::Box2I box(llc, dims);
    _offsetImage.reset(new MaskedImageT(*offset, box, afw::image::LOCAL, true));  // Deep copy
 
    return _offsetImage;
}

◆ getPixelThreshold()

template<typename PixelT>

float lsst::meas::algorithms::PsfCandidate< PixelT >::getPixelThreshold ( )

static

Get threshold for rejecting pixels unconnected with the central footprint.

Definition at line 313 of file PsfCandidate.cc.

                                              {
    return _pixelThreshold;
}

◆ getPsfColorType()

template<typename PixelT>

std::string lsst::meas::algorithms::PsfCandidate< PixelT >::getPsfColorType ( ) const

inline

Return psf color type to use for PSF fit.

Definition at line 132 of file PsfCandidate.h.

132{ return _psfColorType; }

◆ getPsfColorValue()

template<typename PixelT>

double lsst::meas::algorithms::PsfCandidate< PixelT >::getPsfColorValue ( ) const

inline

Return psf color value to use for PSF fit.

Definition at line 126 of file PsfCandidate.h.

126{ return _psfColorValue; }

◆ getSource()

template<typename PixelT>

std::shared_ptr< afw::table::SourceRecord > lsst::meas::algorithms::PsfCandidate< PixelT >::getSource ( ) const

inline

Return the original Source.

Definition at line 114 of file PsfCandidate.h.

114{ return _source; }

◆ getStatus()

Status lsst::afw::math::SpatialCellCandidate::getStatus ( ) const

inlineinherited

Return the candidate's status.

Definition at line 104 of file SpatialCell.h.

104{ return _status; }

◆ getVar()

template<typename PixelT>

double lsst::meas::algorithms::PsfCandidate< PixelT >::getVar ( ) const

inline

Return the variance in use when fitting this object.

Definition at line 135 of file PsfCandidate.h.

135{ return _var; }

◆ getWidth()

static int lsst::afw::math::SpatialCellImageCandidate::getWidth ( )

inlinestaticinherited

Return the width of the image that getImage should return.

Definition at line 138 of file SpatialCell.h.

138{ return _width; }

◆ getXCenter()

float lsst::afw::math::SpatialCellCandidate::getXCenter ( ) const

inlineinherited

Return the object's column-centre.

Definition at line 88 of file SpatialCell.h.

88{ return _xCenter; }

◆ getYCenter()

float lsst::afw::math::SpatialCellCandidate::getYCenter ( ) const

inlineinherited

Return the object's row-centre.

Definition at line 91 of file SpatialCell.h.

91{ return _yCenter; }

◆ instantiate()

virtual bool lsst::afw::math::SpatialCellCandidate::instantiate ( )

inlinevirtualinherited

Do anything needed to make this candidate usable.

Definition at line 94 of file SpatialCell.h.

94{ return true; }

◆ isBad()

virtual bool lsst::afw::math::SpatialCellCandidate::isBad ( ) const

inlinevirtualinherited

Is this candidate unacceptable?

Definition at line 108 of file SpatialCell.h.

108{ return (_status == BAD); }

◆ setAmplitude()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setAmplitude ( double amplitude )

inline

Set the best-fit amplitude.

Definition at line 120 of file PsfCandidate.h.

120{ _amplitude = amplitude; }

◆ setBorderWidth()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setBorderWidth ( int border )

static

Set the number of pixels to ignore around the candidate image's edge.

Definition at line 303 of file PsfCandidate.cc.

                                                    {
    _border = border;
}

◆ setCandidateRating()

virtual void lsst::afw::math::SpatialCellCandidate::setCandidateRating ( double )

inlinevirtualinherited

Set the candidate's rating.

Definition at line 99 of file SpatialCell.h.

99{}

◆ setChi2()

void lsst::afw::math::SpatialCellImageCandidate::setChi2 ( double chi2 )

inlineinherited

Set the candidate's chi^2.

Definition at line 148 of file SpatialCell.h.

148{ _chi2 = chi2; }

◆ setHeight()

static void lsst::afw::math::SpatialCellImageCandidate::setHeight ( int height )

inlinestaticinherited

Set the height of the image that getImage should return.

Definition at line 141 of file SpatialCell.h.

141{ _height = height; }

◆ setMaskBlends()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setMaskBlends ( bool doMaskBlends )

static

Set whether blends are masked.

Definition at line 318 of file PsfCandidate.cc.

                                                          {
    _doMaskBlends = doMaskBlends;
}

◆ setPixelThreshold()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setPixelThreshold ( float threshold )

static

Set threshold for rejecting pixels unconnected with the central footprint.

A non-positive threshold means that no threshold will be applied.

Definition at line 308 of file PsfCandidate.cc.

                                                            {
    _pixelThreshold = threshold;
}

◆ setPsfColorType()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setPsfColorType ( std::string psfColorType )

inline

Set psf color type to use for PSF fit.

Definition at line 129 of file PsfCandidate.h.

129{ _psfColorType = psfColorType; }

◆ setPsfColorValue()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setPsfColorValue ( double psfColorValue )

inline

Set psf color value to use for PSF fit.

Definition at line 123 of file PsfCandidate.h.

123{ _psfColorValue = psfColorValue; }

◆ setStatus()

void lsst::afw::math::SpatialCellCandidate::setStatus ( Status status )

inherited

Set the candidate's status.

Definition at line 52 of file SpatialCell.cc.

                                                  {
    switch (status) {
        case GOOD:
        case UNKNOWN:
            _status = status;
            return;
        case BAD:
            _status = status;
            return;
    }
 
    throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                      (boost::format("Saw unknown status %d") % status).str());
}

◆ setVar()

template<typename PixelT>

void lsst::meas::algorithms::PsfCandidate< PixelT >::setVar ( double var )

inline

Set the variance to use when fitting this object.

Definition at line 138 of file PsfCandidate.h.

138{ _var = var; }

◆ setWidth()

static void lsst::afw::math::SpatialCellImageCandidate::setWidth ( int width )

inlinestaticinherited

Set the width of the image that getImage should return.

Definition at line 136 of file SpatialCell.h.

136{ _width = width; }

The documentation for this class was generated from the following files:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/meas_algorithms/gdb1e2cdc75+1b18322db8/include/lsst/meas/algorithms/PsfCandidate.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/meas_algorithms/gdb1e2cdc75+1b18322db8/src/PsfCandidate.cc

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ MaskedImageT

◆ Ptr

◆ PtrList

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ PsfCandidate() [1/2]

◆ PsfCandidate() [2/2]

◆ ~PsfCandidate()

Member Function Documentation

◆ getAmplitude()

◆ getBorderWidth()

◆ getCandidateRating()

◆ getChi2()

◆ getHeight()

◆ getId()

◆ getMaskBlends()

◆ getMaskedImage() [1/2]

◆ getMaskedImage() [2/2]

◆ getOffsetImage()

◆ getPixelThreshold()

◆ getPsfColorType()

◆ getPsfColorValue()

◆ getSource()

◆ getStatus()

◆ getVar()

◆ getWidth()

◆ getXCenter()

◆ getYCenter()

◆ instantiate()

◆ isBad()

◆ setAmplitude()

◆ setBorderWidth()

◆ setCandidateRating()

◆ setChi2()

◆ setHeight()

◆ setMaskBlends()

◆ setPixelThreshold()

◆ setPsfColorType()

◆ setPsfColorValue()

◆ setStatus()

◆ setVar()

◆ setWidth()