LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 
33 #include "lsst/jointcal/CcdImage.h"
37 
38 namespace lsst {
39 namespace jointcal {
40 
41 class CcdImage;
42 class AstrometryTransform;
43 
51 public:
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 
114 protected:
117 
119  virtual AstrometryMapping *findMapping(CcdImage const &ccdImage) const = 0;
120 };
121 
122 std::ostream &operator<<(std::ostream &stream, AstrometryModel const &model);
123 
124 } // namespace jointcal
125 } // namespace lsst
126 
127 #endif // LSST_JOINTCAL_ASTROMETRY_MODEL_H
LOG_LOGGER
#define LOG_LOGGER
Definition: Log.h:703
std::string
STL class.
std::shared_ptr
STL class.
std::list< std::shared_ptr< CcdImage > >
CcdImage.h
AstrometryTransform.h
Eigenstuff.h
lsst::jointcal::AstrometryModel::findMapping
virtual AstrometryMapping * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
lsst::jointcal::AstrometryModel::getNpar
std::size_t getNpar(CcdImage const &ccdImage) const
Return the number of parameters in the mapping of CcdImage.
Definition: AstrometryModel.h:55
lsst::jointcal::AstrometryModel::~AstrometryModel
virtual ~AstrometryModel()
Definition: AstrometryModel.h:102
AstrometryMapping.h
lsst::jointcal::AstrometryModel::validate
bool validate(CcdImageList const &ccdImageList, int ndof) const
Return true if this is a "reasonable" model.
Definition: AstrometryModel.cc:30
lsst::jointcal::AstrometryModel::AstrometryModel
AstrometryModel(LOG_LOGGER log)
Definition: AstrometryModel.h:52
lsst::jointcal::AstrometryModel::offsetParams
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the provided amounts (by -delta).
lsst::jointcal::AstrometryModel
Interface between AstrometryFit and the combinations of Mappings from pixels to some tangent plane (a...
Definition: AstrometryModel.h:50
std::ostream
STL class.
lsst::jointcal::operator<<
std::ostream & operator<<(std::ostream &stream, AstrometryMapping const &mapping)
Definition: AstrometryMapping.h:78
lsst::jointcal::CcdImage
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
lsst::jointcal::AstrometryModel::assignIndices
virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex)=0
Assign indices to parameters involved in mappings, starting at firstIndex.
lsst::jointcal::AstrometryModel::_log
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.
Definition: AstrometryModel.h:116
lsst::jointcal
Definition: Associations.h:49
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::AstrometryModel::getTotalParameters
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.
base.packages.log
log
Definition: packages.py:35
lsst::jointcal::AstrometryMapping
virtual class needed in the abstraction of the distortion model
Definition: AstrometryMapping.h:39
std::size_t
lsst::jointcal::AstrometryModel::getMapping
virtual const AstrometryMapping * getMapping(CcdImage const &) const =0
Mapping associated to a given CcdImage.
lsst::jointcal::AstrometryModel::getSkyToTangentPlane
virtual const std::shared_ptr< AstrometryTransform const > getSkyToTangentPlane(CcdImage const &ccdImage) const =0
The transformation used to project the positions of FittedStars.
Log.h
LSST DM logging module built on log4cxx.
lsst::jointcal::AstrometryModel::print
virtual void print(std::ostream &out) const =0
Print a string representation of the contents of this mapping, for debugging.
lsst::jointcal::AstrometryModel::freezeErrorTransform
virtual void freezeErrorTransform()=0
lsst::jointcal::AstrometryMapping::getNpar
virtual std::size_t getNpar() const =0
Number of parameters in total.
lsst::jointcal::AstrometryModel::makeSkyWcs
virtual std::shared_ptr< afw::geom::SkyWcs > makeSkyWcs(CcdImage const &ccdImage) const =0
Make a SkyWcs that contains this model.