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

Measure the flux in an aperture scaled to the PSF. More...

#include <ScaledApertureFlux.h>

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

Public Types

typedef ScaledApertureFluxControl Control
 
typedef ApertureFluxResult Result
 

Public Member Functions

 ScaledApertureFluxAlgorithm (Control const &control, std::string const &name, afw::table::Schema &schema)
 
virtual void measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const override
 Measure the scaled aperture flux on the given image. More...
 
virtual void fail (afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const override
 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
 

Additional Inherited Members

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

Detailed Description

Measure the flux in an aperture scaled to the PSF.

This algorithm performs a sinc aperture flux measurement where they size of the aperture is determined by multiplying the FWHM of the PSF by the scaling factor specified in the algorithm configuration.

Definition at line 62 of file ScaledApertureFlux.h.

Member Typedef Documentation

Definition at line 65 of file ScaledApertureFlux.h.

Definition at line 66 of file ScaledApertureFlux.h.

Constructor & Destructor Documentation

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

Definition at line 32 of file ScaledApertureFlux.cc.

Member Function Documentation

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

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 74 of file ScaledApertureFlux.cc.

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

Measure the scaled aperture flux on the given image.

Python plugins will delegate to this method.

Parameters
[in,out]recordRecord used to save outputs and retrieve positions.
[in]exposureImage to be measured.

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

Definition at line 46 of file ScaledApertureFlux.cc.


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