UnitTransformedLikelihood.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_MEAS_MODELFIT_UnitTransformedLikelihood_h_INCLUDED
#define LSST_MEAS_MODELFIT_UnitTransformedLikelihood_h_INCLUDED
 
#include <vector>
#include <memory>
 
#include "ndarray.h"
 
#include "lsst/pex/config.h"
#include "lsst/geom/SpherePoint.h"
#include "lsst/afw/geom/ellipses/Ellipse.h"
#include "lsst/afw/image/Exposure.h"
#include "lsst/afw/detection/Footprint.h"
 
#include "lsst/meas/modelfit/common.h"
#include "lsst/meas/modelfit/Model.h"
#include "lsst/meas/modelfit/Likelihood.h"
#include "lsst/meas/modelfit/UnitSystem.h"
 
namespace lsst { namespace meas { namespace modelfit {

class UnitTransformedLikelihoodControl {
public:
 
    LSST_CONTROL_FIELD(usePixelWeights, bool,
                       "whether to individually weigh pixels using the variance image.");
 
    LSST_CONTROL_FIELD(weightsMultiplier, double,
                       "Scaling factor to apply to weights.");
 
    explicit UnitTransformedLikelihoodControl(bool usePixelWeights_=false, double weightsMultiplier_=1.0)
        : usePixelWeights(usePixelWeights_), weightsMultiplier(weightsMultiplier_) {}
 
};

class EpochFootprint {
public:
    explicit EpochFootprint(
        afw::detection::Footprint const &footprint,
        afw::image::Exposure<Pixel> const &exposure,
        shapelet::MultiShapeletFunction const &psf
    );
 
    afw::detection::Footprint const footprint;  
    afw::image::Exposure<Pixel> const exposure; 
    shapelet::MultiShapeletFunction const psf;   
};

class UnitTransformedLikelihood : public Likelihood {
public:

    void computeModelMatrix(
        ndarray::Array<Pixel,2,-1> const & modelMatrix,
        ndarray::Array<Scalar const,1,1> const & nonlinear,
        bool doApplyWeights=true
    ) const override;

    explicit UnitTransformedLikelihood(
        std::shared_ptr<Model> model,
        ndarray::Array<Scalar const,1,1> const & fixed,
        UnitSystem const & fitSys,
        geom::SpherePoint const & position,
        std::vector<std::shared_ptr<EpochFootprint>> const & epochFootprintList,
        UnitTransformedLikelihoodControl const & ctrl
    );

    explicit UnitTransformedLikelihood(
        std::shared_ptr<Model> model,
        ndarray::Array<Scalar const,1,1> const & fixed,
        UnitSystem const & fitSys,
        geom::SpherePoint const & position,
        afw::image::Exposure<Pixel> const & exposure,
        afw::detection::Footprint const & footprint,
        shapelet::MultiShapeletFunction const & psf,
        UnitTransformedLikelihoodControl const & ctrl
    );
 
    virtual ~UnitTransformedLikelihood();
 
private:
    class Impl;
    std::unique_ptr<Impl> _impl;
};
 
}}} // namespace lsst::meas::modelfit
 
#endif // !LSST_MEAS_MODELFIT_UnitTransformedLikelihood_h_INCLUDED