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

#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
virtual void	measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) 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 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 77 of file Algorithm.h.

Member Function Documentation

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::PsfDipoleFlux, lsst::ip::diffim::NaiveDipoleCentroid, lsst::ip::diffim::NaiveDipoleFlux, lsst::meas::base::ApertureFluxAlgorithm, lsst::meas::base::SdssShapeAlgorithm, lsst::meas::base::GaussianCentroidAlgorithm, lsst::meas::base::PixelFlagsAlgorithm, lsst::meas::base::PeakLikelihoodFluxAlgorithm, lsst::meas::base::PsfFluxAlgorithm, lsst::meas::base::SdssCentroidAlgorithm, lsst::meas::base::NaiveCentroidAlgorithm, lsst::meas::base::GaussianFluxAlgorithm, and lsst::meas::base::CircularApertureFluxAlgorithm.

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.

        {
    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