LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Model.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_Model_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_Model_h_INCLUDED
26 
27 #include <vector>
28 
29 #include "lsst/base.h"
33 
34 namespace lsst { namespace meas { namespace modelfit {
35 
36 class Model;
37 class Prior;
38 
39 struct LocalUnitTransform;
40 
42 
56 class Model {
57 public:
58 
59  enum CenterEnum {
60  FIXED_CENTER = 0x0,
62  MULTI_CENTER = 0x2
63  };
64 
70 
86  static PTR(Model) make(BasisVector basisVector, NameVector const & prefixes, CenterEnum center);
87 
108 
121  static PTR(Model) makeGaussian(CenterEnum center, double radius=1.0);
122 
124  int getNonlinearDim() const { return _nonlinearNames.size(); }
125 
127  int getAmplitudeDim() const { return _amplitudeNames.size(); }
128 
130  int getFixedDim() const { return _fixedNames.size(); }
131 
133  int getBasisCount() const { return _basisVector.size(); }
134 
136  NameVector const & getNonlinearNames() const { return _nonlinearNames; }
137 
139  NameVector const & getAmplitudeNames() const { return _amplitudeNames; }
140 
142  NameVector const & getFixedNames() const { return _fixedNames; }
143 
145  BasisVector const & getBasisVector() const { return _basisVector; }
146 
149  ndarray::Array<Scalar const,1,1> const & nonlinear,
150  ndarray::Array<Scalar const,1,1> const & amplitudes,
151  ndarray::Array<Scalar const,1,1> const & fixed
152  ) const;
153 
155  virtual PTR(Prior) adaptPrior(PTR(Prior) prior) const = 0;
156 
161  virtual EllipseVector makeEllipseVector() const = 0;
162 
179  virtual void writeEllipses(
180  Scalar const * nonlinearIter, Scalar const * fixedIter,
181  EllipseIterator ellipseIter
182  ) const = 0;
183 
200  virtual void readEllipses(
201  EllipseConstIterator ellipseIter,
202  Scalar * nonlinearIter, Scalar * fixedIter
203  ) const = 0;
204 
216  ndarray::Array<Scalar const,1,1> const & nonlinear,
217  ndarray::Array<Scalar const,1,1> const & fixed
218  ) const;
219 
231  EllipseVector const & ellipses,
232  ndarray::Array<Scalar,1,1> const & nonlinear,
233  ndarray::Array<Scalar,1,1> const & fixed
234  ) const;
235 
244  virtual void transformParameters(
246  ndarray::Array<Scalar,1,1> const & nonlinear,
247  ndarray::Array<Scalar,1,1> const & amplitudes,
248  ndarray::Array<Scalar,1,1> const & fixed
249  ) const;
250 
251  virtual ~Model() {}
252 
253  // No copying
254  Model (const Model&) = delete;
255  Model& operator=(const Model&) = delete;
256 
257  // No moving
258  Model (Model&&) = delete;
259  Model& operator=(Model&&) = delete;
260 
261 protected:
262 
264  BasisVector basisVector,
265  NameVector nonlinearNames,
266  NameVector amplitudeNames,
267  NameVector fixedNames
268  );
269 
270 private:
271  NameVector _nonlinearNames;
272  NameVector _amplitudeNames;
273  NameVector _fixedNames;
274  BasisVector _basisVector;
275 };
276 
277 }}} // namespace lsst::meas::modelfit
278 
279 #endif // !LSST_MEAS_MODELFIT_Model_h_INCLUDED
lsst::meas::modelfit::Model::writeEllipses
virtual void writeEllipses(Scalar const *nonlinearIter, Scalar const *fixedIter, EllipseIterator ellipseIter) const =0
Convert a set of nonlinear+fixed parameter arrays to a vector of ellipses.
lsst::meas::modelfit::Model::EllipseIterator
std::vector< afw::geom::ellipses::Ellipse >::iterator EllipseIterator
Definition: Model.h:68
ellipses
lsst::meas::modelfit::Model::~Model
virtual ~Model()
Definition: Model.h:251
lsst::meas::modelfit::Model::NameVector
std::vector< std::string > NameVector
Definition: Model.h:65
lsst::meas::modelfit::Prior
Base class for Bayesian priors.
Definition: Prior.h:36
lsst::meas::modelfit::Model::getFixedDim
int getFixedDim() const
Return the number of fixed nonlinear parameters.
Definition: Model.h:130
std::vector
STL class.
std::vector::size
T size(T... args)
lsst::meas::modelfit::Model::MULTI_CENTER
@ MULTI_CENTER
Definition: Model.h:62
lsst::meas::modelfit::Model::CenterEnum
CenterEnum
Definition: Model.h:59
lsst::meas::modelfit::Model::readEllipses
virtual void readEllipses(EllipseConstIterator ellipseIter, Scalar *nonlinearIter, Scalar *fixedIter) const =0
Convert a vector of ellipses to a set of nonlinear+fixed parameter arrays.
lsst::meas::modelfit::Model::BasisVector
std::vector< boost::shared_ptr< shapelet::MultiShapeletBasis > > BasisVector
Definition: Model.h:66
lsst::meas::modelfit::Scalar
double Scalar
Typedefs to be used for probability and parameter values.
Definition: common.h:44
lsst::meas::modelfit::Model::getAmplitudeDim
int getAmplitudeDim() const
Return the number of linear parameters.
Definition: Model.h:127
lsst::meas::modelfit::Model
Abstract base class and concrete factories that define multi-shapelet galaxy models.
Definition: Model.h:56
lsst::meas::modelfit::Model::operator=
Model & operator=(Model &&)=delete
lsst::meas::modelfit::Model::makeGaussian
static boost::shared_ptr< Model > makeGaussian(CenterEnum center, double radius=1.0)
Construct a concrete Model instance that represents a single elliptical Gaussian function.
lsst::shapelet::MultiShapeletBasis
A basis formed from a linear combination of shapelet bases that differ only in radius.
Definition: MultiShapeletBasis.h:93
lsst::meas::modelfit::Model::SINGLE_CENTER
@ SINGLE_CENTER
Definition: Model.h:61
lsst::meas::modelfit::Model::EllipseVector
std::vector< afw::geom::ellipses::Ellipse > EllipseVector
Definition: Model.h:67
lsst::meas::modelfit::Model::getAmplitudeNames
NameVector const & getAmplitudeNames() const
Return the names of the amplitude parameters.
Definition: Model.h:139
lsst::meas::modelfit::Model::makeEllipseVector
virtual EllipseVector makeEllipseVector() const =0
Return an uninitialized vector of afw::geom::ellipses::Ellipse with the parametrization expected by r...
lsst::meas::modelfit::Model::EllipseConstIterator
std::vector< afw::geom::ellipses::Ellipse >::const_iterator EllipseConstIterator
Definition: Model.h:69
lsst::meas::modelfit::Model::readEllipses
void readEllipses(EllipseVector const &ellipses, ndarray::Array< Scalar, 1, 1 > const &nonlinear, ndarray::Array< Scalar, 1, 1 > const &fixed) const
Convert a vector of ellipses to a set of nonlinear+fixed parameter arrays.
lsst::meas::modelfit::Model::Model
Model(const Model &)=delete
lsst::meas::modelfit::LocalUnitTransform
A local mapping between two UnitSystems.
Definition: UnitSystem.h:80
lsst::meas::modelfit::Model::getFixedNames
NameVector const & getFixedNames() const
Return the names of the fixed nonlinear parameters.
Definition: Model.h:142
lsst::meas::modelfit::Model::writeEllipses
EllipseVector writeEllipses(ndarray::Array< Scalar const, 1, 1 > const &nonlinear, ndarray::Array< Scalar const, 1, 1 > const &fixed) const
Convert a set of nonlinear+fixed parameter arrays to a vector of ellipses.
lsst::meas::modelfit::Model::makeShapeletFunction
shapelet::MultiShapeletFunction makeShapeletFunction(ndarray::Array< Scalar const, 1, 1 > const &nonlinear, ndarray::Array< Scalar const, 1, 1 > const &amplitudes, ndarray::Array< Scalar const, 1, 1 > const &fixed) const
Create a MultiShapeletFunction object from a set of parameter vectors.
lsst::meas::modelfit::Model::FIXED_CENTER
@ FIXED_CENTER
Definition: Model.h:60
basis
table::Key< table::Array< double > > basis
Definition: PsfexPsf.cc:361
lsst::meas::modelfit::Model::Model
Model(Model &&)=delete
base.h
Ellipse.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::modelfit::Model::adaptPrior
virtual boost::shared_ptr< Prior > adaptPrior(boost::shared_ptr< Prior > prior) const =0
Given an arbitrary prior, return one compatible with this Model or throw LogicError.
lsst::meas::modelfit::Model::operator=
Model & operator=(const Model &)=delete
amplitudes
table::Key< table::Array< double > > amplitudes
Definition: LinearCombinationKernel.cc:300
lsst::meas::modelfit::Model::getNonlinearDim
int getNonlinearDim() const
Return the number of free nonlinear parameters.
Definition: Model.h:124
lsst::meas::modelfit::Model::transformParameters
virtual void transformParameters(LocalUnitTransform const &transform, ndarray::Array< Scalar, 1, 1 > const &nonlinear, ndarray::Array< Scalar, 1, 1 > const &amplitudes, ndarray::Array< Scalar, 1, 1 > const &fixed) const
Transform (in-place) parameter vectors from one unit system to another.
common.h
lsst::meas::modelfit::Model::getNonlinearNames
NameVector const & getNonlinearNames() const
Return the names of the free nonlinear parameters.
Definition: Model.h:136
lsst::meas::modelfit::Model::make
static boost::shared_ptr< Model > make(BasisVector basisVector, NameVector const &prefixes, CenterEnum center)
Construct a concrete Model instance with multiple ellipses and multishapelet bases.
lsst.pipe.tasks.insertFakes.radius
radius
Definition: insertFakes.py:288
PTR
#define PTR(...)
Definition: base.h:41
lsst::meas::modelfit::Model::Model
Model(BasisVector basisVector, NameVector nonlinearNames, NameVector amplitudeNames, NameVector fixedNames)
lsst::meas::modelfit::Model::make
static boost::shared_ptr< Model > make(boost::shared_ptr< shapelet::MultiShapeletBasis > basis, CenterEnum center)
Construct a concrete Model instance with a single ellipse and multishapelet basis.
transform
table::Key< int > transform
Definition: TransformMap.cc:299
lsst::meas::modelfit::Model::getBasisVector
BasisVector const & getBasisVector() const
Return the MultiShapeletBasis objects that comprise the Model.
Definition: Model.h:145
lsst::shapelet::MultiShapeletFunction
A multi-scale shapelet function.
Definition: MultiShapeletFunction.h:38
lsst::meas::modelfit::Model::getBasisCount
int getBasisCount() const
Return the number of MultiShapeletBasis objects (equivalently, the number of ellipses)
Definition: Model.h:133
lsst::meas::modelfit::ModelVector
std::vector< boost::shared_ptr< Model > > ModelVector
Definition: Model.h:39
MultiShapeletBasis.h