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/meas/algorithms/ImagePsf.h"
#include "lsst/afw/image/Wcs.h"
#include "lsst/afw/table/Exposure.h"
#include "lsst/afw/table/types.h"
#include "lsst/afw/geom/Box.h"
#include "lsst/afw/geom/polygon/Polygon.h"
#include "lsst/afw/math/warpExposure.h"

namespace lsst { namespace meas { namespace algorithms {

class CoaddPsf : public afw::table::io::PersistableFacade<CoaddPsf>, public ImagePsf {
public:

    explicit CoaddPsf(
        afw::table::ExposureCatalog const & catalog,
        afw::image::Wcs const & coaddWcs,
        std::string const & weightFieldName = "weight",
        std::string const & warpingKernelName="lanczos3",
        int cacheSize=10000
    );

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

    virtual afw::geom::Point2D getAveragePosition() const { return _averagePosition; }

    PTR(afw::image::Wcs const) getCoaddWcs() { return _coaddWcs; }

    int getComponentCount() const;

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

    CONST_PTR(afw::image::Wcs) getWcs(int index);

    double getWeight(int index);

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

    afw::geom::Box2I getBBox(int index);

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

    virtual bool isPersistable() const { 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(
        afw::geom::Point2D const & ccdXY,
        afw::image::Color const & color
    ) const;

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

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

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

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

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

private:

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

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

#endif