lsst.meas.base  21.0.0-4-gc004bbf+f575d84ea8
Classes | Public Types | Static Public Member Functions | List of all members
lsst::meas::base::SincCoeffs< PixelT > Class Template Reference

A singleton to calculate and cache the coefficients for sinc photometry. More...

#include <SincCoeffs.h>

Public Types

typedef afw::image::Image< PixelT > CoeffT
 

Static Public Member Functions

static void cache (float rInner, float rOuter)
 Cache the coefficients for a particular aperture. More...
 
static boost::shared_ptr< CoeffT const > get (afw::geom::ellipses::Axes const &outerEllipse, float const innerRadiusFactor=0.0)
 Get the coefficients for an aperture. More...
 
static boost::shared_ptr< CoeffTcalculate (afw::geom::ellipses::Axes const &outerEllipse, double const innerFactor=0.0)
 Calculate the coefficients for an aperture. More...
 

Detailed Description

template<typename PixelT>
class lsst::meas::base::SincCoeffs< PixelT >

A singleton to calculate and cache the coefficients for sinc photometry.

Caching is only performed for circular apertures (because elliptical apertures are assumed to be generated dynamically, and hence not expected to recur). Caching must be explicitly requested for a particular circular aperture (using the 'cache' method).

Definition at line 45 of file SincCoeffs.h.

Member Typedef Documentation

◆ CoeffT

template<typename PixelT >
typedef afw::image::Image<PixelT> lsst::meas::base::SincCoeffs< PixelT >::CoeffT

Definition at line 47 of file SincCoeffs.h.

Member Function Documentation

◆ cache()

template<typename PixelT >
void lsst::meas::base::SincCoeffs< PixelT >::cache ( float  rInner,
float  rOuter 
)
static

Cache the coefficients for a particular aperture.

The aperture is a circular annulus.

Definition at line 490 of file SincCoeffs.cc.

◆ calculate()

template<typename PixelT >
boost::shared_ptr< typename SincCoeffs< PixelT >::CoeffT > lsst::meas::base::SincCoeffs< PixelT >::calculate ( afw::geom::ellipses::Axes const &  outerEllipse,
double const  innerFactor = 0.0 
)
static

Calculate the coefficients for an aperture.

Definition at line 534 of file SincCoeffs.cc.

◆ get()

template<typename PixelT >
boost::shared_ptr< typename SincCoeffs< PixelT >::CoeffT const > lsst::meas::base::SincCoeffs< PixelT >::get ( afw::geom::ellipses::Axes const &  outerEllipse,
float const  innerRadiusFactor = 0.0 
)
static

Get the coefficients for an aperture.

Coefficients are retrieved from the cache, if available; otherwise they will be generated.

Definition at line 505 of file SincCoeffs.cc.


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