lsst::meas::base::SingleFrameAlgorithm Class Reference

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

#include <Algorithm.h>

Inheritance diagram for lsst::meas::base::SingleFrameAlgorithm:

Public Member 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.
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.
virtual void	fail (afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const =0
	Handle an exception thrown by the current algorithm by setting flags in the given record.
std::string	getLogName () const

Protected Attributes
std::string	_logName

Detailed Description

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.

Definition at line 82 of file Algorithm.h.

Member Function Documentation

fail()

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

pure virtualinherited

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.

Implemented in lsst::meas::extensions::simpleShape::SimpleShape, lsst::meas::modelfit::DoubleShapeletPsfApproxAlgorithm, lsst::ip::diffim::NaiveDipoleFlux, lsst::ip::diffim::NaiveDipoleCentroid, lsst::ip::diffim::PsfDipoleFlux, lsst::meas::extensions::photometryKron::KronFluxAlgorithm, lsst::meas::base::ApertureFluxAlgorithm, lsst::meas::base::BlendednessAlgorithm, lsst::meas::base::GaussianFluxAlgorithm, lsst::meas::base::LocalBackgroundAlgorithm, lsst::meas::base::NaiveCentroidAlgorithm, lsst::meas::base::PeakLikelihoodFluxAlgorithm, lsst::meas::base::PixelFlagsAlgorithm, lsst::meas::base::PsfFluxAlgorithm, lsst::meas::base::SdssCentroidAlgorithm, lsst::meas::base::SdssShapeAlgorithm, and lsst::meas::base::ScaledApertureFluxAlgorithm.

getLogName()

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

inlineinherited

Definition at line 66 of file Algorithm.h.

{ return _logName; }

measure()

virtual void lsst::meas::base::SingleFrameAlgorithm::measure ( afw::table::SourceRecord & measRecord, afw::image::Exposure< float > const & exposure ) 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::ip::diffim::NaiveDipoleFlux, lsst::ip::diffim::NaiveDipoleCentroid, lsst::ip::diffim::PsfDipoleFlux, lsst::meas::base::BlendednessAlgorithm, lsst::meas::base::GaussianFluxAlgorithm, lsst::meas::base::LocalBackgroundAlgorithm, lsst::meas::base::NaiveCentroidAlgorithm, lsst::meas::base::PeakLikelihoodFluxAlgorithm, lsst::meas::base::PixelFlagsAlgorithm, lsst::meas::base::PsfFluxAlgorithm, lsst::meas::base::SdssCentroidAlgorithm, lsst::meas::base::SdssShapeAlgorithm, lsst::meas::extensions::photometryKron::KronFluxAlgorithm, lsst::meas::extensions::simpleShape::SimpleShape, lsst::meas::modelfit::DoubleShapeletPsfApproxAlgorithm, lsst::meas::base::ScaledApertureFluxAlgorithm, lsst::meas::base::CircularApertureFluxAlgorithm, and lsst::meas::base::ApertureFluxAlgorithm.

measureN()

void lsst::meas::base::SingleFrameAlgorithm::measureN ( afw::table::SourceCatalog const & measCat, afw::image::Exposure< float > const & exposure ) 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.

Definition at line 31 of file Algorithm.cc.

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

Member Data Documentation

_logName

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

protectedinherited

Definition at line 69 of file Algorithm.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g6c1bc301e9+51106c2951/include/lsst/meas/base/Algorithm.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g6c1bc301e9+51106c2951/src/Algorithm.cc