lsst.jointcal  21.0.0-7-gc8ca178+01b6284db4
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 <vector>
30 
32 #include "lsst/log/Log.h"
33 
34 #include "lsst/jointcal/CcdImage.h"
39 #include "lsst/jointcal/RefStar.h"
40 
41 namespace lsst {
42 namespace jointcal {
43 
45 public:
50  PhotometryModel(LOG_LOGGER log, double errorPedestal = 0) : _log(log), errorPedestal(errorPedestal) {}
51 
60  virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) = 0;
61 
69  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
70 
77  virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;
78 
91  virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
92 
101  virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
102 
112  virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
113 
121  virtual void freezeErrorTransform() = 0;
122 
129  virtual void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const = 0;
130 
138  virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
139  Eigen::VectorXd &derivatives) const = 0;
140 
142  virtual double getRefError(RefStar const &refStar) const = 0;
143 
145  virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;
146 
151 
153  std::size_t getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
154 
156  PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
157  return *(findMapping(ccdImage));
158  }
159 
161  virtual std::size_t getTotalParameters() const = 0;
162 
169  virtual void print(std::ostream &out) const = 0;
170 
181  bool validate(CcdImageList const &ccdImageList, int ndof) const;
182 
189  bool checkPositiveOnBBox(CcdImage const &ccdImage) const;
190 
192  model.print(s);
193  return s;
194  }
195 
196  double getErrorPedestal() { return errorPedestal; }
197 
199  double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const {
200  if (errorPedestal == 0) {
201  return measuredStar.getInstFluxErr();
202  } else {
203  return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
204  }
205  }
206 
208  double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const {
209  if (errorPedestal == 0) {
210  return measuredStar.getInstMagErr();
211  } else {
212  return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
213  }
214  }
215 
216 protected:
218  virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;
219 
221  LOG_LOGGER _log;
222 
223  // Pedestal on flux/magnitude error (percent of flux or delta magnitude)
225 };
226 } // namespace jointcal
227 } // namespace lsst
228 
229 #endif // LSST_JOINTCAL_PHOTOMETRY_MODEL_H
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
The objects which have been measured several times.
Definition: FittedStar.h:61
objects measured on actual images.
Definition: MeasuredStar.h:46
double getInstFluxErr() const
Definition: MeasuredStar.h:98
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.
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.
virtual PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
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 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.
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 std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const =0
Return the mapping of ccdImage represented as a PhotoCalib.
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.
PhotometryMappingBase const & getMapping(CcdImage const &ccdImage) const
Get the mapping associated with ccdImage.
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.
bool checkPositiveOnBBox(CcdImage const &ccdImage) const
Check that the model is positive on the ccdImage bbox.
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.
friend std::ostream & operator<<(std::ostream &s, PhotometryModel const &model)
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 anchors, typically USNO stars.
Definition: RefStar.h:39
T hypot(T... args)
log
Class for a simple mapping implementing a generic AstrometryTransform.