lsst.jointcal  21.0.0-19-g8edf490+60c609c61a
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), _whatToFit(""), _lastNTrip(0), _nParTot(0), _nMeasuredStars(0) {}
57 
59  FitterBase(FitterBase const &) = delete;
60  FitterBase(FitterBase &&) = delete;
61  FitterBase &operator=(FitterBase const &) = delete;
63 
108  MinimizeResult minimize(std::string const &whatToFit, double const nSigmaCut = 0,
109  double sigmaRelativeTolerance = 0, bool const doRankUpdate = true,
110  bool const doLineSearch = false, std::string const &dumpMatrixFile = "");
111 
115  Chi2Statistic computeChi2() const;
116 
126  void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const;
127 
136  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
137 
143  virtual void assignIndices(std::string const &whatToFit) = 0;
144 
153  virtual void saveChi2Contributions(std::string const &baseName) const;
154 
155 protected:
158 
159  Eigen::Index _lastNTrip; // last triplet count, used to speed up allocation
160  Eigen::Index _nParTot;
161  Eigen::Index _nMeasuredStars;
162 
163  // lsst.logging instance, to be created by subclass so that messages have consistent name while fitting.
164  LOG_LOGGER _log;
165 
167  virtual void saveChi2MeasContributions(std::string const &filename) const = 0;
168 
170  virtual void saveChi2RefContributions(std::string const &filename) const = 0;
171 
189  std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers,
190  FittedStarList &fsOutliers, double &cut) const;
191 
196  void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers,
197  TripletList &tripletList, Eigen::VectorXd &grad);
198 
200  void removeMeasOutliers(MeasuredStarList &outliers);
201 
203  void removeRefOutliers(FittedStarList &outliers);
204 
206  virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar,
207  IndexVector &indices) const = 0;
208 
210  virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const = 0;
211 
213  virtual void accumulateStatRefStars(Chi2Accumulator &accum) const = 0;
214 
221  CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad,
222  MeasuredStarList const *measuredStarList = nullptr) const = 0;
223 
225  virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList,
226  TripletList &tripletList, Eigen::VectorXd &grad) const = 0;
227 
228 private:
239  double _lineSearch(Eigen::VectorXd const &delta);
240 };
241 } // namespace jointcal
242 } // namespace lsst
243 #endif // LSST_JOINTCAL_FITTER_BASE_H
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:123
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:330
void removeRefOutliers(FittedStarList &outliers)
Remove refStar outliers from the fit. No Refit done.
Definition: FitterBase.cc:324
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.
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:338
Eigen::Index _nMeasuredStars
Definition: FitterBase.h:161
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:156
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:305
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:316
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:171
objects measured on actual images.
Definition: MeasuredStar.h:46
A list of MeasuredStar. They are usually filled in Associations::createCcdImage.
Definition: MeasuredStar.h:146
MinimizeResult
Return value of minimize()
Definition: FitterBase.h:40
Class for a simple mapping implementing a generic AstrometryTransform.