lsst::meas::base::CircularApertureFluxAlgorithm Class Reference

#include <CircularApertureFlux.h>

Inheritance diagram for lsst::meas::base::CircularApertureFluxAlgorithm:

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
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)
virtual	~ApertureFluxAlgorithm ()
virtual void	fail (afw::table::SourceRecord &measRecord, MeasurementError *error=NULL) const
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
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
Public Member Functions inherited from lsst::meas::base::SingleFrameAlgorithm
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	~BaseAlgorithm ()

Additional Inherited Members
Public Types inherited from lsst::meas::base::ApertureFluxAlgorithm
enum	FlagBits { FAILURE =0, APERTURE_TRUNCATED, SINC_COEFFS_TRUNCATED, N_FLAGS }
typedef ApertureFluxControl	Control
	Typedef to the control object associated with this algorithm, defined above. More...
typedef ApertureFluxResult	Result
	Result object returned by static methods. More...
Static Public Member Functions inherited from lsst::meas::base::ApertureFluxAlgorithm
static std::string	makeFieldPrefix (std::string const &name, double radius)
template<typename T >
static Result	computeSincFlux (afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
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())
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())
template<typename T >
static Result	computeFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Protected Member Functions inherited from lsst::meas::base::ApertureFluxAlgorithm
void	copyResultToRecord (Result const &result, afw::table::SourceRecord &record, int index) const
FlagHandler const &	getFlagHandler (int index) const
Protected Attributes inherited from lsst::meas::base::ApertureFluxAlgorithm
Control const	_ctrl
SafeCentroidExtractor	_centroidExtractor

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.

  : ApertureFluxAlgorithm(ctrl, name, schema, metadata)
{
    for (std::size_t i = 0; i < ctrl.radii.size(); ++i) {
        if (ctrl.radii[i] > ctrl.maxSincRadius) break;
        SincCoeffs<float>::cache(0.0, ctrl.radii[i]);
    }
}

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]	record	Record used to save outputs and retrieve positions.
[in]	exposure	Image to be measured.

Implements lsst::meas::base::ApertureFluxAlgorithm.

Definition at line 44 of file CircularApertureFlux.cc.

        {
    afw::geom::ellipses::Ellipse ellipse(afw::geom::ellipses::Axes(1.0, 1.0, 0.0));
    PTR(afw::geom::ellipses::Axes) axes
        = boost::static_pointer_cast<afw::geom::ellipses::Axes>(ellipse.getCorePtr());
    for (std::size_t i = 0; i < _ctrl.radii.size(); ++i) {
        // Each call to _centroidExtractor within this loop goes through exactly the same error-checking
        // logic and returns the same result, but it's not expensive logic, so we just call it repeatedly
        // instead of coming up with a new interface that would allow us to move it outside the loop.
        ellipse.setCenter(_centroidExtractor(measRecord, getFlagHandler(i)));
        axes->setA(_ctrl.radii[i]);
        axes->setB(_ctrl.radii[i]);
        ApertureFluxAlgorithm::Result result = computeFlux(exposure.getMaskedImage(), ellipse, _ctrl);
        copyResultToRecord(result, measRecord, i);
    }
}

---

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

• /home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/CircularApertureFlux.h
• /home/lsstsw/stack/Linux64/meas_base/11.0+1/src/CircularApertureFlux.cc