LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
SimplePhotometryModel.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_SIMPLE_PHOTOMETRY_MODEL_H
26 #define LSST_JOINTCAL_SIMPLE_PHOTOMETRY_MODEL_H
27 
28 #include <map>
29 
30 #include "lsst/jointcal/CcdImage.h"
34 #include "lsst/jointcal/Point.h"
35 
36 namespace lsst {
37 namespace jointcal {
38 
39 class CcdImage;
40 class Point;
41 
44 public:
47  _myMap.reserve(ccdImageList.size());
48  }
49 
55 
57  Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) override;
58 
60  void offsetParams(Eigen::VectorXd const &delta) override;
61 
63  void freezeErrorTransform() override;
64 
66  void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override;
67 
69  std::size_t getTotalParameters() const override;
70 
72  void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
73  Eigen::VectorXd &derivatives) const override;
74 
76  virtual void print(std::ostream &out) const override;
77 
79 
80 protected:
83 
85  PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
86 };
87 
89 public:
90  SimpleFluxModel(CcdImageList const &ccdImageList, double errorPedestal = 0);
91 
93  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
94  fittedStar.getFlux() -= delta;
95  }
96 
98  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
99 
101  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
102 
104  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
105 
107  double getRefError(RefStar const &refStar) const override { return refStar.getFluxErr(); }
108 
110  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
111  return fittedStar.getFlux() - refStar.getFlux();
112  };
113 
119  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
120 
122  void print(std::ostream &out) const override;
123 };
124 
126 public:
127  SimpleMagnitudeModel(CcdImageList const &ccdImageList, double errorPedestal = 0);
128 
130  void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
131  fittedStar.getMag() -= delta;
132  }
133 
135  double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
136 
138  double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
139 
141  double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;
142 
144  double getRefError(RefStar const &refStar) const override { return refStar.getMagErr(); }
145 
147  double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
148  return fittedStar.getMag() - refStar.getMag();
149  };
150 
156  std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
157 
159  void print(std::ostream &out) const override;
160 };
161 
162 } // namespace jointcal
163 } // namespace lsst
164 
165 #endif // LSST_JOINTCAL_SIMPLE_PHOTOMETRY_MODEL_H
#define LOG_LOGGER
Definition: Log.h:714
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
FittedStars are objects whose position or flux is going to be fitted, and which come from the associa...
Definition: FittedStar.h:50
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
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
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.
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).
SimpleFluxModel(CcdImageList const &ccdImageList, double errorPedestal=0)
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
Return the mapping of ccdImage represented as a PhotoCalib.
void offsetFittedStar(FittedStar &fittedStar, double delta) const override
Offset the appropriate flux or magnitude (by -delta).
double getRefError(RefStar const &refStar) const override
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
Return the mapping of ccdImage represented as a PhotoCalib.
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 transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux for measuredStar on ccdImage.
SimpleMagnitudeModel(CcdImageList const &ccdImageList, double errorPedestal=0)
double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
Photometric response model which has a single photometric factor per CcdImage.
void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override
Compute the parametric derivatives of this model.
std::unordered_map< CcdImageKey, std::unique_ptr< PhotometryMapping > > MapType
SimplePhotometryModel & operator=(SimplePhotometryModel &&)=delete
std::size_t getTotalParameters() const override
Return the total number of parameters in this model.
PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const override
Return the mapping associated with this ccdImage.
void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override
Get how this set of parameters (of length Npar()) map into the "grand" fit.
void offsetParams(Eigen::VectorXd const &delta) override
Offset the parameters by the provided amounts (by -delta).
SimplePhotometryModel(SimplePhotometryModel const &)=delete
No copy or move: there is only ever one instance of a given 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...
SimplePhotometryModel(SimplePhotometryModel &&)=delete
void freezeErrorTransform() override
Once this routine has been called, the error transform is not modified by offsetParams().
virtual void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
SimplePhotometryModel(CcdImageList const &ccdImageList, LOG_LOGGER log, double errorPedestal=0)
SimplePhotometryModel & operator=(SimplePhotometryModel const &)=delete
A base class for image defects.
T reserve(T... args)
T size(T... args)