Psf.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2013 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/>.
 */
#ifndef LSST_AFW_DETECTION_Psf_h_INCLUDED
#define LSST_AFW_DETECTION_Psf_h_INCLUDED

#include <string>
#include <limits>

#include <memory>

#include "lsst/daf/base.h"
#include "lsst/afw/geom/ellipses/Quadrupole.h"
#include "lsst/afw/math/Kernel.h"
#include "lsst/afw/image/Color.h"
#include "lsst/afw/table/io/Persistable.h"

namespace lsst { namespace afw { namespace detection {

class PsfFormatter;

class Psf : public daf::base::Citizen, public daf::base::Persistable,
            public afw::table::io::PersistableFacade<Psf>, public afw::table::io::Persistable
{
    static geom::Point2D makeNullPoint() {
        return geom::Point2D(std::numeric_limits<double>::quiet_NaN());
    }
public:
    typedef std::shared_ptr<Psf> Ptr;            
    typedef std::shared_ptr<const Psf> ConstPtr; 

    typedef math::Kernel::Pixel Pixel; 
    typedef image::Image<Pixel> Image; 

    enum ImageOwnerEnum {
        COPY=0,     
        INTERNAL=1  
    };

    virtual ~Psf() {}

    virtual PTR(Psf) clone() const = 0;

    PTR(Image) computeImage(
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color(),
        ImageOwnerEnum owner=COPY
    ) const;

    PTR(Image) computeKernelImage(
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color(),
        ImageOwnerEnum owner=COPY
    ) const;

    double computePeak(
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color()
    ) const;

    double computeApertureFlux(
        double radius,
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color()
    ) const;

    geom::ellipses::Quadrupole computeShape(
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color()
    ) const;

    PTR(math::Kernel const) getLocalKernel(
        geom::Point2D position=makeNullPoint(),
        image::Color color=image::Color()
    ) const;

    image::Color getAverageColor() const { return image::Color(); }

    virtual geom::Point2D getAveragePosition() const;

    geom::Box2I computeBBox(
        geom::Point2D position = makeNullPoint(),
        image::Color color = image::Color()
    ) const;

    static PTR(Image) recenterKernelImage(
        PTR(Image) im,
        geom::Point2D const & position,
        std::string const & warpAlgorithm = "lanczos5",
        unsigned int warpBuffer = 5
    );

protected:

    explicit Psf(bool isFixed=false);

private:


    virtual PTR(Image) doComputeImage(
        geom::Point2D const & position, image::Color const& color
    ) const;
    virtual PTR(Image) doComputeKernelImage(
        geom::Point2D const & position, image::Color const & color
    ) const = 0;
    virtual double doComputeApertureFlux(
        double radius, geom::Point2D const & position, image::Color const & color
    ) const = 0;
    virtual geom::ellipses::Quadrupole doComputeShape(
        geom::Point2D const & position, image::Color const & color
    ) const = 0;
    virtual geom::Box2I doComputeBBox(
        geom::Point2D const & position, image::Color const & color
    ) const = 0;

    bool const _isFixed;
    mutable PTR(Image) _cachedImage;
    mutable PTR(Image) _cachedKernelImage;
    mutable image::Color _cachedImageColor;
    mutable image::Color _cachedKernelImageColor;
    mutable geom::Point2D _cachedImagePosition;
    mutable geom::Point2D _cachedKernelImagePosition;

    LSST_PERSIST_FORMATTER(PsfFormatter)
};

}}} // namespace lsst::afw::detection

#endif // !LSST_AFW_DETECTION_Psf_h_INCLUDED