lsst.jointcal  16.0-20-g17d57d5+2
PhotometryModel.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #ifndef LSST_JOINTCAL_PHOTOMETRY_MODEL_H
3 #define LSST_JOINTCAL_PHOTOMETRY_MODEL_H
4 
5 #include <string>
6 #include <vector>
7 
9 #include "lsst/log/Log.h"
10 
11 #include "lsst/jointcal/CcdImage.h"
16 #include "lsst/jointcal/RefStar.h"
17 
18 namespace lsst {
19 namespace jointcal {
20 
22 public:
23  PhotometryModel(LOG_LOGGER log, double errorPedestal_ = 0) : _log(log), errorPedestal(errorPedestal_) {}
24 
33  virtual unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) = 0;
34 
42  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
43 
50  virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;
51 
64  virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
65 
74  virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
75 
85  virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
86 
94  virtual void freezeErrorTransform() = 0;
95 
102  virtual void getMappingIndices(CcdImage const &ccdImage, std::vector<unsigned> &indices) const = 0;
103 
111  virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
112  Eigen::VectorXd &derivatives) const = 0;
113 
115  virtual double getRefError(RefStar const &refStar) const = 0;
116 
118  virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;
119 
123  virtual std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const = 0;
124 
126  unsigned getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
127 
129  PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
130  return *(findMapping(ccdImage));
131  }
132 
134  virtual int getTotalParameters() const = 0;
135 
137  virtual void dump(std::ostream &stream = std::cout) const = 0;
138 
147  bool validate(CcdImageList const &ccdImageList) const;
148 
155  bool checkPositiveOnBBox(CcdImage const &ccdImage) const;
156 
158  model.dump(s);
159  return s;
160  }
161 
162  double getErrorPedestal() { return errorPedestal; }
163 
165  double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const {
166  if (errorPedestal == 0) {
167  return measuredStar.getInstFluxErr();
168  } else {
169  return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
170  }
171  }
172 
174  double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const {
175  if (errorPedestal == 0) {
176  return measuredStar.getInstMagErr();
177  } else {
178  return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
179  }
180  }
181 
182 protected:
184  virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;
185 
187  LOG_LOGGER _log;
188 
189  // Pedestal on flux/magnitude error (percent of flux or delta magnitude)
191 };
192 } // namespace jointcal
193 } // namespace lsst
194 
195 #endif // LSST_JOINTCAL_PHOTOMETRY_MODEL_H
Objects used as position anchors, typically USNO stars.
Definition: RefStar.h:16
virtual unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex)=0
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex...
virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
PhotometryModel(LOG_LOGGER log, double errorPedestal_=0)
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.
Relates transfo(s) to their position in the fitting matrix and allows interaction with the transfo(s)...
virtual int getTotalParameters() const =0
Return the total number of parameters in this model.
virtual std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const =0
Return the mapping of ccdImage represented as a PhotoCalib.
unsigned getNpar(CcdImage const &ccdImage) const
Return the number of parameters in the mapping of CcdImage.
PhotometryMappingBase const & getMapping(CcdImage const &ccdImage) const
Get the mapping associated with ccdImage.
bool checkPositiveOnBBox(CcdImage const &ccdImage) const
Check that the model is positive on the ccdImage bbox.
virtual void dump(std::ostream &stream=std::cout) const =0
Dump the contents of the transfos, for debugging.
STL class.
friend std::ostream & operator<<(std::ostream &s, PhotometryModel const &model)
Class for a simple mapping implementing a generic Gtransfo.
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)...
virtual void freezeErrorTransform()=0
Once this routine has been called, the error transform is not modified by offsetParams().
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the provided amounts (by -delta).
virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const =0
Compute the parametric derivatives of this model.
double getInstMagErr() const
Definition: MeasuredStar.h:72
double getInstFluxErr() const
Definition: MeasuredStar.h:70
objects measured on actual images.
Definition: MeasuredStar.h:19
virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const =0
Offset the appropriate flux or magnitude (by -delta).
T hypot(T... args)
virtual PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name...
virtual double getRefError(RefStar const &refStar) const =0
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
virtual void getMappingIndices(CcdImage const &ccdImage, std::vector< unsigned > &indices) const =0
Get how this set of parameters (of length Npar()) map into the "grand" fit.
Handler of an actual image from a single CCD.
Definition: CcdImage.h:41
bool validate(CcdImageList const &ccdImageList) const
Return true if this is a "reasonable" model.
STL class.
virtual unsigned getNpar() const =0
Number of total parameters in this mapping.
The objects which have been measured several times.
Definition: FittedStar.h:37
virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux for measuredStar on ccdImage.