lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT > Class Template Reference

#include <SpatialCell.h>

Inheritance diagram for lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >:

Public Types
typedef boost::shared_ptr < SpatialCellMaskedImageCandidate >	Ptr
typedef boost::shared_ptr < const SpatialCellMaskedImageCandidate >	ConstPtr
Public Types inherited from lsst::afw::math::SpatialCellCandidate
enum	Status { BAD = 0, GOOD = 1, UNKNOWN = 2 }
typedef boost::shared_ptr < SpatialCellCandidate >	Ptr
typedef boost::shared_ptr < const SpatialCellCandidate >	ConstPtr

Public Member Functions
	SpatialCellMaskedImageCandidate (float const xCenter, float const yCenter)
	ctor More...
virtual	~SpatialCellMaskedImageCandidate ()
virtual boost::shared_ptr < lsst::afw::image::MaskedImage < PixelT const > lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel >	getMaskedImage () const =0
	Return the Candidate's Image. More...
double	getChi2 () const
	Return the candidate's chi^2. More...
void	setChi2 (double chi2)
	Set the candidate's chi^2. More...
Public Member Functions inherited from lsst::afw::math::SpatialCellCandidate
	SpatialCellCandidate (float const xCenter, float const yCenter)
virtual	~SpatialCellCandidate ()
float	getXCenter () const
	Return the object's column-centre. More...
float	getYCenter () const
	Return the object's row-centre. More...
virtual bool	instantiate ()
	Do anything needed to make this candidate usable. More...
virtual double	getCandidateRating () const =0
	Return candidate's rating. More...
virtual void	setCandidateRating (double)
	Set the candidate's rating. More...
int	getId () const
	Return the candidate's unique ID. More...
Status	getStatus () const
	Return the candidate's status. More...
void	setStatus (Status status)
	Set the candidate's status. More...
virtual bool	isBad () const
	Is this candidate unacceptable? More...

Static Public Member Functions
static void	setWidth (int width)
	Set the width of the image that getImage should return. More...
static int	getWidth ()
	Return the width of the image that getImage should return. More...
static void	setHeight (int height)
	Set the height of the image that getImage should return. More...
static int	getHeight ()
	Return the height of the image that getImage should return. More...

Protected Attributes
boost::shared_ptr < lsst::afw::image::MaskedImage < PixelT > lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel >	_image
	a pointer to the MaskedImage, for the use of the base class More...

Private Attributes
double	_chi2

Static Private Attributes
static int	_width = 0
	The width of images that SpatialCellMaskedImageCandidate should return; may be ignored by subclasses. More...
static int	_height = 0
	The height of images that SpatialCellMaskedImageCandidate should return; may be ignored by subclasses. More...

Detailed Description

template<typename PixelT>
class lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >

Base class for candidate objects in a SpatialCell that are able to return a MaskedImage of some sort (e.g. a PSF or a DIA kernel)

Examples:

testSpatialCell.h.

Definition at line 189 of file SpatialCell.h.

Member Typedef Documentation

template<typename PixelT >

typedef boost::shared_ptr<const SpatialCellMaskedImageCandidate> lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::ConstPtr

Definition at line 192 of file SpatialCell.h.

template<typename PixelT >

typedef boost::shared_ptr<SpatialCellMaskedImageCandidate> lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::Ptr

Examples:

testSpatialCell.h.

Definition at line 191 of file SpatialCell.h.

Constructor & Destructor Documentation

template<typename PixelT >

lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::SpatialCellMaskedImageCandidate ( float const  xCenter, float const  yCenter  )

inline

ctor

Parameters

xCenter	The object's column-centre
yCenter	The object's row-centre

Definition at line 195 of file SpatialCell.h.

                                         : SpatialCellCandidate(xCenter, yCenter),
                                           _image(PTR(lsst::afw::image::MaskedImage<PixelT,
                                                      lsst::afw::image::MaskPixel,
                                                      lsst::afw::image::VariancePixel>)()),
                                           _chi2(std::numeric_limits<double>::max()) {
        }

template<typename PixelT >

virtual lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::~SpatialCellMaskedImageCandidate ( )

inlinevirtual

Definition at line 203 of file SpatialCell.h.

{}

Member Function Documentation

template<typename PixelT >

double lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::getChi2 ( ) const

inline

Return the candidate's chi^2.

Definition at line 222 of file SpatialCell.h.

{ return _chi2; }

template<typename PixelT >

static int lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::getHeight ( )

inlinestatic

Return the height of the image that getImage should return.

Definition at line 219 of file SpatialCell.h.

{ return _height; }

template<typename PixelT >

virtual boost::shared_ptr< lsst::afw::image::MaskedImage<PixelT const>lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel> lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::getMaskedImage ( ) const

pure virtual

Return the Candidate's Image.

Implemented in lsst::meas::algorithms::PsfCandidate< PixelT >.

Examples:

testSpatialCell.h.

template<typename PixelT >

static int lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::getWidth ( )

inlinestatic

Return the width of the image that getImage should return.

Definition at line 214 of file SpatialCell.h.

{ return _width; }

template<typename PixelT >

void lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::setChi2 ( double  chi2 )

inline

Set the candidate's chi^2.

Definition at line 224 of file SpatialCell.h.

{ _chi2 = chi2; }

template<typename PixelT >

static void lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::setHeight ( int  height )

inlinestatic

Set the height of the image that getImage should return.

Definition at line 217 of file SpatialCell.h.

{ _height = height; }

template<typename PixelT >

static void lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::setWidth ( int  width )

inlinestatic

Set the width of the image that getImage should return.

Definition at line 210 of file SpatialCell.h.

                                        {
            _width = width;
        }

Member Data Documentation

template<typename PixelT >

double lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::_chi2

private

Definition at line 232 of file SpatialCell.h.

template<typename PixelT >

int lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::_height = 0

staticprivate

The height of images that SpatialCellMaskedImageCandidate should return; may be ignored by subclasses.

Definition at line 231 of file SpatialCell.h.

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::MaskedImage<PixelT >lsst::afw::image::MaskPixel, lsst::afw::image::VariancePixel> lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::_image

mutableprotected

a pointer to the MaskedImage, for the use of the base class

Definition at line 228 of file SpatialCell.h.

template<typename PixelT >

int lsst::afw::math::SpatialCellMaskedImageCandidate< PixelT >::_width = 0

staticprivate

The width of images that SpatialCellMaskedImageCandidate should return; may be ignored by subclasses.

Definition at line 230 of file SpatialCell.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/SpatialCell.h