lsst.jointcal  16.0-20-g17d57d5+5
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:
37  explicit ConstrainedPhotometryModel(CcdImageList const &ccdImageList,
38  afw::geom::Box2D const &focalPlaneBBox, LOG_LOGGER log,
39  int visitOrder = 7, double errorPedestal_ = 0)
40  : PhotometryModel(log, errorPedestal_), _fittingChips(false), _fittingVisits(false) {
41  _chipVisitMap.reserve(ccdImageList.size());
42  }
43 
49 
51  unsigned assignIndices(std::string const &whatToFit, unsigned firstIndex) override;
52 
54  void offsetParams(Eigen::VectorXd const &delta) override;
55 
57  void freezeErrorTransform() override;
58 
60  void getMappingIndices(CcdImage const &ccdImage, std::vector<unsigned> &indices) const override;
61 
63  int getTotalParameters() const override;
64 
66  void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
67  Eigen::VectorXd &derivatives) const override;
68 
70  void dump(std::ostream &stream = std::cout) const override;
71 
72 protected:
73  PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
74 
75  /* The per-ccdImage transforms, each of which is a composition of a chip and visit transform.
76  * Not all pairs of _visitMap[visit] and _chipMap[chip] are guaranteed to have an entry in
77  * _chipVisitMap (for example, one ccd in one visit might fail to produce a catalog).
78  */
80  MapType _chipVisitMap;
81 
82  // The per-visit transforms that go into _chipVisitMap.
84  VisitMapType _visitMap;
85  // The per-chip transforms that go into _chipVisitMap.
87  ChipMapType _chipMap;
88 
92  template <class ChipTransfo, class VisitTransfo, class ChipVisitMapping>
93  void initialize(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder);
94 
97 
98 private:
99  // Which components of the model are we fitting currently?
100  bool _fittingChips;
101  bool _fittingVisits;
102 };
103 
105 public:
106  explicit ConstrainedFluxModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox,
107  int visitOrder = 7, double errorPedestal_ = 0)
108  : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
109  LOG_GET("jointcal.ConstrainedFluxModel"), visitOrder,
110  errorPedestal_) {
111  initialize<FluxTransfoSpatiallyInvariant, FluxTransfoChebyshev, ChipVisitFluxMapping>(
112  ccdImageList, focalPlaneBBox, visitOrder);
113  }
114 
116  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
117  fittedStar.getFlux() -= delta;
118  }
119 
121  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
122 
124  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
125  return fittedStar.getFlux() - refStar.getFlux();
126  };
127 
129  double getRefError(RefStar const &refStar) const override { return refStar.getFluxErr(); }
130 
132  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
133 
135  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
136 
138  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
139 
140 protected:
143  return photoCalib->getCalibrationMean();
144  }
145 };
146 
148 public:
149  explicit ConstrainedMagnitudeModel(CcdImageList const &ccdImageList,
150  afw::geom::Box2D const &focalPlaneBBox, int visitOrder = 7,
151  double errorPedestal_ = 0)
152  : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
153  LOG_GET("jointcal.ConstrainedMagnitudeModel"), visitOrder,
154  errorPedestal_) {
155  initialize<MagnitudeTransfoSpatiallyInvariant, MagnitudeTransfoChebyshev, ChipVisitMagnitudeMapping>(
156  ccdImageList, focalPlaneBBox, visitOrder);
157  }
158 
160  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
161  fittedStar.getMag() -= delta;
162  }
163 
165  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
166 
168  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
169  return fittedStar.getMag() - refStar.getMag();
170  };
171 
173  double getRefError(RefStar const &refStar) const override { return refStar.getMagErr(); }
174 
176  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
177 
179  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
180 
182  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
183 
184 protected:
187  return magFromFlux(photoCalib->getCalibrationMean());
188  }
189 };
190 
191 } // namespace jointcal
192 } // namespace lsst
193 
194 #endif // LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
ConstrainedPhotometryModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, LOG_LOGGER log, int visitOrder=7, double errorPedestal_=0)
Construct a constrained photometry model.
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).
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.
double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib) override
Return the initial calibration to use from this photoCalib.
std::map< VisitIdType, std::shared_ptr< PhotometryMapping > > VisitMapType
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).
ConstrainedMagnitudeModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7, double errorPedestal_=0)
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 getFlux() const
Definition: BaseStar.h:73
std::unordered_map< CcdImageKey, std::unique_ptr< ChipVisitPhotometryMapping > > MapType
ConstrainedFluxModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7, double errorPedestal_=0)
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).
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.
#define LOG_GET(logger)
The objects which have been measured several times.
Definition: FittedStar.h:37
double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib) override
Return the initial calibration to use from this photoCalib.
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)