lsst.meas.base gf28afc6cbd+dab77e5b88
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst::meas::base::CircularApertureFluxAlgorithm Class Reference

#include <CircularApertureFlux.h>

Inheritance diagram for lsst::meas::base::CircularApertureFluxAlgorithm:
lsst::meas::base::ApertureFluxAlgorithm lsst::meas::base::SimpleAlgorithm lsst::meas::base::SingleFrameAlgorithm lsst::meas::base::ForcedAlgorithm lsst::meas::base::BaseAlgorithm lsst::meas::base::BaseAlgorithm

Public Types

typedef ApertureFluxControl Control
 
typedef ApertureFluxResult Result
 Result object returned by static methods. More...
 

Public Member Functions

 CircularApertureFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema, daf::base::PropertySet &metadata)
 
virtual void measure (afw::table::SourceRecord &record, afw::image::Exposure< float > const &exposure) const
 Measure the configured apertures on the given 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...
 
virtual void measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::geom::SkyWcs 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::geom::SkyWcs const &refWcs) const
 Called to simultaneously measure all children in a deblend family, in a single 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...
 
std::string getLogName () const
 

Static Public Member Functions

static FlagDefinitionList const & getFlagDefinitions ()
 
template<typename T >
static Result computeSincFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry. More...
 
template<typename T >
static Result computeSincFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 
template<typename T >
static Result computeNaiveFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the instFlux (and optionally, uncertanties) within an aperture using naive photometry. More...
 
template<typename T >
static Result computeNaiveFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 
template<typename T >
static Result computeFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the instFlux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter. More...
 
template<typename T >
static Result computeFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 
static std::string makeFieldPrefix (std::string const &name, double radius)
 Construct an appropriate prefix for table fields. More...
 

Static Public Attributes

static unsigned int const N_FLAGS = 3
 
static FlagDefinition const FAILURE = flagDefinitions.addFailureFlag()
 
static FlagDefinition const APERTURE_TRUNCATED
 
static FlagDefinition const SINC_COEFFS_TRUNCATED
 

Protected Member Functions

void copyResultToRecord (Result const &result, afw::table::SourceRecord &record, int index) const
 
FlagHandler const & getFlagHandler (int index) const
 

Protected Attributes

Control const _ctrl
 
SafeCentroidExtractor _centroidExtractor
 
std::string _logName
 

Detailed Description

Definition at line 40 of file CircularApertureFlux.h.

Member Typedef Documentation

◆ Control

Definition at line 89 of file ApertureFlux.h.

◆ Result

Result object returned by static methods.

Definition at line 92 of file ApertureFlux.h.

Constructor & Destructor Documentation

◆ CircularApertureFluxAlgorithm()

lsst::meas::base::CircularApertureFluxAlgorithm::CircularApertureFluxAlgorithm ( Control const &  ctrl,
std::string const &  name,
afw::table::Schema schema,
daf::base::PropertySet metadata 
)

Definition at line 33 of file CircularApertureFlux.cc.

Member Function Documentation

◆ computeFlux() [1/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeFlux ( afw::image::Image< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Compute the instFlux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter.

This method delegates to computeSincFlux is the minor axis of the aperture is smaller than ctrl.maxSincRadius, and delegates to computeNaiveFlux otherwise.

Parameters
[in]imageImage or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as instFluxes.
[in]ellipseEllipse that defines the outer boundary of the aperture.
[in]ctrlControl object.

Definition at line 223 of file ApertureFlux.cc.

◆ computeFlux() [2/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeFlux ( afw::image::MaskedImage< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Definition at line 232 of file ApertureFlux.cc.

◆ computeNaiveFlux() [1/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeNaiveFlux ( afw::image::Image< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Compute the instFlux (and optionally, uncertanties) within an aperture using naive photometry.

The naive algorithm just counts the instFlux in pixels whose centers lie within the aperture, ignoring the effects of sub-pixel aperture boundaries.

Parameters
[in]imageImage or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as instFluxes.
[in]ellipseEllipse that defines the outer boundary of the aperture.

Definition at line 176 of file ApertureFlux.cc.

◆ computeNaiveFlux() [2/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeNaiveFlux ( afw::image::MaskedImage< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Definition at line 196 of file ApertureFlux.cc.

◆ computeSincFlux() [1/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeSincFlux ( afw::image::Image< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry.

The Sinc algorithm is slower than a naive aperture, but more accurate, in that it correctly handles sub-pixel aperture boundaries on well-sampled data. This improved accuracy is most important for smaller apertures.

Parameters
[in]imageImage or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as instFluxes.
[in]ellipseEllipse that defines the outer boundary of the aperture.
[in]ctrlControl object.

Definition at line 146 of file ApertureFlux.cc.

◆ computeSincFlux() [2/2]

template<typename T >
ApertureFluxAlgorithm::Result lsst::meas::base::ApertureFluxAlgorithm::computeSincFlux ( afw::image::MaskedImage< T > const &  image,
afw::geom::ellipses::Ellipse const &  ellipse,
Control const &  ctrl = Control() 
)
staticinherited

Definition at line 158 of file ApertureFlux.cc.

◆ copyResultToRecord()

void lsst::meas::base::ApertureFluxAlgorithm::copyResultToRecord ( Result const &  result,
afw::table::SourceRecord record,
int  index 
) const
protectedinherited

Definition at line 96 of file ApertureFlux.cc.

◆ fail()

void lsst::meas::base::ApertureFluxAlgorithm::fail ( afw::table::SourceRecord measRecord,
MeasurementError error = nullptr 
) const
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.

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

Definition at line 87 of file ApertureFlux.cc.

◆ getFlagDefinitions()

FlagDefinitionList const & lsst::meas::base::ApertureFluxAlgorithm::getFlagDefinitions ( )
staticinherited

Definition at line 49 of file ApertureFlux.cc.

◆ getFlagHandler()

FlagHandler const & lsst::meas::base::ApertureFluxAlgorithm::getFlagHandler ( int  index) const
inlineprotectedinherited

Definition at line 196 of file ApertureFlux.h.

◆ getLogName()

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

Definition at line 66 of file Algorithm.h.

◆ makeFieldPrefix()

std::string lsst::meas::base::ApertureFluxAlgorithm::makeFieldPrefix ( std::string const &  name,
double  radius 
)
staticinherited

Construct an appropriate prefix for table fields.

Given a plugin name (e.g. base_CircularApertureFlux) and an aperture radius (e.g. 12 pixels) return an appropriate prefix for table fields to contain the measurement results (e.g. base_CircularApertureFlux_12_0). Table fields can then be created named <prefix>_instFlux, <prefix>_instFluxErr, etc.

Parameters
[in]pluginNameName of measurement plugin.
[in]radiusAperture radius (pixels).
Returns
Table field name prefix.

Definition at line 57 of file ApertureFlux.cc.

◆ measure()

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

Measure the configured apertures 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::ApertureFluxAlgorithm.

Definition at line 43 of file CircularApertureFlux.cc.

◆ measureForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureForced ( afw::table::SourceRecord measRecord,
afw::image::Exposure< float > const &  exposure,
afw::table::SourceRecord const &  refRecord,
afw::geom::SkyWcs const &  refWcs 
) const
inlinevirtualinherited

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.

Implements lsst::meas::base::ForcedAlgorithm.

Definition at line 172 of file Algorithm.h.

◆ measureN()

void lsst::meas::base::SingleFrameAlgorithm::measureN ( afw::table::SourceCatalog const &  measCat,
afw::image::Exposure< float > const &  exposure 
) const
virtualinherited

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.

◆ measureNForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureNForced ( afw::table::SourceCatalog const &  measCat,
afw::image::Exposure< float > const &  exposure,
afw::table::SourceCatalog const &  refRecord,
afw::geom::SkyWcs const &  refWcs 
) const
inlinevirtualinherited

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.

Reimplemented from lsst::meas::base::ForcedAlgorithm.

Definition at line 179 of file Algorithm.h.

Member Data Documentation

◆ _centroidExtractor

SafeCentroidExtractor lsst::meas::base::ApertureFluxAlgorithm::_centroidExtractor
protectedinherited

Definition at line 199 of file ApertureFlux.h.

◆ _ctrl

Control const lsst::meas::base::ApertureFluxAlgorithm::_ctrl
protectedinherited

Definition at line 198 of file ApertureFlux.h.

◆ _logName

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

Definition at line 69 of file Algorithm.h.

◆ APERTURE_TRUNCATED

FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::APERTURE_TRUNCATED
staticinherited
Initial value:
=
flagDefinitions.add("flag_apertureTruncated", "aperture did not fit within measurement image")

Definition at line 86 of file ApertureFlux.h.

◆ FAILURE

FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::FAILURE = flagDefinitions.addFailureFlag()
staticinherited

Definition at line 85 of file ApertureFlux.h.

◆ N_FLAGS

unsigned int const lsst::meas::base::ApertureFluxAlgorithm::N_FLAGS = 3
staticinherited

Definition at line 84 of file ApertureFlux.h.

◆ SINC_COEFFS_TRUNCATED

FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::SINC_COEFFS_TRUNCATED
staticinherited
Initial value:
= flagDefinitions.add(
"flag_sincCoeffsTruncated", "full sinc coefficient image did not fit within measurement image")

Definition at line 87 of file ApertureFlux.h.


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