lsst::meas::base::SincCoeffs< PixelT > Class Template Reference

#include <SincCoeffs.h>

Classes
struct	FuzzyCompare

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

Static Public Member Functions
static void	cache (float rInner, float rOuter)
static boost::shared_ptr < CoeffT const >	get (afw::geom::ellipses::Axes const &outerEllipse, float const innerRadiusFactor=0.0)
static boost::shared_ptr< CoeffT >	calculate (afw::geom::ellipses::Axes const &outerEllipse, double const innerFactor=0.0)
	Calculate the coefficients for an aperture. More...

Private Types
typedef std::map< float, boost::shared_ptr< CoeffT > , FuzzyCompare< float > >	CoeffMap
typedef std::map< float, CoeffMap, FuzzyCompare< float > >	CoeffMapMap

Private Member Functions
	SincCoeffs ()
	SincCoeffs (SincCoeffs const &)
void	operator= (SincCoeffs const &)
boost::shared_ptr< CoeffT const >	_lookup (afw::geom::ellipses::Axes const &outerEllipse, double const innerRadiusFactor=0.0) const

Static Private Member Functions
static SincCoeffs &	getInstance ()

Private Attributes
CoeffMapMap	_cache

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 43 of file SincCoeffs.h.

Member Typedef Documentation

template<typename PixelT>

typedef std::map<float, boost::shared_ptr< CoeffT >, FuzzyCompare<float> > lsst::meas::base::SincCoeffs< PixelT >::CoeffMap

private

Definition at line 83 of file SincCoeffs.h.

template<typename PixelT>

typedef std::map<float, CoeffMap, FuzzyCompare<float> > lsst::meas::base::SincCoeffs< PixelT >::CoeffMapMap

private

Definition at line 84 of file SincCoeffs.h.

template<typename PixelT>

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

Definition at line 46 of file SincCoeffs.h.

Constructor & Destructor Documentation

template<typename PixelT>

lsst::meas::base::SincCoeffs< PixelT >::SincCoeffs ( )

inlineprivate

Definition at line 85 of file SincCoeffs.h.

: _cache() {};

template<typename PixelT>

lsst::meas::base::SincCoeffs< PixelT >::SincCoeffs ( SincCoeffs< PixelT > const &  )

private

Member Function Documentation

template<typename PixelT >

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

private

Definition at line 540 of file SincCoeffs.cc.

{
    if (innerFactor < 0.0 || innerFactor > 1.0) {
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                          (boost::format("innerFactor = %f is not between 0 and 1") % innerFactor).str());
    }

    CONST_PTR(typename SincCoeffs<PixelT>::CoeffT) const null = CONST_PTR(SincCoeffs<PixelT>::CoeffT)();

    // We only cache circular apertures
    if (!FuzzyCompare<float>().isEqual(axes.getA(), axes.getB())) {
        return null;
    }
    typename CoeffMapMap::const_iterator iter1 = _cache.find(axes.getA());
    if (iter1 == _cache.end()) {
        return null;
    }
    typename CoeffMap::const_iterator iter2 = iter1->second.find(innerFactor);
    return (iter2 == iter1->second.end()) ? null : iter2->second;
}

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 515 of file SincCoeffs.cc.

{
    if (r1 < 0.0 || r2 < r1) {
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                          (boost::format("Invalid r1,r2 = %f,%f") % r1 % r2).str());
    }
    double const innerFactor = r1/r2;
    afw::geom::ellipses::Axes axes(r2, r2, 0.0);
    if (!getInstance()._lookup(axes, innerFactor)) {
        PTR(typename SincCoeffs<PixelT>::CoeffT) coeff = calculate(axes, innerFactor);
        coeff->markPersistent();
        getInstance()._cache[r2][innerFactor] = coeff;
    }
}

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 563 of file SincCoeffs.cc.

{
    if (innerFactor < 0.0 || innerFactor > 1.0) {
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                          (boost::format("innerFactor = %f is not between 0 and 1") % innerFactor).str());
    }

    // Kspace-real is fastest, but only slightly faster than kspace cplx
    // but real won't work for elliptical apertures due to symmetries assumed for real transform

    double const rad1 = axes.getA() * innerFactor;
    double const rad2 = axes.getA();
    // if there's no angle and no ellipticity
    if (FuzzyCompare<float>().isEqual(axes.getA(), axes.getB())) {
        // here we call the real transform
        return calcImageKSpaceReal<PixelT>(rad1, rad2);
    } else {
        // here we call the complex transform
        double const ellipticity = 1.0 - axes.getB()/axes.getA();
        return calcImageKSpaceCplx<PixelT>(rad1, rad2, axes.getTheta(), ellipticity);
    }
}

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 532 of file SincCoeffs.cc.

{
    CONST_PTR(CoeffT) coeff = getInstance()._lookup(axes, innerFactor);
    return coeff ? coeff : calculate(axes, innerFactor);
}

template<typename PixelT >

SincCoeffs< PixelT > & lsst::meas::base::SincCoeffs< PixelT >::getInstance ( void  )

staticprivate

Definition at line 508 of file SincCoeffs.cc.

{
    static SincCoeffs<PixelT> instance;
    return instance;
}

template<typename PixelT>

void lsst::meas::base::SincCoeffs< PixelT >::operator= ( SincCoeffs< PixelT > const &  )

private

Member Data Documentation

template<typename PixelT>

CoeffMapMap lsst::meas::base::SincCoeffs< PixelT >::_cache

private

Definition at line 99 of file SincCoeffs.h.

---

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

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