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

#include <SpatialCell.h>

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

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

Public Member Functions
	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...

Private Attributes
int	_id
Status	_status
float const	_xCenter
float const	_yCenter

Static Private Attributes
static int	_CandidateId = 0
	Unique identifier for candidates; useful for preserving current candidate following insertion. More...

Detailed Description

Base class for candidate objects in a SpatialCell

Examples:

testSpatialCell.h.

Definition at line 74 of file SpatialCell.h.

Member Typedef Documentation

typedef boost::shared_ptr<const SpatialCellCandidate> lsst::afw::math::SpatialCellCandidate::ConstPtr

Definition at line 77 of file SpatialCell.h.

typedef boost::shared_ptr<SpatialCellCandidate> lsst::afw::math::SpatialCellCandidate::Ptr

Definition at line 76 of file SpatialCell.h.

Member Enumeration Documentation

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

Enumerator
BAD
GOOD
UNKNOWN

Definition at line 79 of file SpatialCell.h.

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

Constructor & Destructor Documentation

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 81 of file SpatialCell.h.

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

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

inlinevirtual

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

Definition at line 92 of file SpatialCell.h.

{}

Member Function Documentation

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

pure virtual

Return candidate's rating.

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

Examples:

testSpatialCell.h.

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

inline

Return the candidate's unique ID.

Definition at line 109 of file SpatialCell.h.

{ return _id; }

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

inline

Return the candidate's status.

Definition at line 111 of file SpatialCell.h.

{ return _status; }

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

inline

Return the object's column-centre.

Definition at line 95 of file SpatialCell.h.

{ return _xCenter; }

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

inline

Return the object's row-centre.

Definition at line 98 of file SpatialCell.h.

{ return _yCenter; }

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

inlinevirtual

Do anything needed to make this candidate usable.

Definition at line 101 of file SpatialCell.h.

{ return true; }

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

inlinevirtual

Is this candidate unacceptable?

Definition at line 114 of file SpatialCell.h.

                                   {
            return (_status == BAD);
        }

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

inlinevirtual

Set the candidate's rating.

Definition at line 106 of file SpatialCell.h.

{}

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

(

Status

status

)

Set the candidate's status.

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

Member Data Documentation

int lsst::afw::math::SpatialCellCandidate::_CandidateId = 0

staticprivate

Unique identifier for candidates; useful for preserving current candidate following insertion.

Definition at line 123 of file SpatialCell.h.

int lsst::afw::math::SpatialCellCandidate::_id

private

Definition at line 118 of file SpatialCell.h.

Status lsst::afw::math::SpatialCellCandidate::_status

private

Definition at line 119 of file SpatialCell.h.

float const lsst::afw::math::SpatialCellCandidate::_xCenter

private

Definition at line 120 of file SpatialCell.h.

float const lsst::afw::math::SpatialCellCandidate::_yCenter

private

Definition at line 121 of file SpatialCell.h.

---

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

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