lsst::afw::math::SpatialCellImageCandidate Class Reference

Base class for candidate objects in a SpatialCell that are able to return an Image of some sort (e.g. More...

#include <SpatialCell.h>

Inheritance diagram for lsst::afw::math::SpatialCellImageCandidate:

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

Public Member Functions
	SpatialCellImageCandidate (float const xCenter, float const yCenter)
	ctor
	SpatialCellImageCandidate (SpatialCellImageCandidate const &)=default
	SpatialCellImageCandidate (SpatialCellImageCandidate &&)=default
	~SpatialCellImageCandidate () override=default
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 double	getCandidateRating () const =0
	Return candidate's rating.
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 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

Base class for candidate objects in a SpatialCell that are able to return an Image of some sort (e.g.

a PSF or a DIA kernel)

Definition at line 124 of file SpatialCell.h.

Member Enumeration Documentation

Status

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

inherited

Enumerator
BAD
GOOD
UNKNOWN

Definition at line 72 of file SpatialCell.h.

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

Constructor & Destructor Documentation

SpatialCellImageCandidate() [1/3]

lsst::afw::math::SpatialCellImageCandidate::SpatialCellImageCandidate ( float const xCenter, float const yCenter )

inline

ctor

Parameters

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

Definition at line 127 of file SpatialCell.h.

            : SpatialCellCandidate(xCenter, yCenter), _chi2(std::numeric_limits<double>::max()) {}

SpatialCellImageCandidate() [2/3]

lsst::afw::math::SpatialCellImageCandidate::SpatialCellImageCandidate ( SpatialCellImageCandidate const & )

default

SpatialCellImageCandidate() [3/3]

lsst::afw::math::SpatialCellImageCandidate::SpatialCellImageCandidate ( SpatialCellImageCandidate && )

default

~SpatialCellImageCandidate()

lsst::afw::math::SpatialCellImageCandidate::~SpatialCellImageCandidate ( )

overridedefault

Member Function Documentation

getCandidateRating()

virtual double lsst::afw::math::SpatialCellCandidate::getCandidateRating ( ) const

pure virtualinherited

Return candidate's rating.

Implemented in lsst::ip::diffim::KernelCandidate< _PixelT >, and lsst::meas::algorithms::PsfCandidate< PixelT >.

getChi2()

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

inline

Return the candidate's chi^2.

Definition at line 146 of file SpatialCell.h.

{ return _chi2; }

getHeight()

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

inlinestatic

Return the height of the image that getImage should return.

Definition at line 143 of file SpatialCell.h.

{ 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.

{ return _id; }

getStatus()

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

inlineinherited

Return the candidate's status.

Definition at line 104 of file SpatialCell.h.

{ return _status; }

getWidth()

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

inlinestatic

Return the width of the image that getImage should return.

Definition at line 138 of file SpatialCell.h.

{ 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.

{ 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.

{ 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.

{ return true; }

isBad()

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

inlinevirtualinherited

Is this candidate unacceptable?

Definition at line 108 of file SpatialCell.h.

{ return (_status == BAD); }

setCandidateRating()

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

inlinevirtualinherited

Set the candidate's rating.

Definition at line 99 of file SpatialCell.h.

{}

setChi2()

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

inline

Set the candidate's chi^2.

Definition at line 148 of file SpatialCell.h.

{ _chi2 = chi2; }

setHeight()

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

inlinestatic

Set the height of the image that getImage should return.

Definition at line 141 of file SpatialCell.h.

{ _height = height; }

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());
}

setWidth()

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

inlinestatic

Set the width of the image that getImage should return.

Definition at line 136 of file SpatialCell.h.

{ _width = width; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/math/SpatialCell.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/math/SpatialCell.cc