lsst.meas.base  13.0-26-g0f127ff+5
Public Member Functions | List of all members
lsst::meas::base::SingleFrameAlgorithm Class Referenceabstract

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

#include <Algorithm.h>

Inheritance diagram for lsst::meas::base::SingleFrameAlgorithm:
lsst::meas::base::BaseAlgorithm lsst::meas::base::SimpleAlgorithm lsst::meas::base::ApertureFluxAlgorithm lsst::meas::base::BlendednessAlgorithm lsst::meas::base::GaussianCentroidAlgorithm lsst::meas::base::GaussianFluxAlgorithm lsst::meas::base::NaiveCentroidAlgorithm lsst::meas::base::PeakLikelihoodFluxAlgorithm lsst::meas::base::PixelFlagsAlgorithm lsst::meas::base::PsfFluxAlgorithm lsst::meas::base::ScaledApertureFluxAlgorithm lsst::meas::base::SdssCentroidAlgorithm lsst::meas::base::SdssShapeAlgorithm

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

Additional Inherited Members

- Protected Attributes inherited from lsst::meas::base::BaseAlgorithm
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 84 of file Algorithm.h.

Member Function Documentation

◆ measure()

virtual void lsst::meas::base::SingleFrameAlgorithm::measure ( afw::table::SourceRecord &  measRecord,
afw::image::Exposure< float > const &  exposure 
) const
pure virtual

◆ 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 29 of file Algorithm.cc.


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