WarpedPsf.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
 
/*
 * This file is part of meas_algorithms.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_MEAS_ALGORITHMS_WARPEDPSF_H
#define LSST_MEAS_ALGORITHMS_WARPEDPSF_H
 
#include "lsst/geom/Box.h"
#include "lsst/afw/geom/Transform.h"
#include "lsst/afw/math/warpExposure.h"
#include "lsst/afw/table/io/Persistable.h"
#include "lsst/meas/algorithms/ImagePsf.h"
 
namespace lsst {
namespace meas {
namespace algorithms {

class WarpedPsf final : public afw::table::io::PersistableFacade<WarpedPsf>, public ImagePsf {
public:
    WarpedPsf(std::shared_ptr<afw::detection::Psf const> undistortedPsf,
              std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> distortion,
              std::shared_ptr<afw::math::WarpingControl const> control);
    WarpedPsf(std::shared_ptr<afw::detection::Psf const> undistortedPsf,
              std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> distortion,
              std::string const& kernelName = "lanczos3", unsigned int cache = 10000);

    geom::Point2D getAveragePosition() const override;

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

    std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;
 
    bool isPersistable() const noexcept override {
        return _undistortedPsf->isPersistable() && _distortion->isPersistable() &&
               _warpingControl->isPersistable();
    }
 
protected:
    std::shared_ptr<afw::detection::Psf::Image> doComputeKernelImage(
            geom::Point2D const& position, afw::image::Color const& color) const override;
 
    std::string getPersistenceName() const override;
    std::string getPythonModule() const override;
    void write(OutputArchiveHandle& handle) const override;
 
    std::shared_ptr<afw::detection::Psf const> _undistortedPsf;
    std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> _distortion;
 
private:
    void _init();
    std::shared_ptr<afw::math::WarpingControl const> _warpingControl;
 
    geom::Box2I doComputeBBox(geom::Point2D const& position, afw::image::Color const& color) const override;
};
 
}  // namespace algorithms
}  // namespace meas
}  // namespace lsst
 
#endif  // LSST_MEAS_ALGORITHMS_WARPEDPSF_H