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
FitterBase.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_FITTER_BASE_H
26 #define LSST_JOINTCAL_FITTER_BASE_H
27 
28 #include "lsst/log/Log.h"
30 #include "lsst/jointcal/CcdImage.h"
31 #include "lsst/jointcal/Chi2.h"
35 
36 namespace lsst {
37 namespace jointcal {
38 
40 enum class MinimizeResult {
41  Converged, // fit has converged - no more outliers
42  Chi2Increased, // still some ouliers but chi2 increases
43  Failed, // factorization failed
44  NonFinite // non-finite chi2 statistic
45 };
46 
53 class FitterBase {
54 public:
56  : _associations(associations),
57  _whatToFit(""),
58  _lastNTrip(0),
59  _nTotal(0),
60  _nModelParams(0),
61  _nStarParams(0) {}
62 
64  FitterBase(FitterBase const &) = delete;
65  FitterBase(FitterBase &&) = delete;
66  FitterBase &operator=(FitterBase const &) = delete;
68 
113  MinimizeResult minimize(std::string const &whatToFit, double const nSigmaCut = 0,
114  double sigmaRelativeTolerance = 0, bool const doRankUpdate = true,
115  bool const doLineSearch = false, std::string const &dumpMatrixFile = "");
116 
120  Chi2Statistic computeChi2() const;
121 
131  void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const;
132 
141  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
142 
148  virtual void assignIndices(std::string const &whatToFit) = 0;
149 
158  virtual void saveChi2Contributions(std::string const &baseName) const;
159 
160  virtual ~FitterBase() = default;
161 
162 protected:
165 
166  Eigen::Index _lastNTrip; // last triplet count, used to speed up allocation
167  Eigen::Index _nTotal; // Total number of parameters being fit.
168  Eigen::Index _nModelParams; // Number of model parameters that are being fit.
169  Eigen::Index _nStarParams; // Number of star positions/fluxes that are being fit.
170 
171  // lsst.logging instance, to be created by subclass so that messages have consistent name while fitting.
173 
175  virtual void saveChi2MeasContributions(std::string const &filename) const = 0;
176 
178  virtual void saveChi2RefContributions(std::string const &filename) const = 0;
179 
197  std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers,
198  FittedStarList &fsOutliers, double &cut) const;
199 
204  void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers,
205  TripletList &tripletList, Eigen::VectorXd &grad);
206 
208  void removeMeasOutliers(MeasuredStarList &outliers);
209 
211  void removeRefOutliers(FittedStarList &outliers);
212 
214  virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar, IndexVector &indices) const = 0;
215 
217  virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const = 0;
218 
220  virtual void accumulateStatRefStars(Chi2Accumulator &accum) const = 0;
221 
228  CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad,
229  MeasuredStarList const *measuredStarList = nullptr) const = 0;
230 
232  virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList,
233  TripletList &tripletList, Eigen::VectorXd &grad) const = 0;
234 
235 private:
246  double _lineSearch(Eigen::VectorXd const &delta);
247 };
248 } // namespace jointcal
249 } // namespace lsst
250 #endif // LSST_JOINTCAL_FITTER_BASE_H
LSST DM logging module built on log4cxx.
#define LOG_LOGGER
Definition: Log.h:714
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
Base class for Chi2Statistic and Chi2List, to allow addEntry inside Fitter for either class.
Definition: Chi2.h:44
Simple structure to accumulate chi2 and ndof.
Definition: Chi2.h:52
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:116
Base class for fitters.
Definition: FitterBase.h:53
void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const
Evaluates the chI^2 derivatives (Jacobian and gradient) for the current whatToFit setting.
Definition: FitterBase.cc:344
void removeRefOutliers(FittedStarList &outliers)
Remove refStar outliers from the fit. No Refit done.
Definition: FitterBase.cc:338
virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar, IndexVector &indices) const =0
Set the indices of a measured star from the full matrix, for outlier removal.
Chi2Statistic computeChi2() const
Returns the chi2 for the current state.
Definition: FitterBase.cc:42
FitterBase(FitterBase &&)=delete
FitterBase & operator=(FitterBase const &)=delete
virtual void saveChi2MeasContributions(std::string const &filename) const =0
Save a CSV file containing residuals of measurement terms.
virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList, TripletList &tripletList, Eigen::VectorXd &grad) const =0
Compute the derivatives of the reference terms.
Eigen::Index _nModelParams
Definition: FitterBase.h:168
virtual ~FitterBase()=default
virtual void saveChi2Contributions(std::string const &baseName) const
Save the full chi2 term per star that was used in the minimization, for debugging.
Definition: FitterBase.cc:352
virtual void assignIndices(std::string const &whatToFit)=0
Set parameters to fit and assign indices in the big matrix.
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the requested quantities.
std::shared_ptr< Associations > _associations
Definition: FitterBase.h:163
virtual void accumulateStatRefStars(Chi2Accumulator &accum) const =0
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for RefStars.
virtual void saveChi2RefContributions(std::string const &filename) const =0
Save a CSV file containing residuals of reference terms.
FitterBase(std::shared_ptr< Associations > associations)
Definition: FitterBase.h:55
virtual void leastSquareDerivativesMeasurement(CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad, MeasuredStarList const *measuredStarList=nullptr) const =0
Compute the derivatives of the measured stars and model for one CcdImage.
void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers, TripletList &tripletList, Eigen::VectorXd &grad)
Contributions to derivatives from (presumably) outlier terms.
Definition: FitterBase.cc:319
std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers, FittedStarList &fsOutliers, double &cut) const
Find Measurements and references contributing more than a cut, computed as.
Definition: FitterBase.cc:52
virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const =0
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for measurements.
FitterBase & operator=(FitterBase &&)=delete
FitterBase(FitterBase const &)=delete
No copy or move: there is only ever one fitter of a given type.
void removeMeasOutliers(MeasuredStarList &outliers)
Remove measuredStar outliers from the fit. No Refit done.
Definition: FitterBase.cc:330
MinimizeResult minimize(std::string const &whatToFit, double const nSigmaCut=0, double sigmaRelativeTolerance=0, bool const doRankUpdate=true, bool const doLineSearch=false, std::string const &dumpMatrixFile="")
Does a 1 step minimization, assuming a linear model.
Definition: FitterBase.cc:178
Sources measured on images.
Definition: MeasuredStar.h:51
A list of MeasuredStar. They are usually filled in Associations::createCcdImage.
Definition: MeasuredStar.h:151
MinimizeResult
Return value of minimize()
Definition: FitterBase.h:40
A base class for image defects.