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
PhotometryModel.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_PHOTOMETRY_MODEL_H
26#define LSST_JOINTCAL_PHOTOMETRY_MODEL_H
27
28#include <string>
29#include <utility>
30#include <vector>
31
33#include "lsst/log/Log.h"
34
41
42namespace lsst {
43namespace jointcal {
44
46public:
52
61 virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) = 0;
62
70 virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
71
78 virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;
79
92 virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
93
102 virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
103
113 virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
114
122 virtual void freezeErrorTransform() = 0;
123
130 virtual void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const = 0;
131
139 virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
140 Eigen::VectorXd &derivatives) const = 0;
141
143 virtual double getRefError(RefStar const &refStar) const = 0;
144
146 virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;
147
152
154 std::size_t getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
155
157 PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
158 return *(findMapping(ccdImage));
159 }
160
162 virtual std::size_t getTotalParameters() const = 0;
163
170 virtual void print(std::ostream &out) const = 0;
171
182 bool validate(CcdImageList const &ccdImageList, int ndof) const;
183
190 bool checkPositiveOnBBox(CcdImage const &ccdImage) const;
191
193 model.print(s);
194 return s;
195 }
196
197 double getErrorPedestal() const { return errorPedestal; }
198
200 double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const {
201 if (errorPedestal == 0) {
202 return measuredStar.getInstFluxErr();
203 } else {
204 return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
205 }
206 }
207
209 double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const {
210 if (errorPedestal == 0) {
211 return measuredStar.getInstMagErr();
212 } else {
213 return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
214 }
215 }
216
217 virtual ~PhotometryModel() = default;
218
219protected:
221 virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;
222
225
226 // Pedestal on flux/magnitude error (percent of flux or delta magnitude)
228};
229} // namespace jointcal
230} // namespace lsst
231
232#endif // LSST_JOINTCAL_PHOTOMETRY_MODEL_H
LSST DM logging module built on log4cxx.
#define LOG_LOGGER
Definition Log.h:714
Implementation of the Photometric Calibration class.
Handler of an actual image from a single CCD.
Definition CcdImage.h:64
FittedStars are objects whose position or flux is going to be fitted, and which come from the associa...
Definition FittedStar.h:50
Sources measured on images.
Relates transform(s) to their position in the fitting matrix and allows interaction with the transfor...
virtual std::size_t getNpar() const =0
Number of total parameters in this mapping.
friend std::ostream & operator<<(std::ostream &s, PhotometryModel const &model)
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.
virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex)=0
Assign indices in the full matrix to the parameters being fit in the 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 double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux for measuredStar on ccdImage.
virtual PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
virtual double getRefError(RefStar const &refStar) const =0
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
bool validate(CcdImageList const &ccdImageList, int ndof) const
Return true if this is a "reasonable" model.
virtual void print(std::ostream &out) const =0
Print a string representation of the contents of this mapping, for debugging.
PhotometryMappingBase const & getMapping(CcdImage const &ccdImage) const
Get the mapping associated with ccdImage.
virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const =0
Offset the appropriate flux or magnitude (by -delta).
PhotometryModel(LOG_LOGGER log, double errorPedestal=0)
virtual void freezeErrorTransform()=0
Once this routine has been called, the error transform is not modified by offsetParams().
virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Compute the residual between the model applied to a star and its associated fittedStar.
std::size_t getNpar(CcdImage const &ccdImage) const
Return the number of parameters in the mapping of CcdImage.
virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const =0
Compute the parametric derivatives of this model.
virtual void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const =0
Get how this set of parameters (of length Npar()) map into the "grand" fit.
virtual std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const =0
Return the mapping of ccdImage represented as a PhotoCalib.
bool checkPositiveOnBBox(CcdImage const &ccdImage) const
Check that the model is positive on the ccdImage bbox.
virtual ~PhotometryModel()=default
virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const =0
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).
double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Objects used as position/flux anchors (e.g.
Definition RefStar.h:45
T hypot(T... args)
T move(T... args)
STL namespace.