lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
lsst::meas::base::NaiveCentroidAlgorithm Class Reference

A class that calculates a centroid as a simple unweighted first moment of the 3x3 region around a pixel. More...

#include <NaiveCentroid.h>

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

Public Types

typedef NaiveCentroidControl Control
 

Public Member Functions

 NaiveCentroidAlgorithm (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...
 
- Public Member Functions inherited from lsst::meas::base::SimpleAlgorithm
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...
 
- Public Member Functions inherited from lsst::meas::base::SingleFrameAlgorithm
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...
 
- Public Member Functions inherited from lsst::meas::base::BaseAlgorithm
virtual ~BaseAlgorithm ()
 
std::string getLogName () const
 

Static Public Member Functions

static FlagDefinitionList const & getFlagDefinitions ()
 

Static Public Attributes

static FlagDefinition const FAILURE = flagDefinitions.addFailureFlag()
 
static FlagDefinition const NO_COUNTS = flagDefinitions.add("flag_noCounts", "Object to be centroided has no counts")
 
static FlagDefinition const EDGE = flagDefinitions.add("flag_edge", "Object too close to edge")
 

Additional Inherited Members

- Protected Attributes inherited from lsst::meas::base::BaseAlgorithm
std::string _logName
 

Detailed Description

A class that calculates a centroid as a simple unweighted first moment of the 3x3 region around a pixel.

A fixed background (set via config) may optionally be subtracted. This algorithm does not currently report an error, but it probably should.

Definition at line 66 of file NaiveCentroid.h.

Member Typedef Documentation

Definition at line 75 of file NaiveCentroid.h.

Constructor & Destructor Documentation

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

Definition at line 41 of file NaiveCentroid.cc.

Member Function Documentation

void lsst::meas::base::NaiveCentroidAlgorithm::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 116 of file NaiveCentroid.cc.

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

Definition at line 37 of file NaiveCentroid.cc.

void lsst::meas::base::NaiveCentroidAlgorithm::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 56 of file NaiveCentroid.cc.

Member Data Documentation

FlagDefinition const lsst::meas::base::NaiveCentroidAlgorithm::EDGE = flagDefinitions.add("flag_edge", "Object too close to edge")
static

Definition at line 73 of file NaiveCentroid.h.

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

Definition at line 71 of file NaiveCentroid.h.

FlagDefinition const lsst::meas::base::NaiveCentroidAlgorithm::NO_COUNTS = flagDefinitions.add("flag_noCounts", "Object to be centroided has no counts")
static

Definition at line 72 of file NaiveCentroid.h.


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