Shapelet.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
#ifndef LSST_MEAS_ALGORITHMS_SHAPELET_H
#define LSST_MEAS_ALGORITHMS_SHAPELET_H

/* 
 * 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/>.
 */

#include <complex>
#include <memory>

#include "Eigen/Core"

#include "lsst/afw/table/Source.h"
#include "lsst/afw/image/Exposure.h"
#include "lsst/afw/geom/Point.h"

namespace lsst {
namespace meas {
namespace algorithms {

    class ShapeletImpl;
    namespace shapelet { class BVec; }

    class Shapelet 
    {
    public:
        typedef float PixelT;
        typedef std::shared_ptr<Shapelet> Ptr;
        typedef std::shared_ptr<const Shapelet> ConstPtr;

        typedef Eigen::VectorXd ShapeletVector;
        typedef Eigen::MatrixXd ShapeletCovariance;

        typedef lsst::afw::table::SourceRecord Source;
        typedef lsst::afw::image::Exposure<PixelT> Exposure;
        typedef lsst::afw::geom::PointD PointD;
        typedef lsst::afw::image::MaskPixel MaskPixel;

        Shapelet(
            int order,      
            double sigma    
        );

        Shapelet(
            int order,      
            double sigma,   
            const ShapeletVector& vector 
        );

        Shapelet(
            int order,      
            double sigma,   
            const ShapeletVector& vector, 
            const ShapeletCovariance& cov 
        );

        ~Shapelet();

        Shapelet(const Shapelet& rhs);

        Shapelet& operator=(const Shapelet& rhs);

        int getOrder() const;

        double getSigma() const;

        int size() const;

        const ShapeletVector& getValues() const;

        bool hasCovariance() const;

        std::shared_ptr<const ShapeletCovariance> getCovariance() const;

        void setSigma(double sigma);

        std::complex<double> getPQ(int p, int q);

        double evaluateAt(const PointD& pos);
        double evaluateAt(double x, double y);

        bool measureFromImage(
            const Source& source,       
            const PointD& pos,          
            bool isCentroidFixed,       
            bool isSigmaFixed,          
            double aperture,            
            const Exposure& exposure,   
            const MaskPixel okmask=0    
        );

        Shapelet(const shapelet::BVec& bvec);

        const shapelet::BVec& viewAsBVec() const;
        shapelet::BVec& viewAsBVec();

    private :

        ShapeletImpl* pImpl;
    };

    Eigen::Matrix2d getJacobian(
        const lsst::afw::image::Wcs& wcs,       
        const lsst::afw::geom::PointD& pos     
    );

}}}

#endif