lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | 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 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...
 
- Public Member Functions inherited from lsst::meas::base::ApertureFluxAlgorithm
 ApertureFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema, daf::base::PropertySet &metadata)
 Construct the algorithm and add its fields to the given Schema. More...
 
virtual ~ApertureFluxAlgorithm ()
 
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
 

Additional Inherited Members

- Public Types inherited from lsst::meas::base::ApertureFluxAlgorithm
typedef ApertureFluxControl Control
 
typedef ApertureFluxResult Result
 Result object returned by static methods. More...
 
- Static Public Member Functions inherited from lsst::meas::base::ApertureFluxAlgorithm
static FlagDefinitionList const & getFlagDefinitions ()
 
static std::string makeFieldPrefix (std::string const &name, double radius)
 Construct an appropriate prefix for table fields. More...
 
template<typename T >
static Result computeSincFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the flux (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())
 Compute the flux (and optionally, uncertanties) within an aperture using Sinc photometry. More...
 
template<typename T >
static Result computeNaiveFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the flux (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())
 Compute the flux (and optionally, uncertanties) within an aperture using naive photometry. More...
 
template<typename T >
static Result computeFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
 Compute the flux (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())
 Compute the flux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter. More...
 
- Static Public Attributes inherited from lsst::meas::base::ApertureFluxAlgorithm
static unsigned int const N_FLAGS = 3
 
static FlagDefinition const FAILURE = flagDefinitions.addFailureFlag()
 
static FlagDefinition const APERTURE_TRUNCATED = flagDefinitions.add("flag_apertureTruncated", "aperture did not fit within measurement image")
 
static FlagDefinition const SINC_COEFFS_TRUNCATED = flagDefinitions.add("flag_sincCoeffsTruncated", "full sinc coefficient image did not fit within measurement image")
 
- Protected Member Functions inherited from lsst::meas::base::ApertureFluxAlgorithm
void copyResultToRecord (Result const &result, afw::table::SourceRecord &record, int index) const
 Return the flag definitions which apply to aperture flux measurements. More...
 
FlagHandler const & getFlagHandler (int index) const
 
- Protected Attributes inherited from lsst::meas::base::ApertureFluxAlgorithm
Control const _ctrl
 
SafeCentroidExtractor _centroidExtractor
 
- Protected Attributes inherited from lsst::meas::base::BaseAlgorithm
std::string _logName
 

Detailed Description

Definition at line 38 of file CircularApertureFlux.h.

Constructor & Destructor Documentation

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

Definition at line 31 of file CircularApertureFlux.cc.

Member Function Documentation

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 44 of file CircularApertureFlux.cc.


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