LSSTApplications  20.0.0
LSSTDataManagementBasePackage
SimpleAstrometryMapping.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef LSST_JOINTCAL_SIMPLE_ASTROMETRY_MAPPING_H
26 #define LSST_JOINTCAL_SIMPLE_ASTROMETRY_MAPPING_H
27 
28 #include <memory> // for unique_ptr
29 
32 
34 
38 namespace lsst {
39 namespace jointcal {
40 
42 public:
43  SimpleAstrometryMapping(AstrometryTransform const &astrometryTransform, bool toBeFit = true)
44  : toBeFit(toBeFit),
45  transform(astrometryTransform.clone()),
48 
54 
55  virtual void freezeErrorTransform() {
56  // from there on, updating the transform does not change the errors.
57  errorProp = transform->clone();
58  }
59 
61  std::size_t getNpar() const override {
62  if (toBeFit)
63  return transform->getNpar();
64  else
65  return 0;
66  }
67 
69  void getMappingIndices(IndexVector &indices) const override;
70 
72  void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const override;
73 
75  void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override;
76 
78  void offsetParams(Eigen::VectorXd const &delta) override {
79  if (toBeFit) transform->offsetParams(delta);
80  }
81 
83  Eigen::Index getIndex() const { return index; }
84 
86  void setIndex(Eigen::Index i) { index = i; }
87 
89  virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
90  Eigen::MatrixX2d &H) const override;
91 
93  virtual AstrometryTransform const &getTransform() const { return *transform; }
94 
96  bool getToBeFit() const { return toBeFit; }
98  void setToBeFit(bool value) { toBeFit = value; }
99 
100  void print(std::ostream &out) const override;
101 
102 protected:
103  // Whether this Mapping is fit as part of a Model.
104  bool toBeFit;
105  Eigen::Index index;
106  /* inheritance may also work. Perhaps with some trouble because
107  some routines in Mapping and AstrometryTransform have the same name */
109 
111  /* to avoid allocation at every call of positionDerivative.
112  use a pointer for constness */
114 };
115 
118 public:
120 
121  // ! contructor.
124  SimplePolyMapping(AstrometryTransformLinear const &CenterAndScale,
126 
132 
133  /* The SimpleAstrometryMapping version does not account for the
134  _centerAndScale transform */
135 
136  void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override;
137 
139  /* We should put the computation of error propagation and
140  parameter derivatives into the same AstrometryTransform routine because
141  it could be significantly faster */
142  void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
143  Eigen::MatrixX2d &H) const override;
144 
146  void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const override;
147 
149  AstrometryTransform const &getTransform() const override;
150 
151 private:
152  /* to better condition the 2nd derivative matrix, the
153  transformed coordinates are mapped (roughly) on [-1,1].
154  We need both the transform and its derivative. */
155  AstrometryTransformLinear _centerAndScale;
156  Eigen::Matrix2d preDer;
157 
158  /* Where we store the combination. */
159  mutable AstrometryTransformPolynomial actualResult;
160 };
161 
162 #ifdef STORAGE
163 
165 class SimpleIdentityMapping : public SimpleAstrometryMapping<AstrometryTransformIdentity> {
166 public:
168  virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
169  Eigen::MatrixX2d &H) const {
170  outPoint = where;
171  }
172 };
173 #endif
174 } // namespace jointcal
175 } // namespace lsst
176 
177 #endif // LSST_JOINTCAL_SIMPLE_ASTROMETRY_MAPPING_H
lsst::jointcal::SimpleAstrometryMapping::freezeErrorTransform
virtual void freezeErrorTransform()
Definition: SimpleAstrometryMapping.h:55
lsst::jointcal::SimpleAstrometryMapping::operator=
SimpleAstrometryMapping & operator=(SimpleAstrometryMapping const &)=delete
lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping
SimpleAstrometryMapping(SimpleAstrometryMapping &&)=delete
std::shared_ptr
STL class.
lsst::jointcal::SimplePolyMapping::SimplePolyMapping
SimplePolyMapping(SimplePolyMapping const &)=delete
No copy or move: there is only ever one instance of a given mapping (i.e.. per ccd+visit)
lsst::jointcal::SimpleAstrometryMapping::positionDerivative
void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override
The derivative w.r.t. position.
Definition: SimpleAstrometryMapping.cc:50
lsst::jointcal::SimpleAstrometryMapping::getTransform
virtual AstrometryTransform const & getTransform() const
Access to the (fitted) transform.
Definition: SimpleAstrometryMapping.h:93
lsst::jointcal::SimplePolyMapping::SimplePolyMapping
SimplePolyMapping(SimplePolyMapping &&)=delete
AstrometryTransform.h
lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping
SimpleAstrometryMapping(SimpleAstrometryMapping const &)=delete
No copy or move: there is only ever one instance of a given mapping (i.e.. per ccd+visit)
lsst::jointcal::AstrometryTransformLinear
implements the linear transformations (6 real coefficients).
Definition: AstrometryTransform.h:426
std::vector
STL class.
lsst::jointcal::SimpleAstrometryMapping::index
Eigen::Index index
Definition: SimpleAstrometryMapping.h:105
AstrometryMapping.h
lsst::jointcal::SimpleAstrometryMapping::transform
std::shared_ptr< AstrometryTransform > transform
Definition: SimpleAstrometryMapping.h:108
lsst::jointcal::SimplePolyMapping::~SimplePolyMapping
~SimplePolyMapping()
Definition: SimpleAstrometryMapping.h:119
MatrixX2d
Eigen::Matrix< double, Eigen::Dynamic, 2 > MatrixX2d
Definition: Eigenstuff.h:33
lsst::jointcal::SimplePolyMapping::operator=
SimplePolyMapping & operator=(SimplePolyMapping const &)=delete
lsst::jointcal::SimplePolyMapping::positionDerivative
void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override
The derivative w.r.t. position.
Definition: SimpleAstrometryMapping.cc:90
lsst::jointcal::SimpleAstrometryMapping
Definition: SimpleAstrometryMapping.h:41
lsst::jointcal::SimpleAstrometryMapping::offsetParams
void offsetParams(Eigen::VectorXd const &delta) override
Remember the error scale and freeze it.
Definition: SimpleAstrometryMapping.h:78
std::ostream
STL class.
lsst::jointcal::SimplePolyMapping::transformPosAndErrors
void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const override
The same as above but without the parameter derivatives (used to evaluate chi^2)
Definition: SimpleAstrometryMapping.cc:120
lsst::jointcal::SimplePolyMapping::getTransform
AstrometryTransform const & getTransform() const override
Access to the (fitted) transform.
Definition: SimpleAstrometryMapping.cc:131
lsst::jointcal::SimplePolyMapping::SimplePolyMapping
SimplePolyMapping(AstrometryTransformLinear const &CenterAndScale, AstrometryTransformPolynomial const &transform)
The transformation will be initialized to transform, so that the effective transformation reads trans...
Definition: SimpleAstrometryMapping.cc:73
lsst::jointcal::SimpleAstrometryMapping::setToBeFit
void setToBeFit(bool value)
Set whether this Mapping is to be fit as part of a Model.
Definition: SimpleAstrometryMapping.h:98
lsst::jointcal::SimpleAstrometryMapping::lin
std::unique_ptr< AstrometryTransformLinear > lin
Definition: SimpleAstrometryMapping.h:113
lsst::jointcal
Definition: Associations.h:49
lsst::jointcal::FatPoint
A Point with uncertainties.
Definition: FatPoint.h:34
lsst::jointcal::SimpleAstrometryMapping::print
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
Definition: SimpleAstrometryMapping.cc:71
lsst::jointcal::SimpleAstrometryMapping::getMappingIndices
void getMappingIndices(IndexVector &indices) const override
Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has ...
Definition: SimpleAstrometryMapping.cc:32
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::SimpleAstrometryMapping::toBeFit
bool toBeFit
Definition: SimpleAstrometryMapping.h:104
lsst::jointcal::SimplePolyMapping::computeTransformAndDerivatives
void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const override
Calls the transforms and implements the centering and scaling of coordinates.
Definition: SimpleAstrometryMapping.cc:107
lsst::jointcal::SimpleAstrometryMapping::computeTransformAndDerivatives
virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const override
Actually applies the AstrometryMapping and evaluates the derivatives w.r.t the fitted parameters.
Definition: SimpleAstrometryMapping.cc:65
lsst::jointcal::SimpleAstrometryMapping::operator=
SimpleAstrometryMapping & operator=(SimpleAstrometryMapping &&)=delete
lsst::jointcal::SimplePolyMapping
Mapping implementation for a polynomial transformation.
Definition: SimpleAstrometryMapping.h:117
lsst::jointcal::SimpleAstrometryMapping::getToBeFit
bool getToBeFit() const
Get whether this mapping is fit as part of a Model.
Definition: SimpleAstrometryMapping.h:96
lsst::jointcal::SimpleAstrometryMapping::getIndex
Eigen::Index getIndex() const
position of the parameters within the grand fitting scheme
Definition: SimpleAstrometryMapping.h:83
lsst::jointcal::AstrometryMapping
virtual class needed in the abstraction of the distortion model
Definition: AstrometryMapping.h:39
lsst::jointcal::Point
A point in a plane.
Definition: Point.h:36
lsst::jointcal::AstrometryTransformPolynomial
Polynomial transformation class.
Definition: AstrometryTransform.h:280
std::size_t
lsst::jointcal::AstrometryTransform
a virtual (interface) class for geometric transformations.
Definition: AstrometryTransform.h:65
lsst::jointcal::SimpleAstrometryMapping::errorProp
std::shared_ptr< AstrometryTransform > errorProp
Definition: SimpleAstrometryMapping.h:110
lsst::jointcal::SimpleAstrometryMapping::getNpar
std::size_t getNpar() const override
Number of parameters in total.
Definition: SimpleAstrometryMapping.h:61
lsst::jointcal::SimpleAstrometryMapping::transformPosAndErrors
void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const override
The same as above but without the parameter derivatives (used to evaluate chi^2)
Definition: SimpleAstrometryMapping.cc:41
std::unique_ptr
STL class.
lsst::jointcal::SimpleAstrometryMapping::setIndex
void setIndex(Eigen::Index i)
Set the index of this mapping in the grand fit.
Definition: SimpleAstrometryMapping.h:86
lsst::afw::image.slicing.clone
clone
Definition: slicing.py:257
lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping
SimpleAstrometryMapping(AstrometryTransform const &astrometryTransform, bool toBeFit=true)
Definition: SimpleAstrometryMapping.h:43
lsst::jointcal::SimplePolyMapping::operator=
SimplePolyMapping & operator=(SimplePolyMapping &&)=delete