lsst.meas.base  13.0-33-gb1a1d47+13
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
lsst::meas::base::GaussianCentroidAlgorithm Class Reference

A class that calculates a centroid by fitting a circular Gaussian to the image. More...

#include <GaussianCentroid.h>

Inheritance diagram for lsst::meas::base::GaussianCentroidAlgorithm:
lsst::meas::base::SimpleAlgorithm lsst::meas::base::SingleFrameAlgorithm lsst::meas::base::ForcedAlgorithm lsst::meas::base::BaseAlgorithm lsst::meas::base::BaseAlgorithm

Public Types

typedef GaussianCentroidControl Control
 A typedef to the Control object for this algorithm, defined above. More...
 

Public Member Functions

 GaussianCentroidAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema)
 
virtual void measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
 Called to measure a single child source in an image. More...
 
virtual void fail (afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
 Handle an exception thrown by the current algorithm by setting flags in the given record. More...
 
virtual void measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const
 Called to measure a single child source in an image. More...
 
virtual void measureNForced (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::image::Wcs const &refWcs) const
 Called to simultaneously measure all children in a deblend family, in a single image. More...
 
virtual void measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const
 Called to simultaneously measure all children in a deblend family, in a single image. More...
 
std::string getLogName () const
 

Static Public Member Functions

static FlagDefinitionList const & getFlagDefinitions ()
 
template<typename PixelT >
static afw::geom::Point2D fitCentroid (afw::image::Image< PixelT > const &im, double x0, double y0)
 Compute centroids with 2-D Gaussian fitter. More...
 

Static Public Attributes

static FlagDefinition const FAILURE = flagDefinitions.addFailureFlag()
 
static FlagDefinition const NO_PEAK = flagDefinitions.add("flag_noPeak", "Fitted Centroid has a negative peak")
 

Protected Attributes

std::string _logName
 

Detailed Description

A class that calculates a centroid by fitting a circular Gaussian to the image.

Definition at line 86 of file GaussianCentroid.h.

Member Typedef Documentation

◆ Control

A typedef to the Control object for this algorithm, defined above.

The control object contains the configuration parameters for this algorithm.

Definition at line 96 of file GaussianCentroid.h.

Constructor & Destructor Documentation

◆ GaussianCentroidAlgorithm()

lsst::meas::base::GaussianCentroidAlgorithm::GaussianCentroidAlgorithm ( Control const &  ctrl,
std::string const &  name,
afw::table::Schema schema 
)

Definition at line 513 of file GaussianCentroid.cc.

Member Function Documentation

◆ fail()

void lsst::meas::base::GaussianCentroidAlgorithm::fail ( afw::table::SourceRecord measRecord,
MeasurementError error = nullptr 
) const
virtual

Handle an exception thrown by the current algorithm by setting flags in the given record.

fail() is called by the measurement framework when an exception is allowed to propagate out of one the algorithm's measure() methods. It should generally set both a general failure flag for the algorithm as well as a specific flag indicating the error condition, if possible. To aid in this, if the exception was an instance of MeasurementError, it will be passed in, carrying information about what flag to set.

An algorithm can also to chose to set flags within its own measure() methods, and then just return, rather than throw an exception. However, fail() should be implemented even when all known failure modes do not throw exceptions, to ensure that unexpected exceptions thrown in lower-level code are properly handled.

Implements lsst::meas::base::BaseAlgorithm.

Definition at line 576 of file GaussianCentroid.cc.

◆ fitCentroid()

template<typename PixelT >
template afw::geom::Point2D lsst::meas::base::GaussianCentroidAlgorithm::fitCentroid ( afw::image::Image< PixelT > const &  im,
double  x0,
double  y0 
)
static

Compute centroids with 2-D Gaussian fitter.

x0, y0 is an initial guess for position, column

Definition at line 530 of file GaussianCentroid.cc.

◆ getFlagDefinitions()

FlagDefinitionList const & lsst::meas::base::GaussianCentroidAlgorithm::getFlagDefinitions ( )
static

Definition at line 40 of file GaussianCentroid.cc.

◆ getLogName()

std::string lsst::meas::base::BaseAlgorithm::getLogName ( ) const
inlineinherited

Definition at line 67 of file Algorithm.h.

◆ measure()

void lsst::meas::base::GaussianCentroidAlgorithm::measure ( afw::table::SourceRecord measRecord,
afw::image::Exposure< float > const &  exposure 
) const
virtual

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::SingleFrameAlgorithm.

Definition at line 541 of file GaussianCentroid.cc.

◆ measureForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureForced ( afw::table::SourceRecord measRecord,
afw::image::Exposure< float > const &  exposure,
afw::table::SourceRecord const &  refRecord,
afw::image::Wcs const &  refWcs 
) const
inlinevirtualinherited

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::ForcedAlgorithm.

Definition at line 187 of file Algorithm.h.

◆ measureN()

void lsst::meas::base::SingleFrameAlgorithm::measureN ( afw::table::SourceCatalog const &  measCat,
afw::image::Exposure< float > const &  exposure 
) const
virtualinherited

Called to simultaneously measure all children in a deblend family, in a single image.

Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.

Definition at line 29 of file Algorithm.cc.

◆ measureNForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureNForced ( afw::table::SourceCatalog const &  measCat,
afw::image::Exposure< float > const &  exposure,
afw::table::SourceCatalog const &  refRecord,
afw::image::Wcs const &  refWcs 
) const
inlinevirtualinherited

Called to simultaneously measure all children in a deblend family, in a single image.

Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.

Reimplemented from lsst::meas::base::ForcedAlgorithm.

Definition at line 196 of file Algorithm.h.

Member Data Documentation

◆ _logName

std::string lsst::meas::base::BaseAlgorithm::_logName
protectedinherited

Definition at line 71 of file Algorithm.h.

◆ FAILURE

FlagDefinition const lsst::meas::base::GaussianCentroidAlgorithm::FAILURE = flagDefinitions.addFailureFlag()
static

Definition at line 91 of file GaussianCentroid.h.

◆ NO_PEAK

FlagDefinition const lsst::meas::base::GaussianCentroidAlgorithm::NO_PEAK = flagDefinitions.add("flag_noPeak", "Fitted Centroid has a negative peak")
static

Definition at line 92 of file GaussianCentroid.h.


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