lsst.jointcal g15c59248fb+6fd314e22b
ConstrainedPhotometryModel.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2/*
3 * This file is part of jointcal.
4 *
5 * Developed for the LSST Data Management System.
6 * This product includes software developed by the LSST Project
7 * (https://www.lsst.org).
8 * See the COPYRIGHT file at the top-level directory of this distribution
9 * for details of code ownership.
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 */
24
25#ifndef LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
26#define LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
27
28#include <map>
29
33
34namespace lsst {
35namespace jointcal {
36
49public:
60 explicit ConstrainedPhotometryModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox,
61 LOG_LOGGER log, int visitOrder = 7, double errorPedestal = 0)
62 : PhotometryModel(log, errorPedestal), _fittingChips(false), _fittingVisits(false) {
63 _chipVisitMap.reserve(ccdImageList.size());
64 }
65
71
73 Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) override;
74
76 void offsetParams(Eigen::VectorXd const &delta) override;
77
79 void freezeErrorTransform() override;
80
82 void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override;
83
85 std::size_t getTotalParameters() const override;
86
88 void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
89 Eigen::VectorXd &derivatives) const override;
90
92 void print(std::ostream &out) const override;
93
95
96protected:
97 PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
98
99 /* The per-ccdImage transforms, each of which is a composition of a chip and visit transform.
100 * Not all pairs of _visitMap[visit] and _chipMap[chip] are guaranteed to have an entry in
101 * _chipVisitMap (for example, one ccd in one visit might fail to produce a catalog).
102 */
105
106 // The per-visit transforms that go into _chipVisitMap.
109 // The per-chip transforms that go into _chipVisitMap.
112
116 template <class ChipTransform, class VisitTransform, class ChipVisitMapping>
117 void initialize(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, int visitOrder);
118
121
127 double visitMean;
128 };
129
131 PrepPhotoCalib prepPhotoCalib(CcdImage const &ccdImage) const;
132
133private:
134 // Which components of the model are we fitting currently?
135 bool _fittingChips;
136 bool _fittingVisits;
137};
138
140public:
141 explicit ConstrainedFluxModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox,
142 int visitOrder = 7, double errorPedestal = 0)
143 : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
144 LOG_GET("lsst.jointcal.ConstrainedFluxModel"), visitOrder,
146 initialize<FluxTransformSpatiallyInvariant, FluxTransformChebyshev, ChipVisitFluxMapping>(
147 ccdImageList, focalPlaneBBox, visitOrder);
148 }
149
151 void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
152 fittedStar.getFlux() -= delta;
153 }
154
156 double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
157
159 double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
160 return fittedStar.getFlux() - refStar.getFlux();
161 };
162
164 double getRefError(RefStar const &refStar) const override { return refStar.getFluxErr(); }
165
167 double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
168
170 double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
171
173 std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
174
176 void print(std::ostream &out) const override;
177
178protected:
181 return photoCalib->getCalibrationMean();
182 }
183};
184
186public:
187 explicit ConstrainedMagnitudeModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox,
188 int visitOrder = 7, double errorPedestal = 0)
189 : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
190 LOG_GET("lsst.jointcal.ConstrainedMagnitudeModel"), visitOrder,
193 ChipVisitMagnitudeMapping>(ccdImageList, focalPlaneBBox, visitOrder);
194 }
195
197 void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
198 fittedStar.getMag() -= delta;
199 }
200
202 double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
203
205 double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
206 return fittedStar.getMag() - refStar.getMag();
207 };
208
210 double getRefError(RefStar const &refStar) const override { return refStar.getMagErr(); }
211
213 double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
214
216 double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
217
219 std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
220
222 void print(std::ostream &out) const override;
223
224protected:
227 return utils::nanojanskyToABMagnitude(photoCalib->getCalibrationMean());
228 }
229};
230
231} // namespace jointcal
232} // namespace lsst
233
234#endif // LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H
#define LOG_GET(logger)
double getMagErr() const
Definition: BaseStar.h:108
double getMag() const
Definition: BaseStar.h:105
double getFlux() const
Definition: BaseStar.h:98
double getFluxErr() const
Definition: BaseStar.h:102
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
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.
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
ConstrainedFluxModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, int visitOrder=7, double errorPedestal=0)
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux for measuredStar on ccdImage.
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
double getRefError(RefStar const &refStar) const override
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
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).
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
ConstrainedMagnitudeModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, int visitOrder=7, double errorPedestal=0)
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).
double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib) override
Return the initial calibration to use from this photoCalib.
double getRefError(RefStar const &refStar) const override
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux for measuredStar on ccdImage.
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
Return the mapping of ccdImage represented as a PhotoCalib.
PrepPhotoCalib prepPhotoCalib(CcdImage const &ccdImage) const
Helper for preparing toPhotoCalib()
void initialize(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, int visitOrder)
Initialize the chip, visit, and chipVisit mappings by creating appropriate transforms and mappings.
PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const override
Return a pointer to the mapping associated with this ccdImage.
void freezeErrorTransform() override
Once this routine has been called, the error transform is not modified by offsetParams().
void offsetParams(Eigen::VectorXd const &delta) override
Offset the parameters by the provided amounts (by -delta).
ConstrainedPhotometryModel(ConstrainedPhotometryModel &&)=delete
ConstrainedPhotometryModel & operator=(ConstrainedPhotometryModel &&)=delete
std::map< CcdIdType, std::shared_ptr< PhotometryMapping > > ChipMapType
std::map< VisitIdType, std::shared_ptr< PhotometryMapping > > VisitMapType
ConstrainedPhotometryModel(CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, LOG_LOGGER log, int visitOrder=7, double errorPedestal=0)
Construct a constrained photometry model.
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
std::size_t getTotalParameters() const override
Return the total number of parameters in this model.
Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) override
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex...
void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override
Get how this set of parameters (of length Npar()) map into the "grand" fit.
ConstrainedPhotometryModel & operator=(ConstrainedPhotometryModel const &)=delete
std::unordered_map< CcdImageKey, std::unique_ptr< ChipVisitPhotometryMapping > > MapType
void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override
Compute the parametric derivatives of this model.
ConstrainedPhotometryModel(ConstrainedPhotometryModel const &)=delete
No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit)
virtual double initialChipCalibration(std::shared_ptr< afw::image::PhotoCalib const > photoCalib)=0
Return the initial calibration to use from this photoCalib.
FittedStars are objects whose position or flux is going to be fitted, and which come from the associa...
Definition: FittedStar.h:50
nth-order 2d Chebyshev photometry transform, plus the input flux.
Photometric offset independent of position, defined as -2.5 * log(flux / fluxMag0).
Sources measured on images.
Definition: MeasuredStar.h:51
Relates transform(s) to their position in the fitting matrix and allows interaction with the transfor...
Objects used as position/flux anchors (e.g.
Definition: RefStar.h:45
T log(T... args)
Class for a simple mapping implementing a generic AstrometryTransform.
T reserve(T... args)
T size(T... args)
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > pixToFocal
Key< int > photoCalib