lsst::meas::algorithms::ApertureFlux Class Reference

A class that knows how to calculate fluxes as a simple sum over a Footprint. More...

#include <ApertureFlux.h>

Inheritance diagram for lsst::meas::algorithms::ApertureFlux:

Public Types
typedef std::vector< double >	VectorD

Public Member Functions
	ApertureFlux (ApertureFluxControl const &ctrl, afw::table::Schema &schema)
virtual	~ApertureFlux ()
Public Member Functions inherited from lsst::meas::algorithms::Algorithm
	Algorithm (AlgorithmControl const &ctrl)
virtual	~Algorithm ()
AlgorithmControl const &	getControl () const
	Return a clone of the control object used to construct the algorithm. More...
template<typename PixelT >
void	apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	Run the algorithm, filling appropriate fields in the given source. More...

Protected Attributes
afw::table::Key < afw::table::Array< double > >	_fluxKey
afw::table::Key < afw::table::Array< double > >	_errKey
afw::table::Key< int >	_nProfileKey
afw::table::Key< afw::table::Flag >	_flagKey

Private Member Functions
template<typename PixelT >
void	_apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	Given an image and a pixel position, return a Flux. More...
	LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE (ApertureFlux)

Additional Inherited Members
Protected Member Functions inherited from lsst::meas::algorithms::Algorithm
template<typename PixelT >
void	_apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	Simulated virtual function that all algorithms must implement. More...

Detailed Description

A class that knows how to calculate fluxes as a simple sum over a Footprint.

Implement "Aperture" photometry.

Definition at line 39 of file ApertureFlux.h.

Member Typedef Documentation

typedef std::vector<double> lsst::meas::algorithms::ApertureFlux::VectorD

Definition at line 41 of file ApertureFlux.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::ApertureFlux::ApertureFlux ( ApertureFluxControl const &  ctrl, afw::table::Schema &  schema  )

inline

Definition at line 43 of file ApertureFlux.h.

                                                                            :
        Algorithm(ctrl),
        _fluxKey(schema.addField< afw::table::Array<double> >(
                ctrl.name, "sum of pixels in apertures", "dn", ctrl.radii.size())),
        _errKey(schema.addField< afw::table::Array<double> >(
                ctrl.name + ".err", "uncertainty for " + ctrl.name, "dn", ctrl.radii.size())),
        _nProfileKey(schema.addField<int>(ctrl.name + ".nProfile", "pixels",
                                          "Number of points in radial profile")),
        _flagKey(schema.addField<afw::table::Flag>(ctrl.name + ".flag", "success flag for " + ctrl.name))
    {}

virtual lsst::meas::algorithms::ApertureFlux::~ApertureFlux ( )

inlinevirtual

Definition at line 53 of file ApertureFlux.h.

{}

Member Function Documentation

template<typename PixelT >

void lsst::meas::algorithms::ApertureFlux::_apply ( afw::table::SourceRecord &  source, afw::image::Exposure< PixelT > const &  exposure, afw::geom::Point2D const &  center  ) const

private

Given an image and a pixel position, return a Flux.

< object's column position

< object's row position

Definition at line 182 of file ApertureFlux.cc.

        {
    source.set(_flagKey, true); // say we've failed so that's the result if we throw
    VectorD const & radii = static_cast<ApertureFluxControl const &>(getControl()).radii;
    int const nradii = radii.size();

    typedef typename afw::image::Exposure<PixelT>::MaskedImageT MaskedImageT;
    typedef typename MaskedImageT::Image ImageT;

    MaskedImageT const& mimage = exposure.getMaskedImage();

    double const xcen = center.getX();   
    double const ycen = center.getY();   

    int const ixcen = afw::image::positionToIndex(xcen);
    int const iycen = afw::image::positionToIndex(ycen);

    // BBox for data image    
    afw::geom::BoxI imageBBox(mimage.getBBox());

    /* ******************************************************* */
    // Aperture flux
    for (int i = 0; i != nradii; ++i) {
        FootprintFlux<MaskedImageT> fluxFunctor(mimage);        
        afwDet::Footprint const foot(afw::geom::PointI(ixcen, iycen), radii[i], imageBBox);
        fluxFunctor.apply(foot);
        source.set(_fluxKey[i], fluxFunctor.getSum());
        source.set(_errKey[i], ::sqrt(fluxFunctor.getSumVar()));
        source.set(_nProfileKey, i + 1); // we've measured this many apertures
    }
    source.set(_flagKey, false);
}

lsst::meas::algorithms::ApertureFlux::LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE ( ApertureFlux  )

private

Member Data Documentation

afw::table::Key< afw::table::Array<double> > lsst::meas::algorithms::ApertureFlux::_errKey

protected

Definition at line 57 of file ApertureFlux.h.

afw::table::Key< afw::table::Flag > lsst::meas::algorithms::ApertureFlux::_flagKey

protected

Definition at line 59 of file ApertureFlux.h.

afw::table::Key< afw::table::Array<double> > lsst::meas::algorithms::ApertureFlux::_fluxKey

protected

Definition at line 56 of file ApertureFlux.h.

afw::table::Key<int> lsst::meas::algorithms::ApertureFlux::_nProfileKey

protected

Definition at line 58 of file ApertureFlux.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/include/lsst/meas/algorithms/ApertureFlux.h
• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/src/flux/ApertureFlux.cc