Template Class PsfCandidate

Inheritance Relationships

Base Type

Class Documentation

template<typename PixelT>
class PsfCandidate : public lsst::afw::math::SpatialCellImageCandidate

Class stored in SpatialCells for spatial Psf fitting.

PsfCandidate is a detection that may turn out to be a PSF. We’ll assign them to sets of SpatialCells; these sets will then be used to fit a spatial model to the PSF.

Public Types

typedef std::shared_ptr<PsfCandidate<PixelT>> Ptr
typedef std::shared_ptr<const PsfCandidate<PixelT>> ConstPtr
typedef std::vector<Ptr> PtrList
typedef afw::image::MaskedImage<PixelT> MaskedImageT

Public Functions

lsst::meas::algorithms::PsfCandidate::PsfCandidate(PTR ( afw::table::SourceRecord ) const & source, CONST_PTR( afw::image::Exposure < PixelT >) parentExposure)

Parameters
  • source: The detected Source

  • parentExposure: The image wherein lie the Sources

Construct a PsfCandidate from a specified source and image.

The x/yCenter is set to source.getX/YAstrom()

lsst::meas::algorithms::PsfCandidate::PsfCandidate(PTR ( afw::table::SourceRecord ) const & source, CONST_PTR( afw::image::Exposure < PixelT >) parentExposure, double xCenter, double yCenter)

Parameters
  • source: The detected Source

  • parentExposure: The image wherein lie the Sources

  • xCenter: the desired x center

  • yCenter: the desired y center

Construct a PsfCandidate from a specified source, image and xyCenter.

virtual ~PsfCandidate()

Destructor.

double getCandidateRating() const

Return Cell rating

Note

Required method for use by SpatialCell

PTR(afw::table::SourceRecord) const

Return the original Source.

double getAmplitude() const

Return the best-fit amplitude.

void setAmplitude(double amplitude)

Set the best-fit amplitude.

double getVar() const

Return the variance in use when fitting this object.

void setVar(double var)

Set the variance to use when fitting this object.

CONST_PTR(afw::image::MaskedImage<PixelT>) const
CONST_PTR(afw::image::MaskedImage<PixelT>)

Public Members

int height lsst::meas::algorithms::PsfCandidate::const

Public Static Functions

static void setBorderWidth(int border)

Set the number of pixels to ignore around the candidate image’s edge.

static void setPixelThreshold(float threshold)

Set threshold for rejecting pixels unconnected with the central footprint

A non-positive threshold means that no threshold will be applied.

static float getPixelThreshold()

Get threshold for rejecting pixels unconnected with the central footprint.

static void setMaskBlends(bool doMaskBlends)

Set whether blends are masked.

static bool getMaskBlends()

Get whether blends are masked.