Photometry.h

Go to the documentation of this file.

// -*- LSST-C++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#if !defined(LSST_MEAS_ALGORITHMS_PHOTOMETRY_H)
#define LSST_MEAS_ALGORITHMS_PHOTOMETRY_H 1
// Utility routines for photometry
//
#include <string>
#include "lsst/base.h"
#include "lsst/afw/image/MaskedImage.h"

namespace lsst {
namespace afw {
namespace geom {
namespace ellipses {
    class Ellipse;
}}}
namespace meas {
namespace algorithms {
namespace photometry {

/*
 * A comparison function that doesn't require equality closer than machine epsilon
 */
template <typename T>
struct fuzzyCompare {
    bool operator()(T x, T y) const {
        if (isEqual(x, y)) {
            return false;
        }
        return (x - y < 0) ? true : false;
    }
    bool isEqual(T x, T y) const {
        return ::fabs(x - y) < std::numeric_limits<T>::epsilon();
    }
};

template<typename PixelT>
class SincCoeffs {
public:
    typedef afw::image::Image<PixelT> CoeffT;

    static void cache(float r1,         
                      float r2          
        );

    static CONST_PTR(CoeffT)
    get(afw::geom::ellipses::Axes const& axes, 
        float const innerFactor=0.0            
        );

    static PTR(CoeffT)
    calculate(afw::geom::ellipses::Axes const& axes, 
              double const innerFactor=0.0           
        );

private:
    typedef std::map<float, PTR(CoeffT), fuzzyCompare<float> > CoeffMap;
    typedef std::map<float, CoeffMap, fuzzyCompare<float> > CoeffMapMap;
    SincCoeffs() : _cache() {};
    SincCoeffs(SincCoeffs const&); // unimplemented: singleton
    void operator=(SincCoeffs const&); // unimplemented: singleton
    static SincCoeffs& getInstance();

    CONST_PTR(CoeffT)
    _lookup(afw::geom::ellipses::Axes const& axes, double const innerFactor=0.0) const;

    CoeffMapMap _cache;                 
};


template<typename MaskedImageT>
std::pair<double, double>
calculateSincApertureFlux(MaskedImageT const& mimage, 
                          afw::geom::ellipses::Ellipse const& ellipse, 
                          double const innerFactor=0.0 
                         );

}}}} // namespace lsst::meas::algorithms::photometry
#endif