lsst.jointcal  16.0-15-g8e16a51+4
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 
19 class CcdImage;
20 class Point;
21 class MeasuredStar;
22 
25 public:
34  virtual unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) = 0;
35 
43  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
44 
51  virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;
52 
65  virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
66 
75  virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
76 
86  virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;
87 
95  virtual void freezeErrorTransform() = 0;
96 
103  virtual void getMappingIndices(CcdImage const &ccdImage, std::vector<unsigned> &indices) const = 0;
104 
112  virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
113  Eigen::VectorXd &derivatives) const = 0;
114 
116  virtual double getRefError(RefStar const &refStar) const = 0;
117 
119  virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;
120 
124  virtual std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const = 0;
125 
127  unsigned getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }
128 
130  PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
131  return *(findMapping(ccdImage));
132  }
133 
135  virtual int getTotalParameters() const = 0;
136 
138  virtual void dump(std::ostream &stream = std::cout) const = 0;
139 
141  model.dump(s);
142  return s;
143  }
144 
145 protected:
147  virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;
148 };
149 } // namespace jointcal
150 } // namespace lsst
151 
152 #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.
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).
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).
Interface class for PhotometryFit.
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
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.