Interp.h

Go to the documentation of this file.

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

/* 
 * LSST Data Management System
 * Copyright 2008-2015 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_INTERP_H)
#define LSST_MEAS_ALGORITHMS_INTERP_H
// Interpolate over defects in a MaskedImage
//
#include <limits>
#include <vector>
#include "lsst/afw/image/Defect.h"
#include "lsst/afw/image/MaskedImage.h"

namespace lsst {
namespace afw {
namespace detection {

    class Psf;

}} // afw::detection

namespace meas {
namespace algorithms {
namespace interp {
    double const lpc_1_c1 = 0.7737;
    double const lpc_1_c2 = -0.2737;
    double const lpc_1s2_c1 = 0.7358;
    double const lpc_1s2_c2 = -0.2358;
    /*
     * Used to debias min(x, y)
     */
    double const min2GaussianBias = -0.5641895835; 

    template <typename MaskedImageT>
    std::pair<bool, typename MaskedImageT::Image::Pixel> singlePixel(int x, int y, MaskedImageT const &image,
                                                                     bool horizontal, double minval);
}

class Defect : public lsst::afw::image::DefectBase {
public:
    typedef boost::shared_ptr<Defect> Ptr; 

    enum DefectPosition {
        LEFT = 1,                       
        NEAR_LEFT,                      
        WIDE_LEFT,                      
        MIDDLE,                         
        WIDE_NEAR_LEFT,                 
        WIDE,                           
        WIDE_NEAR_RIGHT,                
        NEAR_RIGHT,                     
        WIDE_RIGHT,                     
        RIGHT                           
    };

    enum { WIDE_DEFECT = 11 };          

    explicit Defect(const lsst::afw::geom::BoxI& bbox = lsst::afw::geom::BoxI() 
                   )
        :
        lsst::afw::image::DefectBase(bbox), _pos(static_cast<DefectPosition>(0)), _type(0) { }
    virtual ~Defect() {}

    void classify(DefectPosition pos,   
                  unsigned int type     
                 ) {
        _pos = pos;
        _type = type;
    }

    unsigned int getType() const { return _type; } 
    DefectPosition getPos() const { return _pos; } 
private:
    DefectPosition _pos;                
    unsigned int _type;                 
};

template <typename MaskedImageT>
void interpolateOverDefects(MaskedImageT &image,
                            lsst::afw::detection::Psf const &psf,
                            std::vector<Defect::Ptr> &badList,
                            double fallbackValue = 0.0,
                            bool useFallbackValueAtEdge=false
                           );

}}} // lsst::meas::algorithms::interp

#endif