lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
lsst::meas::base::PeakLikelihoodFluxAlgorithm Class Reference

A measurement algorithm that estimates the peak flux, using a filtered image which has been convolved with its own PSF. More...

#include <PeakLikelihoodFlux.h>

Inheritance diagram for lsst::meas::base::PeakLikelihoodFluxAlgorithm:
lsst::meas::base::SimpleAlgorithm lsst::meas::base::SingleFrameAlgorithm lsst::meas::base::ForcedAlgorithm lsst::meas::base::BaseAlgorithm lsst::meas::base::BaseAlgorithm

Public Types

typedef PeakLikelihoodFluxControl Control
 A typedef to the Control object for this algorithm, defined above. More...
 

Public Member Functions

 PeakLikelihoodFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema)
 
virtual void measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
 Called to measure a single child source in an image. More...
 
virtual void fail (afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
 Handle an exception thrown by the current algorithm by setting flags in the given record. More...
 
- Public Member Functions inherited from lsst::meas::base::SimpleAlgorithm
virtual void measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const
 Called to measure a single child source in an image. More...
 
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
 Called to simultaneously measure all children in a deblend family, in a single image. More...
 
- Public Member Functions inherited from lsst::meas::base::SingleFrameAlgorithm
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 ~BaseAlgorithm ()
 
std::string getLogName () const
 

Static Public Member Functions

static FlagDefinitionList const & getFlagDefinitions ()
 

Static Public Attributes

static FlagDefinition const FAILURE = flagDefinitions.addFailureFlag()
 

Additional Inherited Members

- Protected Attributes inherited from lsst::meas::base::BaseAlgorithm
std::string _logName
 

Detailed Description

A measurement algorithm that estimates the peak flux, using a filtered image which has been convolved with its own PSF.

Definition at line 71 of file PeakLikelihoodFlux.h.

Member Typedef Documentation

A typedef to the Control object for this algorithm, defined above.

The control object contains the configuration parameters for this algorithm.

Definition at line 80 of file PeakLikelihoodFlux.h.

Constructor & Destructor Documentation

lsst::meas::base::PeakLikelihoodFluxAlgorithm::PeakLikelihoodFluxAlgorithm ( Control const &  ctrl,
std::string const &  name,
afw::table::Schema &  schema 
)

Definition at line 185 of file PeakLikelihoodFlux.cc.

Member Function Documentation

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

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.

Implements lsst::meas::base::BaseAlgorithm.

Definition at line 262 of file PeakLikelihoodFlux.cc.

FlagDefinitionList const & lsst::meas::base::PeakLikelihoodFluxAlgorithm::getFlagDefinitions ( )
static

Definition at line 43 of file PeakLikelihoodFlux.cc.

void lsst::meas::base::PeakLikelihoodFluxAlgorithm::measure ( afw::table::SourceRecord &  measRecord,
afw::image::Exposure< float > const &  exposure 
) const
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.

Given an image and a pixel position, return a Flux

Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the exposure has no PSF.
lsst::pex::exceptions::RangeErrorif the warping (centering) kernel is not fully contained within the exposure.
lsst::pex::exceptions::RangeErrorif the center not within exposure. (This avoids insane center values from confusing the test for warping kernel within exposure).

Implements lsst::meas::base::SingleFrameAlgorithm.

Definition at line 198 of file PeakLikelihoodFlux.cc.

Member Data Documentation

FlagDefinition const lsst::meas::base::PeakLikelihoodFluxAlgorithm::FAILURE = flagDefinitions.addFailureFlag()
static

Definition at line 76 of file PeakLikelihoodFlux.h.


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