lsst::afw::math::SpatialCellCandidate Class Reference

Base class for candidate objects in a SpatialCell. More...

#include <SpatialCell.h>

Inheritance diagram for lsst::afw::math::SpatialCellCandidate:

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

Public Member Functions
	SpatialCellCandidate (float const xCenter, float const yCenter)
	SpatialCellCandidate (SpatialCellCandidate const &)=default
	SpatialCellCandidate (SpatialCellCandidate &&)=default
virtual	~SpatialCellCandidate ()=default
	(virtual) destructor – this is a base class you know More...
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...

Detailed Description

Base class for candidate objects in a SpatialCell.

Definition at line 70 of file SpatialCell.h.

Member Enumeration Documentation

Status

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

Enumerator
BAD
GOOD
UNKNOWN

Definition at line 72 of file SpatialCell.h.

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

Constructor & Destructor Documentation

SpatialCellCandidate() [1/3]

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

inline

Parameters

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

Definition at line 74 of file SpatialCell.h.

            : _id(++_CandidateId), _status(UNKNOWN), _xCenter(xCenter), _yCenter(yCenter) {}

SpatialCellCandidate() [2/3]

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

default

SpatialCellCandidate() [3/3]

lsst::afw::math::SpatialCellCandidate::SpatialCellCandidate ( SpatialCellCandidate &&  )

default

~SpatialCellCandidate()

virtual lsst::afw::math::SpatialCellCandidate::~SpatialCellCandidate ( )

virtualdefault

(virtual) destructor – this is a base class you know

Member Function Documentation

getCandidateRating()

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

pure virtual

Return candidate's rating.

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

getId()

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

inline

Return the candidate's unique ID.

Definition at line 102 of file SpatialCell.h.

{ return _id; }

getStatus()

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

inline

Return the candidate's status.

Definition at line 104 of file SpatialCell.h.

{ return _status; }

getXCenter()

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

inline

Return the object's column-centre.

Definition at line 88 of file SpatialCell.h.

{ return _xCenter; }

getYCenter()

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

inline

Return the object's row-centre.

Definition at line 91 of file SpatialCell.h.

{ return _yCenter; }

instantiate()

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

inlinevirtual

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

inlinevirtual

Is this candidate unacceptable?

Definition at line 108 of file SpatialCell.h.

{ return (_status == BAD); }

setCandidateRating()

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

inlinevirtual

Set the candidate's rating.

Definition at line 99 of file SpatialCell.h.

{}

setStatus()

void lsst::afw::math::SpatialCellCandidate::setStatus

(

Status

status

)

Set the candidate's status.

Definition at line 53 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());
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/math/SpatialCell.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/math/SpatialCell.cc