CoaddPsf.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_ALGORITHMS_COADDPSF_H)
#define LSST_MEAS_ALGORITHMS_COADDPSF_H

#include <memory>
#include "lsst/base.h"
#include "lsst/pex/config.h"
#include "lsst/meas/algorithms/ImagePsf.h"
#include "lsst/geom/Box.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/geom/polygon/Polygon.h"
#include "lsst/afw/table/Exposure.h"
#include "lsst/afw/table/types.h"
#include "lsst/afw/math/warpExposure.h"

namespace lsst {
namespace meas {
namespace algorithms {

class CoaddPsfControl {
public:
    LSST_CONTROL_FIELD(warpingKernelName, std::string,
                       "Name of warping kernel; choices: lanczos3,lanczos4,lanczos5,bilinear,nearest");
    LSST_CONTROL_FIELD(cacheSize, int, "Warping kernel cache size");

    explicit CoaddPsfControl(std::string _warpingKernelName = "lanczos3", int _cacheSize = 10000)
            : warpingKernelName(_warpingKernelName), cacheSize(_cacheSize) {}
};

class CoaddPsf : public afw::table::io::PersistableFacade<CoaddPsf>, public ImagePsf {
public:
    explicit CoaddPsf(afw::table::ExposureCatalog const& catalog, afw::geom::SkyWcs const& coaddWcs,
                      std::string const& weightFieldName = "weight",
                      std::string const& warpingKernelName = "lanczos3", int cacheSize = 10000);

    CoaddPsf(afw::table::ExposureCatalog const& catalog, afw::geom::SkyWcs const& coaddWcs,
             CoaddPsfControl const& ctrl, std::string const& weightFieldName = "weight")
            : CoaddPsf(catalog, coaddWcs, weightFieldName, ctrl.warpingKernelName, ctrl.cacheSize) {}

    PTR(afw::detection::Psf) clone() const override;

    PTR(afw::detection::Psf) resized(int width, int height) const override;
    geom::Point2D getAveragePosition() const override { return _averagePosition; }

    afw::geom::SkyWcs getCoaddWcs() { return _coaddWcs; }

    int getComponentCount() const;

    CONST_PTR(afw::detection::Psf) getPsf(int index);

    afw::geom::SkyWcs getWcs(int index);

    double getWeight(int index);

    afw::table::RecordId getId(int index);

    geom::Box2I getBBox(int index);

    CONST_PTR(afw::geom::polygon::Polygon) getValidPolygon(int index);

    bool isPersistable() const noexcept override { return true; }

    // Factory used to read CoaddPsf from an InputArchive; defined only in the source file.
    class Factory;

protected:
    PTR(afw::detection::Psf::Image)
    doComputeKernelImage(geom::Point2D const& ccdXY, afw::image::Color const& color) const override;

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

    // See afw::table::io::Persistable::getPersistenceName
    std::string getPersistenceName() const override;

    // See afw::table::io::Persistable::getPythonModule
    std::string getPythonModule() const override;

    // See afw::table::io::Persistable::write
    void write(OutputArchiveHandle& handle) const override;

    // Used by persistence only
    explicit CoaddPsf(afw::table::ExposureCatalog const& catalog,         
                      afw::geom::SkyWcs const& coaddWcs,                  
                      geom::Point2D const& averagePosition,               
                      std::string const& warpingKernelName = "lanczos3",  
                      int cacheSize = 10000                               
    );

private:
    afw::table::ExposureCatalog _catalog;
    afw::geom::SkyWcs _coaddWcs;
    afw::table::Key<double> _weightKey;
    geom::Point2D _averagePosition;
    std::string _warpingKernelName;  // could be removed if we could get this from _warpingControl (#2949)
    CONST_PTR(afw::math::WarpingControl) _warpingControl;
};

}  // namespace algorithms
}  // namespace meas
}  // namespace lsst

#endif