PsfexPsf.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/>.
 */
 
# if !defined(LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H)
#define LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H 1
 
#include "ndarray.h"
#include "lsst/geom/Box.h"
#include "lsst/meas/algorithms/ImagePsf.h"
#include "lsst/meas/extensions/psfex/psf.hh"
 
namespace lsst { namespace meas { namespace extensions { namespace psfex {
    namespace detail {
        class PsfexPsfFactory;
    }
 
 
struct PsfexPsfSerializationData {
    double average_x = 0.0;
    double average_y = 0.0;
    double pixel_step = 0.0;
    std::vector<int> group = std::vector<int>();
    std::vector<int> degree = std::vector<int>();
    std::vector<double> basis = std::vector<double>();
    std::vector<double> coeff = std::vector<double>();
    std::vector<int> size = std::vector<int>();
    ndarray::Array<float, 1, 1> comp = ndarray::Array<float, 1, 1>();
    ndarray::Array<double, 2, 2> context = ndarray::Array<double, 2, 2>();
};

class PsfexPsf : public lsst::afw::table::io::PersistableFacade<PsfexPsf>,
                 public lsst::meas::algorithms::ImagePsf {
    friend class detail::PsfexPsfFactory;
public:
    explicit PsfexPsf(
        lsst::meas::extensions::psfex::Psf const& psf, 
        lsst::geom::Point2D const & averagePosition=lsst::geom::Point2D()
    );
    ~PsfexPsf() override;

    std::shared_ptr<lsst::afw::detection::Psf> clone() const override;

    std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;

    lsst::geom::Point2D getAveragePosition() const override { return _averagePosition; }

    std::shared_ptr<lsst::afw::math::LinearCombinationKernel const>
    getKernel(lsst::geom::Point2D =
              lsst::geom::Point2D(std::numeric_limits<double>::quiet_NaN())) const;

    bool isPersistable() const noexcept override { return true; }
 
    void write(lsst::afw::table::io::OutputArchiveHandle & handle) const override;

    int getNdim() const;

    PsfexPsfSerializationData getSerializationData() const;

    static std::shared_ptr<PsfexPsf> fromSerializationData(PsfexPsfSerializationData const & data);
 
private:
    lsst::geom::Point2D _averagePosition;
    // Here are the unpacked fields from the psfex psf struct
    struct poly *_poly;                 // Polynom describing the PSF variations
    float _pixstep;                     // Mask oversampling (pixel)
    std::vector<int> _size;             // PSF dimensions
    std::vector<float> _comp;           // Complete pix. data (PSF components)
    std::vector<std::pair<double, double> > _context; // Offset/scale to apply to context data
    mutable std::shared_ptr<lsst::afw::math::LinearCombinationKernel> _kernel; // keep a reference to getKernel()'s kernel

    explicit PsfexPsf();

    virtual std::shared_ptr<lsst::afw::detection::Psf::Image> _doComputeImage(
        lsst::geom::Point2D const & position, 
        lsst::afw::image::Color const& color,      
        lsst::geom::Point2D const& center     
    ) const;

    std::shared_ptr<lsst::afw::detection::Psf::Image> doComputeKernelImage(
        lsst::geom::Point2D const & position, 
        lsst::afw::image::Color const& color       
    ) const override;

    std::shared_ptr<lsst::afw::detection::Psf::Image> doComputeImage(
        lsst::geom::Point2D const & position, 
        lsst::afw::image::Color const& color       
    ) const override;

    lsst::geom::Box2I doComputeBBox(
        lsst::geom::Point2D const & position,
        lsst::afw::image::Color const & color
    ) const override;

    lsst::geom::Box2I _doComputeBBox(
        lsst::geom::Point2D const & position, 
        lsst::geom::Point2D const & center 
    ) const;

    std::string getPersistenceName() const override;
    std::string getPythonModule() const override;
};
 
}}}}
 
#endif // !LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H