LSSTApplications  20.0.0
LSSTDataManagementBasePackage
MixturePrior.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_MEAS_MODELFIT_MixturePrior_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_MixturePrior_h_INCLUDED
26 
29 
30 namespace lsst { namespace meas { namespace modelfit {
31 
35 class MixturePrior : public Prior {
36 public:
37 
38  explicit MixturePrior(PTR(Mixture const) mixture, std::string const & tag="");
39 
42  ndarray::Array<Scalar const,1,1> const & nonlinear,
43  ndarray::Array<Scalar const,1,1> const & amplitudes
44  ) const override;
45 
48  ndarray::Array<Scalar const,1,1> const & nonlinear,
49  ndarray::Array<Scalar const,1,1> const & amplitudes,
50  ndarray::Array<Scalar,1,1> const & nonlinearGradient,
51  ndarray::Array<Scalar,1,1> const & amplitudeGradient,
52  ndarray::Array<Scalar,2,1> const & nonlinearHessian,
53  ndarray::Array<Scalar,2,1> const & amplitudeHessian,
54  ndarray::Array<Scalar,2,1> const & crossHessian
55  ) const override;
56 
59  Vector const & gradient, Matrix const & hessian,
60  ndarray::Array<Scalar const,1,1> const & nonlinear
61  ) const override;
62 
65  Vector const & gradient, Matrix const & hessian,
66  ndarray::Array<Scalar const,1,1> const & nonlinear,
67  ndarray::Array<Scalar,1,1> const & amplitudes
68  ) const override;
69 
72  Vector const & gradient, Matrix const & fisher,
73  ndarray::Array<Scalar const,1,1> const & nonlinear,
74  afw::math::Random & rng,
75  ndarray::Array<Scalar,2,1> const & amplitudes,
76  ndarray::Array<Scalar,1,1> const & weights,
77  bool multiplyWeights=false
78  ) const override;
79 
87 
88  PTR(Mixture const) getMixture() const { return _mixture; }
89 
90 private:
91  PTR(Mixture const) _mixture;
92 };
93 
94 }}} // namespace lsst::meas::modelfit
95 
96 #endif // !LSST_MEAS_MODELFIT_MixturePrior_h_INCLUDED
Prior.h
std::string
STL class.
lsst::meas::modelfit::Prior
Base class for Bayesian priors.
Definition: Prior.h:36
lsst::meas::modelfit::Scalar
double Scalar
Typedefs to be used for probability and parameter values.
Definition: common.h:44
lsst::meas::modelfit::MixtureUpdateRestriction
Helper class used to define restrictions to the form of the component parameters in Mixture::updateEM...
Definition: Mixture.h:111
lsst::meas::modelfit::MixturePrior::getUpdateRestriction
static MixtureUpdateRestriction const & getUpdateRestriction()
Return a MixtureUpdateRestriction appropriate for (e1,e2,r) data.
lsst::meas::modelfit::MixturePrior::getMixture
boost::shared_ptr< Mixture const > getMixture() const
Definition: MixturePrior.h:88
lsst::meas::modelfit::MixturePrior
A prior that's flat in amplitude parameters, and uses a Mixture for nonlinear parameters.
Definition: MixturePrior.h:35
lsst::meas::modelfit::MixturePrior::maximize
Scalar maximize(Vector const &gradient, Matrix const &hessian, ndarray::Array< Scalar const, 1, 1 > const &nonlinear, ndarray::Array< Scalar, 1, 1 > const &amplitudes) const override
Compute the amplitude vector that maximizes the prior x likelihood product.
lsst::meas::modelfit::MixturePrior::marginalize
Scalar marginalize(Vector const &gradient, Matrix const &hessian, ndarray::Array< Scalar const, 1, 1 > const &nonlinear) const override
Return the -log amplitude integral of the prior*likelihood product.
lsst::meas::modelfit::MixturePrior::MixturePrior
MixturePrior(boost::shared_ptr< Mixture const > mixture, std::string const &tag="")
lsst::meas::modelfit::Mixture
Definition: Mixture.h:128
lsst::meas::modelfit::Vector
Eigen::Matrix< Scalar, Eigen::Dynamic, 1 > Vector
Definition: common.h:46
lsst::meas::modelfit::MixturePrior::evaluateDerivatives
void evaluateDerivatives(ndarray::Array< Scalar const, 1, 1 > const &nonlinear, ndarray::Array< Scalar const, 1, 1 > const &amplitudes, ndarray::Array< Scalar, 1, 1 > const &nonlinearGradient, ndarray::Array< Scalar, 1, 1 > const &amplitudeGradient, ndarray::Array< Scalar, 2, 1 > const &nonlinearHessian, ndarray::Array< Scalar, 2, 1 > const &amplitudeHessian, ndarray::Array< Scalar, 2, 1 > const &crossHessian) const override
Evaluate the derivatives of the prior at the given point in nonlinear and amplitude space.
Mixture.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::modelfit::Matrix
Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic > Matrix
Definition: common.h:45
amplitudes
table::Key< table::Array< double > > amplitudes
Definition: LinearCombinationKernel.cc:300
lsst::afw::math::Random
A class that can be used to generate sequences of random numbers according to a number of different a...
Definition: Random.h:57
PTR
#define PTR(...)
Definition: base.h:41
lsst::meas::modelfit::MixturePrior::evaluate
Scalar evaluate(ndarray::Array< Scalar const, 1, 1 > const &nonlinear, ndarray::Array< Scalar const, 1, 1 > const &amplitudes) const override
Evaluate the prior at the given point in nonlinear and amplitude space.
lsst::meas::modelfit::MixturePrior::drawAmplitudes
void drawAmplitudes(Vector const &gradient, Matrix const &fisher, ndarray::Array< Scalar const, 1, 1 > const &nonlinear, afw::math::Random &rng, ndarray::Array< Scalar, 2, 1 > const &amplitudes, ndarray::Array< Scalar, 1, 1 > const &weights, bool multiplyWeights=false) const override
Draw a set of Monte Carlo amplitude vectors.