lsst.jointcal g84d6eb7eb7+1652af9b63
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
34#include "lsst/jointcal/Point.h"
35
36namespace lsst {
37namespace jointcal {
38
39class CcdImage;
40class Point;
41
44public:
45 SimplePhotometryModel(CcdImageList const &ccdImageList, LOG_LOGGER log, double errorPedestal = 0)
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
80protected:
83
85 PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
86};
87
89public:
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
126public:
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
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.
SimplePhotometryModel & operator=(SimplePhotometryModel &&)=delete
std::unordered_map< CcdImageKey, std::unique_ptr< PhotometryMapping > > MapType
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
SimplePhotometryModel & operator=(SimplePhotometryModel const &)=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)
log
Class for a simple mapping implementing a generic AstrometryTransform.
T reserve(T... args)
T size(T... args)