Likelihood.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_Likelihood_h_INCLUDED
#define LSST_MEAS_MODELFIT_Likelihood_h_INCLUDED

#include "ndarray_fwd.h"

#include "lsst/pex/exceptions.h"
#include "lsst/meas/modelfit/common.h"
#include "lsst/meas/modelfit/Model.h"

namespace lsst { namespace meas { namespace modelfit {

class Likelihood
{
public:

    int getDataDim() const { return _data.getSize<0>(); }

    int getAmplitudeDim() const { return _model->getAmplitudeDim(); }

    int getNonlinearDim() const { return _model->getNonlinearDim(); }

    int getFixedDim() const { return _model->getFixedDim(); }

    ndarray::Array<Scalar const,1,1> getFixed() const { return _fixed; }

    ndarray::Array<Pixel const,1,1> getData() const { return _data; }

    ndarray::Array<Pixel const,1,1> getUnweightedData() const { return _unweightedData; }

    ndarray::Array<Pixel const,1,1> getWeights() const { return _weights; }

    ndarray::Array<Pixel const,1,1> getVariance() const { return _variance; }

    PTR(Model) getModel() const { return _model; }

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

    virtual ~Likelihood() {}

    // No copying
    Likelihood ( const Likelihood & ) = delete;
    Likelihood & operator= ( const Likelihood & ) = delete;

    // No moving
    Likelihood ( Likelihood && ) = delete;
    Likelihood & operator= ( Likelihood && ) = delete;

protected:

    Likelihood(PTR(Model) model, ndarray::Array<Scalar const,1,1> const & fixed) :
        _model(model), _fixed(fixed) {
        LSST_THROW_IF_NE(
            fixed.getSize<0>(), static_cast<std::size_t>(model->getFixedDim()),
            pex::exceptions::LengthError,
            "Fixed parameter vector size (%d) does not match Model fixed parameter dimensionality (%d)"
        );
    }

    PTR(Model) _model;
    ndarray::Array<Scalar const,1,1> _fixed;
    ndarray::Array<Pixel,1,1> _data;
    ndarray::Array<Pixel,1,1> _unweightedData;
    ndarray::Array<Pixel,1,1> _variance;
    ndarray::Array<Pixel,1,1> _weights;
};

}}} // namespace lsst::meas::modelfit

#endif // !LSST_MEAS_MODELFIT_Likelihood_h_INCLUDED