lsst::meas::base::ForcedAlgorithm Class Reference

#include <Algorithm.h>

Inheritance diagram for lsst::meas::base::ForcedAlgorithm:

Public Member Functions
virtual void	measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const =0
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
Public Member Functions inherited from lsst::meas::base::BaseAlgorithm
virtual void	fail (afw::table::SourceRecord &measRecord, MeasurementError *error=NULL) const =0
virtual	~BaseAlgorithm ()

Detailed Description

Base class for algorithms that measure the properties of sources on one image, using previous measurements on another image to hold certain quantities fixed.

ForcedAlgorithm can be used when measuring both on single exposures and coadds, and is typically used to measure colors by holding centroids, apertures, or other model parameters fixed while allowing amplitudes to vary.

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

Most algorithms will not need to make use of the reference record or WCS, as transformed centroids and shapes should generally be available via the slots in measRecord, but these are made available for algorithms that need to transform more complex information. If that is the case, the algorithm may want to inherit from SimpleAlgorithm instead of inheriting from ForcedAlgorithm directly.

Definition at line 128 of file Algorithm.h.

Member Function Documentation

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

pure 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.

Implemented in lsst::meas::base::SimpleAlgorithm.

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

virtual

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 in lsst::meas::base::SimpleAlgorithm.

Definition at line 39 of file Algorithm.cc.

        {
    throw LSST_EXCEPT(
        pex::exceptions::LogicError,
        "measureN not implemented for this algorithm"
    );
}

---

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

• /home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/Algorithm.h
• /home/lsstsw/stack/Linux64/meas_base/11.0+1/src/Algorithm.cc