lsst.jointcal g15c59248fb+7187349dd0
AstrometryModel.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_MODEL_H
26#define LSST_JOINTCAL_ASTROMETRY_MODEL_H
27
28#include <iostream>
29#include "memory"
30
31#include "lsst/log/Log.h"
32
37
38namespace lsst {
39namespace jointcal {
40
41class CcdImage;
42class AstrometryTransform;
43
51public:
52 AstrometryModel(LOG_LOGGER log) : _log(log) {}
53
55 std::size_t getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
56
58 virtual const AstrometryMapping *getMapping(CcdImage const &) const = 0;
59
62 virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) = 0;
63
71 virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
72
74
77 CcdImage const &ccdImage) const = 0;
78
86 virtual std::shared_ptr<afw::geom::SkyWcs> makeSkyWcs(CcdImage const &ccdImage) const = 0;
87
89 virtual void freezeErrorTransform() = 0;
90
92 virtual std::size_t getTotalParameters() const = 0;
93
100 virtual void print(std::ostream &out) const = 0;
101
102 virtual ~AstrometryModel(){};
103
112 bool validate(CcdImageList const &ccdImageList, int ndof) const;
113
114protected:
116 LOG_LOGGER _log;
117
119 virtual AstrometryMapping *findMapping(CcdImage const &ccdImage) const = 0;
120};
121
123
124} // namespace jointcal
125} // namespace lsst
126
127#endif // LSST_JOINTCAL_ASTROMETRY_MODEL_H
virtual class needed in the abstraction of the distortion model
virtual std::size_t getNpar() const =0
Number of parameters in total.
Interface between AstrometryFit and the combinations of Mappings from pixels to some tangent plane (a...
virtual std::shared_ptr< afw::geom::SkyWcs > makeSkyWcs(CcdImage const &ccdImage) const =0
Make a SkyWcs that contains this model.
virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex)=0
Assign indices to parameters involved in mappings, starting at firstIndex.
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the provided amounts (by -delta).
virtual AstrometryMapping * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
std::size_t getNpar(CcdImage const &ccdImage) const
Return the number of parameters in the mapping of CcdImage.
virtual const AstrometryMapping * getMapping(CcdImage const &) const =0
Mapping associated to a given CcdImage.
virtual void print(std::ostream &out) const =0
Print a string representation of the contents of this mapping, for debugging.
virtual const std::shared_ptr< AstrometryTransform const > getSkyToTangentPlane(CcdImage const &ccdImage) const =0
The transformation used to project the positions of FittedStars.
bool validate(CcdImageList const &ccdImageList, int ndof) const
Return true if this is a "reasonable" model.
virtual void freezeErrorTransform()=0
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
T log(T... args)
std::ostream & operator<<(std::ostream &stream, AstrometryMapping const &mapping)
Class for a simple mapping implementing a generic AstrometryTransform.