lsst.jointcal  16.0-18-gdf247dd+1
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 
6 
12 #include "lsst/jointcal/RefStar.h"
13 #include <string>
14 #include <vector>
15 
16 namespace lsst {
17 namespace jointcal {
18 
20 public:
21  PhotometryModel(double errorPedestal_ = 0) : errorPedestal(errorPedestal_) {}
22 
31  virtual unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) = 0;
32 
40  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
41 
48  virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;
49 
62  virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
63 
72  virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
73 
83  virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
84 
92  virtual void freezeErrorTransform() = 0;
93 
100  virtual void getMappingIndices(CcdImage const &ccdImage, std::vector<unsigned> &indices) const = 0;
101 
109  virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
110  Eigen::VectorXd &derivatives) const = 0;
111 
113  virtual double getRefError(RefStar const &refStar) const = 0;
114 
116  virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;
117 
121  virtual std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const = 0;
122 
124  unsigned getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
125 
127  PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
128  return *(findMapping(ccdImage));
129  }
130 
132  virtual int getTotalParameters() const = 0;
133 
135  virtual void dump(std::ostream &stream = std::cout) const = 0;
136 
138  model.dump(s);
139  return s;
140  }
141 
142  double getErrorPedestal() { return errorPedestal; }
143 
145  double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const {
146  if (errorPedestal == 0) {
147  return measuredStar.getInstFluxErr();
148  } else {
149  return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
150  }
151  }
152 
154  double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const {
155  if (errorPedestal == 0) {
156  return measuredStar.getInstMagErr();
157  } else {
158  return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
159  }
160  }
161 
162 protected:
164  virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;
165 
166  // Pedestal on flux/magnitude error (percent of flux or delta magnitude)
168 };
169 } // namespace jointcal
170 } // namespace lsst
171 
172 #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.
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.
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.
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.
PhotometryModel(double errorPedestal_=0)
Handler of an actual image from a single CCD.
Definition: CcdImage.h:41
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.