lsst.jointcal  16.0-17-g0bdc215+12
ConstrainedPhotometryModel.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #ifndef LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
3 #define LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
4 
5 #include <map>
6 
10 
11 namespace lsst {
12 namespace jointcal {
13 
26 public:
35  explicit ConstrainedPhotometryModel(CcdImageList const &ccdImageList,
36  afw::geom::Box2D const &focalPlaneBBox, int visitOrder = 7)
37  : _fittingChips(false), _fittingVisits(false) {
38  _chipVisitMap.reserve(ccdImageList.size());
39  }
40 
46 
48  unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) override;
49 
51  void offsetParams(Eigen::VectorXd const &delta) override;
52 
54  void freezeErrorTransform() override;
55 
57  void getMappingIndices(CcdImage const &ccdImage, std::vector<unsigned> &indices) const override;
58 
60  int getTotalParameters() const override;
61 
63  void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
64  Eigen::VectorXd &derivatives) const override;
65 
67  void dump(std::ostream &stream = std::cout) const override;
68 
69 protected:
70  PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
71 
72  /* The per-ccdImage transforms, each of which is a composition of a chip and visit transform.
73  * Not all pairs of _visitMap[visit] and _chipMap[chip] are guaranteed to have an entry in
74  * _chipVisitMap (for example, one ccd in one visit might fail to produce a catalog).
75  */
77  MapType _chipVisitMap;
78 
79  // The per-visit transforms that go into _chipVisitMap.
81  VisitMapType _visitMap;
82  // The per-chip transforms that go into _chipVisitMap.
84  ChipMapType _chipMap;
85 
89  template <class ChipTransfo, class VisitTransfo, class ChipVisitMapping>
90  void initialize(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder);
91 
94 
95 private:
96  // Which components of the model are we fitting currently?
97  bool _fittingChips;
98  bool _fittingVisits;
99 };
100 
102 public:
103  explicit ConstrainedFluxModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox,
104  int visitOrder = 7)
105  : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox, visitOrder) {
106  initialize<FluxTransfoSpatiallyInvariant, FluxTransfoChebyshev, ChipVisitFluxMapping>(
107  ccdImageList, focalPlaneBBox, visitOrder);
108  }
109 
111  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
112  fittedStar.getFlux() -= delta;
113  }
114 
116  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
117 
119  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
120  return fittedStar.getFlux() - refStar.getFlux();
121  };
122 
124  double getRefError(RefStar const &refStar) const override { return refStar.getFluxErr(); }
125 
127  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
128 
130  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
131 
133  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
134 
135 protected:
138  return photoCalib->getCalibrationMean();
139  }
140 };
141 
143 public:
144  explicit ConstrainedMagnitudeModel(CcdImageList const &ccdImageList,
145  afw::geom::Box2D const &focalPlaneBBox, int visitOrder = 7)
146  : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox, visitOrder) {
147  initialize<MagnitudeTransfoSpatiallyInvariant, MagnitudeTransfoChebyshev, ChipVisitMagnitudeMapping>(
148  ccdImageList, focalPlaneBBox, visitOrder);
149  }
150 
152  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
153  fittedStar.getMag() -= delta;
154  }
155 
157  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
158 
160  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
161  return fittedStar.getMag() - refStar.getMag();
162  };
163 
165  double getRefError(RefStar const &refStar) const override { return refStar.getMagErr(); }
166 
168  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
169 
171  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
172 
174  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
175 
176 protected:
179  return magFromFlux(photoCalib->getCalibrationMean());
180  }
181 };
182 
183 } // namespace jointcal
184 } // namespace lsst
185 
186 #endif // LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
Objects used as position anchors, typically USNO stars.
Definition: RefStar.h:16
virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
double getFluxErr(size_t filter) const
reference fluxErr in a given filter
Definition: RefStar.h:44
double getRefError(RefStar const &refStar) const override
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib)
Return the initial calibration to use from this photoCalib.
ConstrainedFluxModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7)
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)...
double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag)...
virtual std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const =0
Return the mapping of ccdImage represented as a PhotoCalib.
std::map< VisitIdType, std::shared_ptr< PhotometryMapping > > VisitMapType
ConstrainedPhotometryModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7)
Construct a constrained photometry model.
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
STL class.
STL class.
unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) override
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex...
int getTotalParameters() const override
Return the total number of parameters in this model.
double getRefError(RefStar const &refStar) const override
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
Class for a simple mapping implementing a generic Gtransfo.
PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const override
Return a pointer to the mapping associated with this ccdImage.
double getMag() const
Definition: BaseStar.h:80
objects measured on actual images.
Definition: MeasuredStar.h:19
double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag)...
void initialize(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder)
Initialize the chip, visit, and chipVisit mappings by creating appropriate transfos and mappings...
void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override
Compute the parametric derivatives of this model.
std::map< CcdIdType, std::shared_ptr< PhotometryMapping > > ChipMapType
double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib)
Return the initial calibration to use from this photoCalib.
double getFlux() const
Definition: BaseStar.h:73
std::unordered_map< CcdImageKey, std::unique_ptr< ChipVisitPhotometryMapping > > MapType
T size(T... args)
void dump(std::ostream &stream=std::cout) const override
Dump the contents of the transfos, for debugging.
double getMagErr() const
Definition: BaseStar.h:83
void offsetParams(Eigen::VectorXd const &delta) override
Offset the parameters by the provided amounts (by -delta).
Interface class for PhotometryFit.
Photometry model with constraints, .
double getFlux(size_t filter) const
reference flux in a given filter
Definition: RefStar.h:42
virtual double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib)=0
Return the initial calibration to use from this photoCalib.
Handler of an actual image from a single CCD.
Definition: CcdImage.h:41
ConstrainedPhotometryModel & operator=(ConstrainedPhotometryModel const &)=delete
STL class.
The objects which have been measured several times.
Definition: FittedStar.h:37
ConstrainedMagnitudeModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7)
void freezeErrorTransform() override
Once this routine has been called, the error transform is not modified by offsetParams().
virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux for measuredStar on ccdImage.
void getMappingIndices(CcdImage const &ccdImage, std::vector< unsigned > &indices) const override
Get how this set of parameters (of length Npar()) map into the "grand" fit.
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
T reserve(T... args)