lsst.jointcal  17.0.1-4-gfa71e81+5
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;
62  FitterBase &operator=(FitterBase &&) = delete;
63 
105  MinimizeResult minimize(std::string const &whatToFit, double const nSigmaCut = 0,
106  bool const doRankUpdate = true, bool const doLineSearch = false,
107  std::string const &dumpMatrixFile = "");
108 
112  Chi2Statistic computeChi2() const;
113 
123  void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const;
124 
133  virtual void offsetParams(Eigen::VectorXd const &delta) = 0;
134 
140  virtual void assignIndices(std::string const &whatToFit) = 0;
141 
150  virtual void saveChi2Contributions(std::string const &baseName) const;
151 
153  virtual void saveChi2MeasContributions(std::string const &baseName) const = 0;
154 
156  virtual void saveChi2RefContributions(std::string const &baseName) const = 0;
157 
158 protected:
161 
162  int _lastNTrip; // last triplet count, used to speed up allocation
163  unsigned int _nParTot;
164  unsigned _nMeasuredStars;
165 
166  // lsst.logging instance, to be created by subclass so that messages have consistent name while fitting.
167  LOG_LOGGER _log;
168 
185  unsigned findOutliers(double nSigmaCut, MeasuredStarList &msOutliers, FittedStarList &fsOutliers) const;
186 
191  void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers,
192  TripletList &tripletList, Eigen::VectorXd &grad);
193 
195  void removeMeasOutliers(MeasuredStarList &outliers);
196 
198  void removeRefOutliers(FittedStarList &outliers);
199 
201  virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar,
202  std::vector<unsigned> &indices) const = 0;
203 
205  virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const = 0;
206 
208  virtual void accumulateStatRefStars(Chi2Accumulator &accum) const = 0;
209 
215  virtual void leastSquareDerivativesMeasurement(
216  CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad,
217  MeasuredStarList const *measuredStarList = nullptr) const = 0;
218 
220  virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList,
221  TripletList &tripletList, Eigen::VectorXd &grad) const = 0;
222 
223 private:
234  double _lineSearch(Eigen::VectorXd const &delta);
235 };
236 } // namespace jointcal
237 } // namespace lsst
238 #endif // LSST_JOINTCAL_FITTER_BASE_H
Simple structure to accumulate chi2 and ndof.
Definition: Chi2.h:52
Base class for fitters.
Definition: FitterBase.h:53
Base class for Chi2Statistic and Chi2List, to allow addEntry inside Fitter for either class...
Definition: Chi2.h:44
FitResults minimize(lsst::afw::math::Function1< ReturnT > const &function, std::vector< double > const &initialParameterList, std::vector< double > const &stepSizeList, std::vector< double > const &measurementList, std::vector< double > const &varianceList, std::vector< double > const &xPositionList, double errorDef)
A list of MeasuredStar. They are usually filled in Associations::createCcdImage.
Definition: MeasuredStar.h:146
MinimizeResult
Return value of minimize()
Definition: FitterBase.h:40
FitterBase(std::shared_ptr< Associations > associations)
Definition: FitterBase.h:55
STL class.
Class for a simple mapping implementing a generic AstrometryTransform.
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:122
objects measured on actual images.
Definition: MeasuredStar.h:46
std::shared_ptr< Associations > _associations
Definition: FitterBase.h:159
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
double computeChi2(const StarMatchList &L, const AstrometryTransform &transform)
the actual chi2
Definition: StarMatch.cc:246