lsst::meas::algorithms::SincFlux Class Reference

A class that knows how to calculate fluxes using the SINC photometry algorithm /. More...

Inheritance diagram for lsst::meas::algorithms::SincFlux:

Public Member Functions
	SincFlux (SincFluxControl const &ctrl, afw::table::Schema &schema)
Public Member Functions inherited from lsst::meas::algorithms::FluxAlgorithm
FluxControl const &	getControl () const
	Return a clone of the control object used to construct the algorithm. More...
KeyTuple const &	getKeys () const
	Return the standard flux keys registered by this algorithm. More...
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...

Private Member Functions
template<typename PixelT >
void	_apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE (SincFlux)

Additional Inherited Members
Public Types inherited from lsst::meas::algorithms::FluxAlgorithm
typedef afw::table::KeyTuple < afw::table::Flux >	KeyTuple
	Tuple type that holds the keys that define a standard flux algorithm. More...
Protected Member Functions inherited from lsst::meas::algorithms::FluxAlgorithm
	FluxAlgorithm (FluxControl const &ctrl, KeyTuple const &keys)
	Initialize with a manually-constructed key tuple. More...
	FluxAlgorithm (FluxControl const &ctrl, afw::table::Schema &schema, char const *doc)
	Initialize using afw::table::addFlux field to fill out repetitive descriptions. More...
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 using the SINC photometry algorithm /.

Definition at line 758 of file SincFlux.cc.

Constructor & Destructor Documentation

lsst::meas::algorithms::SincFlux::SincFlux ( SincFluxControl const &  ctrl, afw::table::Schema &  schema  )

inline

Definition at line 761 of file SincFlux.cc.

                                                                    :
        FluxAlgorithm(ctrl, schema, "elliptical aperture photometry using sinc interpolation")
    {
        // calculate the needed coefficients 
        if (photometry::fuzzyCompare<float>().isEqual(ctrl.ellipticity, 0.0)) {
            photometry::SincCoeffs<float>::cache(ctrl.radius1, ctrl.radius2);
        }
    }

Member Function Documentation

template<typename PixelT >

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

private

Calculate the desired aperture flux using the sinc algorithm

Definition at line 788 of file SincFlux.cc.

        {
    source.set(getKeys().flag, true); // say we've failed so that's the result if we throw
    SincFluxControl const & ctrl = static_cast<SincFluxControl const &>(getControl());

    afw::geom::ellipses::Axes const axes(ctrl.radius2, ctrl.radius2*(1.0 - ctrl.ellipticity), ctrl.angle);
    std::pair<double, double> fluxes =
        photometry::calculateSincApertureFlux(exposure.getMaskedImage(),
                                              afw::geom::ellipses::Ellipse(axes, center),
                                              ctrl.radius1/ctrl.radius2);
    double flux = fluxes.first;
    double fluxErr = fluxes.second;
    source.set(getKeys().meas, flux);
    source.set(getKeys().err, fluxErr);
    source.set(getKeys().flag, false);
}

lsst::meas::algorithms::SincFlux::LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE ( SincFlux  )

private

---

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

• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/src/flux/SincFlux.cc