lsst.meas.base
13.0-33-gb1a1d47+2
|
A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which bits are set within a source's footprint. More...
#include <PixelFlags.h>
Public Types | |
typedef PixelFlagsControl | Control |
A typedef to the Control object for this algorithm, defined above. More... | |
typedef std::map< std::string, afw::table::Key< afw::table::Flag > > | KeyMap |
Public Member Functions | |
PixelFlagsAlgorithm (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 |
Protected Attributes | |
std::string | _logName |
A measurement algorithm that gets mask bits from the exposure and sets flag bits to summarize which bits are set within a source's footprint.
Definition at line 63 of file PixelFlags.h.
A typedef to the Control object for this algorithm, defined above.
The control object contains the configuration parameters for this algorithm.
Definition at line 67 of file PixelFlags.h.
typedef std::map<std::string, afw::table::Key<afw::table::Flag> > lsst::meas::base::PixelFlagsAlgorithm::KeyMap |
Definition at line 81 of file PixelFlags.h.
lsst::meas::base::PixelFlagsAlgorithm::PixelFlagsAlgorithm | ( | Control const & | ctrl, |
std::string const & | name, | ||
afw::table::Schema & | schema | ||
) |
Definition at line 76 of file PixelFlags.cc.
|
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 200 of file PixelFlags.cc.
|
inlineinherited |
Definition at line 67 of file Algorithm.h.
|
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 125 of file PixelFlags.cc.
|
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.
|
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.
|
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.
|
protectedinherited |
Definition at line 71 of file Algorithm.h.