LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PhotometryFit.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_PHOTOMETRY_FIT_H
26 #define LSST_JOINTCAL_PHOTOMETRY_FIT_H
27 
28 #include <string>
29 #include <iostream>
30 #include <sstream>
31 
32 #include "lsst/log/Log.h"
34 #include "lsst/jointcal/CcdImage.h"
35 #include "lsst/jointcal/Chi2.h"
40 
41 namespace lsst {
42 namespace jointcal {
43 
45 class PhotometryFit : public FitterBase {
46 public:
54  std::shared_ptr<PhotometryModel> photometryModel)
55  : FitterBase(associations),
56  _fittingModel(false),
57  _fittingFluxes(false),
58  _photometryModel(photometryModel),
59  _nParModel(0),
60  _nParFluxes(0) {
61  _log = LOG_GET("jointcal.PhotometryFit");
62  }
63 
65  PhotometryFit(PhotometryFit const &) = delete;
69 
83  void assignIndices(std::string const &whatToFit) override;
84 
85  void offsetParams(Eigen::VectorXd const &delta) override;
86 
88  std::shared_ptr<PhotometryModel> getModel() const { return _photometryModel; }
89 
90 protected:
92  void saveChi2MeasContributions(std::string const &filename) const override;
93 
95  void saveChi2RefContributions(std::string const &filename) const override;
96 
97 private:
98  bool _fittingModel, _fittingFluxes;
99  std::shared_ptr<PhotometryModel> _photometryModel;
100 
101  // counts in parameter subsets.
102  std::size_t _nParModel;
103  std::size_t _nParFluxes;
104 
105  void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const override;
106 
107  void accumulateStatRefStars(Chi2Accumulator &accum) const override;
108 
109  void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar,
110  IndexVector &indices) const override;
111 
112  void leastSquareDerivativesMeasurement(CcdImage const &ccdImage, TripletList &tripletList,
113  Eigen::VectorXd &grad,
114  MeasuredStarList const *measuredStarList = nullptr) const override;
115 
117  void leastSquareDerivativesReference(FittedStarList const &fittedStarList, TripletList &tripletList,
118  Eigen::VectorXd &grad) const override;
119 
120 #ifdef STORAGE
121  Point transformFittedStar(FittedStar const &fittedStar, AstrometryTransform const *sky2TP,
122  Point const &refractionVector, double refractionCoeff, double mjd) const;
123 #endif
124 };
125 } // namespace jointcal
126 } // namespace lsst
127 #endif // LSST_JOINTCAL_PHOTOMETRY_FIT_H
lsst::jointcal::PhotometryFit::saveChi2RefContributions
void saveChi2RefContributions(std::string const &filename) const override
Save a CSV file containing residuals of reference terms.
Definition: PhotometryFit.cc:291
lsst::jointcal::MeasuredStar
objects measured on actual images.
Definition: MeasuredStar.h:46
std::string
STL class.
std::shared_ptr
STL class.
Associations.h
std::list< std::shared_ptr< CcdImage > >
CcdImage.h
lsst::jointcal::FitterBase::_log
LOG_LOGGER _log
Definition: FitterBase.h:161
Eigenstuff.h
lsst::jointcal::TripletList
Definition: Tripletlist.h:39
lsst::jointcal::PhotometryFit::PhotometryFit
PhotometryFit(std::shared_ptr< Associations > associations, std::shared_ptr< PhotometryModel > photometryModel)
Construct a photometry fitter.
Definition: PhotometryFit.h:53
std::vector
STL class.
LOG_GET
#define LOG_GET(logger)
Definition: Log.h:75
lsst::jointcal::PhotometryFit::saveChi2MeasContributions
void saveChi2MeasContributions(std::string const &filename) const override
Save a CSV file containing residuals of measurement terms.
Definition: PhotometryFit.cc:230
lsst::jointcal::FittedStar
The objects which have been measured several times.
Definition: FittedStar.h:61
lsst::jointcal::PhotometryFit::PhotometryFit
PhotometryFit(PhotometryFit &&)=delete
lsst::jointcal::PhotometryFit::operator=
PhotometryFit & operator=(PhotometryFit &&)=delete
lsst::jointcal::PhotometryFit
Class that handles the photometric least squares problem.
Definition: PhotometryFit.h:45
Chi2.h
lsst::jointcal::CcdImage
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
lsst::jointcal::PhotometryFit::assignIndices
void assignIndices(std::string const &whatToFit) override
Set parameters to fit and assign indices in the big matrix.
Definition: PhotometryFit.cc:186
lsst::jointcal::PhotometryFit::offsetParams
void offsetParams(Eigen::VectorXd const &delta) override
Offset the parameters by the requested quantities.
Definition: PhotometryFit.cc:212
lsst::jointcal::PhotometryFit::getModel
std::shared_ptr< PhotometryModel > getModel() const
Return the model being fit.
Definition: PhotometryFit.h:88
lsst::jointcal::PhotometryFit::PhotometryFit
PhotometryFit(PhotometryFit const &)=delete
No copy or move: there is only ever one fitter of a given type.
lsst::jointcal::PhotometryFit::operator=
PhotometryFit & operator=(PhotometryFit const &)=delete
lsst::jointcal::MeasuredStarList
A list of MeasuredStar. They are usually filled in Associations::createCcdImage.
Definition: MeasuredStar.h:146
lsst::jointcal::FitterBase
Base class for fitters.
Definition: FitterBase.h:53
lsst::jointcal
Definition: Associations.h:49
FitterBase.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
Tripletlist.h
PhotometryModel.h
lsst::jointcal::Point
A point in a plane.
Definition: Point.h:36
lsst::jointcal::FittedStarList
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:123
std::size_t
lsst::jointcal::AstrometryTransform
a virtual (interface) class for geometric transformations.
Definition: AstrometryTransform.h:65
lsst::jointcal::Chi2Accumulator
Base class for Chi2Statistic and Chi2List, to allow addEntry inside Fitter for either class.
Definition: Chi2.h:44
Log.h
LSST DM logging module built on log4cxx.