LSSTApplications  20.0.0
LSSTDataManagementBasePackage
AstrometryMapping.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_ASTROMETRY_MAPPING_H
26 #define LSST_JOINTCAL_ASTROMETRY_MAPPING_H
27 
28 #include <iostream>
29 #include <vector>
31 
32 namespace lsst {
33 namespace jointcal {
34 
35 class FatPoint;
36 class Point;
37 
40 public:
42  virtual std::size_t getNpar() const = 0;
43 
46  virtual void getMappingIndices(IndexVector &indices) const = 0;
47 
49 
52  virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
53  Eigen::MatrixX2d &H) const = 0;
55  virtual void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const = 0;
56 
58  // virtual void freezeErrorTransform() = 0;
59 
60  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
61 
63  virtual void positionDerivative(Point const &where, Eigen::Matrix2d &derivative,
64  double epsilon) const = 0;
65 
72  virtual void print(std::ostream &out) const = 0;
73 
75  virtual ~AstrometryMapping(){};
76 };
77 
78 inline std::ostream &operator<<(std::ostream &stream, AstrometryMapping const &mapping) {
79  mapping.print(stream);
80  return stream;
81 }
82 
83 } // namespace jointcal
84 } // namespace lsst
85 #endif // LSST_JOINTCAL_ASTROMETRY_MAPPING_H
lsst::jointcal::AstrometryMapping::positionDerivative
virtual void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const =0
The derivative w.r.t. position.
lsst::jointcal::AstrometryMapping::~AstrometryMapping
virtual ~AstrometryMapping()
Definition: AstrometryMapping.h:75
lsst::jointcal::AstrometryMapping::transformPosAndErrors
virtual void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const =0
The same as above but without the parameter derivatives (used to evaluate chi^2)
Eigenstuff.h
std::vector
STL class.
lsst::jointcal::AstrometryMapping::getMappingIndices
virtual void getMappingIndices(IndexVector &indices) const =0
Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has ...
MatrixX2d
Eigen::Matrix< double, Eigen::Dynamic, 2 > MatrixX2d
Definition: Eigenstuff.h:33
lsst::jointcal::AstrometryMapping::offsetParams
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Remember the error scale and freeze it.
std::ostream
STL class.
lsst::jointcal::operator<<
std::ostream & operator<<(std::ostream &stream, AstrometryMapping const &mapping)
Definition: AstrometryMapping.h:78
lsst::jointcal
Definition: Associations.h:49
lsst::jointcal::FatPoint
A Point with uncertainties.
Definition: FatPoint.h:34
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::AstrometryMapping::print
virtual void print(std::ostream &out) const =0
Print a string representation of the contents of this mapping, for debugging.
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
std::size_t
lsst::jointcal::AstrometryMapping::computeTransformAndDerivatives
virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const =0
Actually applies the AstrometryMapping and evaluates the derivatives w.r.t the fitted parameters.
lsst::jointcal::AstrometryMapping::getNpar
virtual std::size_t getNpar() const =0
Number of parameters in total.