lsst.meas.algorithms g10988951d7+eadaf988e0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst::meas::algorithms::PsfCandidate< PixelT > Class Template Reference

Class stored in SpatialCells for spatial Psf fitting. More...

#include <PsfCandidate.h>

Inheritance diagram for lsst::meas::algorithms::PsfCandidate< PixelT >:
lsst::afw::math::SpatialCellImageCandidate lsst::afw::math::SpatialCellCandidate

Public Types

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

Public Member Functions

 PsfCandidate (std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure)
 Construct a PsfCandidate from a specified source and image.
 
 PsfCandidate (std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure, double xCenter, double yCenter)
 Construct a PsfCandidate from a specified source, image and xyCenter.
 
virtual ~PsfCandidate ()
 Destructor.
 
double getCandidateRating () const
 Return Cell rating.
 
std::shared_ptr< afw::table::SourceRecordgetSource () 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.
 
std::shared_ptr< afw::image::MaskedImage< PixelT > const > getMaskedImage () const
 Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())
 
std::shared_ptr< afw::image::MaskedImage< PixelT > const > getMaskedImage (int width, int height) const
 Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())
 
std::shared_ptr< afw::image::MaskedImage< PixelT > > getOffsetImage (std::string const algorithm, unsigned int buffer) const
 Return an offset version of the image of the source.
 
double getChi2 () const
 
void setChi2 (double chi2)
 
float getXCenter () const
 
float getYCenter () const
 
virtual bool instantiate ()
 
virtual void setCandidateRating (double)
 
int getId () const
 
Status getStatus () const
 
void setStatus (Status status)
 
void setStatus (Status status)
 
virtual bool isBad () const
 

Static Public Member Functions

static int getBorderWidth ()
 Return the number of pixels being ignored around the candidate image's edge.
 
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.
 
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.
 
static void setWidth (int width)
 
static int getWidth ()
 
static void setHeight (int height)
 
static int getHeight ()
 

Public Attributes

 BAD
 
 GOOD
 
 UNKNOWN
 

Detailed Description

template<typename PixelT>
class lsst::meas::algorithms::PsfCandidate< PixelT >

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.

Definition at line 55 of file PsfCandidate.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PixelT >
typedef std::shared_ptr<const PsfCandidate<PixelT> > lsst::meas::algorithms::PsfCandidate< PixelT >::ConstPtr

Definition at line 58 of file PsfCandidate.h.

◆ MaskedImageT

template<typename PixelT >
typedef afw::image::MaskedImage<PixelT> lsst::meas::algorithms::PsfCandidate< PixelT >::MaskedImageT

Definition at line 61 of file PsfCandidate.h.

◆ Ptr

template<typename PixelT >
typedef std::shared_ptr<PsfCandidate<PixelT> > lsst::meas::algorithms::PsfCandidate< PixelT >::Ptr

Definition at line 57 of file PsfCandidate.h.

◆ PtrList

template<typename PixelT >
typedef std::vector<Ptr> lsst::meas::algorithms::PsfCandidate< PixelT >::PtrList

Definition at line 59 of file PsfCandidate.h.

Constructor & Destructor Documentation

◆ PsfCandidate() [1/2]

template<typename PixelT >
lsst::meas::algorithms::PsfCandidate< PixelT >::PsfCandidate ( std::shared_ptr< afw::table::SourceRecord > const & source,
std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure )
inline

Construct a PsfCandidate from a specified source and image.

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

Parameters
sourceThe detected Source
parentExposureThe image wherein lie the Sources

Definition at line 68 of file PsfCandidate.h.

◆ PsfCandidate() [2/2]

template<typename PixelT >
lsst::meas::algorithms::PsfCandidate< PixelT >::PsfCandidate ( std::shared_ptr< afw::table::SourceRecord > const & source,
std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure,
double xCenter,
double yCenter )
inline

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

Parameters
sourceThe detected Source
parentExposureThe image wherein lie the Sources
xCenterthe desired x center
yCenterthe desired y center

Definition at line 83 of file PsfCandidate.h.

◆ ~PsfCandidate()

template<typename PixelT >
virtual lsst::meas::algorithms::PsfCandidate< PixelT >::~PsfCandidate ( )
inlinevirtual

Destructor.

Definition at line 98 of file PsfCandidate.h.

Member Function Documentation

◆ getAmplitude()

template<typename PixelT >
double lsst::meas::algorithms::PsfCandidate< PixelT >::getAmplitude ( ) const
inline

Return the best-fit amplitude.

Definition at line 111 of file PsfCandidate.h.

◆ getBorderWidth()

template<typename PixelT >
int lsst::meas::algorithms::PsfCandidate< PixelT >::getBorderWidth ( )
static

Return the number of pixels being ignored around the candidate image's edge.

Definition at line 298 of file PsfCandidate.cc.

◆ getCandidateRating()

template<typename PixelT >
double lsst::meas::algorithms::PsfCandidate< PixelT >::getCandidateRating ( ) const
inlinevirtual

Return Cell rating.

Note
Required method for use by SpatialCell

Implements lsst::afw::math::SpatialCellImageCandidate.

Definition at line 105 of file PsfCandidate.h.

◆ getMaskBlends()

template<typename PixelT >
bool lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskBlends ( )
static

Get whether blends are masked.

Definition at line 323 of file PsfCandidate.cc.

◆ getMaskedImage() [1/2]

template<typename PixelT >
std::shared_ptr< afw::image::MaskedImage< PixelT > const > lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskedImage ( ) const

Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

Definition at line 291 of file PsfCandidate.cc.

◆ getMaskedImage() [2/2]

template<typename PixelT >
std::shared_ptr< afw::image::MaskedImage< PixelT > const > lsst::meas::algorithms::PsfCandidate< PixelT >::getMaskedImage ( int width,
int height ) const

Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the object in the centre of a pixel (for that, use getOffsetImage())

Definition at line 277 of file PsfCandidate.cc.

◆ getOffsetImage()

template<typename PixelT >
std::shared_ptr< afw::image::MaskedImage< PixelT > > lsst::meas::algorithms::PsfCandidate< PixelT >::getOffsetImage ( std::string const algorithm,
unsigned int buffer ) const

Return an offset version of the image of the source.

The returned image has been offset to put the centre of the object in the centre of a pixel.

Definition at line 334 of file PsfCandidate.cc.

◆ getPixelThreshold()

template<typename PixelT >
float lsst::meas::algorithms::PsfCandidate< PixelT >::getPixelThreshold ( )
static

Get threshold for rejecting pixels unconnected with the central footprint.

Definition at line 313 of file PsfCandidate.cc.

◆ getSource()

template<typename PixelT >
std::shared_ptr< afw::table::SourceRecord > lsst::meas::algorithms::PsfCandidate< PixelT >::getSource ( ) const
inline

Return the original Source.

Definition at line 108 of file PsfCandidate.h.

◆ getVar()

template<typename PixelT >
double lsst::meas::algorithms::PsfCandidate< PixelT >::getVar ( ) const
inline

Return the variance in use when fitting this object.

Definition at line 117 of file PsfCandidate.h.

◆ setAmplitude()

template<typename PixelT >
void lsst::meas::algorithms::PsfCandidate< PixelT >::setAmplitude ( double amplitude)
inline

Set the best-fit amplitude.

Definition at line 114 of file PsfCandidate.h.

◆ setBorderWidth()

template<typename PixelT >
void lsst::meas::algorithms::PsfCandidate< PixelT >::setBorderWidth ( int border)
static

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

Definition at line 303 of file PsfCandidate.cc.

◆ setMaskBlends()

template<typename PixelT >
void lsst::meas::algorithms::PsfCandidate< PixelT >::setMaskBlends ( bool doMaskBlends)
static

Set whether blends are masked.

Definition at line 318 of file PsfCandidate.cc.

◆ setPixelThreshold()

template<typename PixelT >
void lsst::meas::algorithms::PsfCandidate< PixelT >::setPixelThreshold ( float threshold)
static

Set threshold for rejecting pixels unconnected with the central footprint.

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

Definition at line 308 of file PsfCandidate.cc.

◆ setVar()

template<typename PixelT >
void lsst::meas::algorithms::PsfCandidate< PixelT >::setVar ( double var)
inline

Set the variance to use when fitting this object.

Definition at line 120 of file PsfCandidate.h.


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