LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
34namespace lsst { namespace meas { namespace modelfit {
35
36class Model;
37class Prior;
38
39struct LocalUnitTransform;
40
42
56class Model {
57public:
58
64
68 typedef std::vector<afw::geom::ellipses::Ellipse>::iterator EllipseIterator;
69 typedef std::vector<afw::geom::ellipses::Ellipse>::const_iterator EllipseConstIterator;
70
86 static std::shared_ptr<Model> make(BasisVector basisVector, NameVector const & prefixes, CenterEnum center);
87
108
121 static std::shared_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
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
245 LocalUnitTransform const & transform,
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
261protected:
262
264 BasisVector basisVector,
265 NameVector nonlinearNames,
266 NameVector amplitudeNames,
267 NameVector fixedNames
268 );
269
270private:
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
table::Key< table::Array< double > > amplitudes
Basic LSST definitions.
Abstract base class and concrete factories that define multi-shapelet galaxy models.
Definition Model.h:56
Model(const Model &)=delete
std::vector< afw::geom::ellipses::Ellipse >::iterator EllipseIterator
Definition Model.h:68
virtual void readEllipses(EllipseConstIterator ellipseIter, Scalar *nonlinearIter, Scalar *fixedIter) const =0
Convert a vector of ellipses to a set of nonlinear+fixed parameter arrays.
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.
NameVector const & getNonlinearNames() const
Return the names of the free nonlinear parameters.
Definition Model.h:136
virtual std::shared_ptr< Prior > adaptPrior(std::shared_ptr< Prior > prior) const =0
Given an arbitrary prior, return one compatible with this Model or throw LogicError.
int getAmplitudeDim() const
Return the number of linear parameters.
Definition Model.h:127
std::vector< std::string > NameVector
Definition Model.h:65
Model & operator=(Model &&)=delete
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.
std::vector< std::shared_ptr< shapelet::MultiShapeletBasis > > BasisVector
Definition Model.h:66
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.
static std::shared_ptr< Model > make(std::shared_ptr< shapelet::MultiShapeletBasis > basis, CenterEnum center)
Construct a concrete Model instance with a single ellipse and multishapelet basis.
BasisVector const & getBasisVector() const
Return the MultiShapeletBasis objects that comprise the Model.
Definition Model.h:145
int getNonlinearDim() const
Return the number of free nonlinear parameters.
Definition Model.h:124
NameVector const & getAmplitudeNames() const
Return the names of the amplitude parameters.
Definition Model.h:139
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.
int getBasisCount() const
Return the number of MultiShapeletBasis objects (equivalently, the number of ellipses)
Definition Model.h:133
std::vector< afw::geom::ellipses::Ellipse >::const_iterator EllipseConstIterator
Definition Model.h:69
Model & operator=(const Model &)=delete
NameVector const & getFixedNames() const
Return the names of the fixed nonlinear parameters.
Definition Model.h:142
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.
virtual EllipseVector makeEllipseVector() const =0
Return an uninitialized vector of afw::geom::ellipses::Ellipse with the parametrization expected by r...
std::vector< afw::geom::ellipses::Ellipse > EllipseVector
Definition Model.h:67
static std::shared_ptr< Model > make(BasisVector basisVector, NameVector const &prefixes, CenterEnum center)
Construct a concrete Model instance with multiple ellipses and multishapelet bases.
int getFixedDim() const
Return the number of fixed nonlinear parameters.
Definition Model.h:130
Model(BasisVector basisVector, NameVector nonlinearNames, NameVector amplitudeNames, NameVector fixedNames)
static std::shared_ptr< Model > makeGaussian(CenterEnum center, double radius=1.0)
Construct a concrete Model instance that represents a single elliptical Gaussian function.
A multi-scale shapelet function.
std::vector< std::shared_ptr< Model > > ModelVector
Definition Model.h:41
double Scalar
Typedefs to be used for probability and parameter values.
Definition common.h:44
T size(T... args)
table::Key< table::Array< double > > basis
Definition PsfexPsf.cc:361
A local mapping between two UnitSystems.
Definition UnitSystem.h:80