Class SpatialCellCandidate

Inheritance Relationships

Derived Type

Class Documentation

class SpatialCellCandidate

Base class for candidate objects in a SpatialCell

Subclassed by lsst::afw::math::SpatialCellImageCandidate

Public Types

enum Status

Values:

BAD = 0
GOOD = 1
UNKNOWN = 2

Public Functions

SpatialCellCandidate(float const xCenter, float const yCenter)

Parameters
  • xCenter: The object’s column-centre

  • yCenter: The object’s row-centre

SpatialCellCandidate(SpatialCellCandidate const&)
SpatialCellCandidate(SpatialCellCandidate&&)
SpatialCellCandidate &operator=(SpatialCellCandidate const&)
SpatialCellCandidate &operator=(SpatialCellCandidate&&)
virtual ~SpatialCellCandidate()

(virtual) destructor this is a base class you know

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?