Class SingleFrameAlgorithm

Inheritance Relationships

Base Type

Derived Type

Class Documentation

class SingleFrameAlgorithm : public virtual lsst::meas::base::BaseAlgorithm

Base class for algorithms that measure the properties of sources on single image.

SingleFrameAlgorithm defines the interface used in measuring both on single exposure images and on coadds.

In addition to the virtual methods defined here, SingleFrameAlgorithm also puts requirements on constructor signatures; see the wrapSingleFrameAlgorithm Python function for more information.

Subclassed by lsst::meas::base::SimpleAlgorithm

Public Functions

virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure<float> const &exposure) const = 0

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.

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.

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.