LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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 
152 protected:
155 
156  Eigen::Index _lastNTrip; // last triplet count, used to speed up allocation
157  Eigen::Index _nParTot;
158  Eigen::Index _nMeasuredStars;
159 
160  // lsst.logging instance, to be created by subclass so that messages have consistent name while fitting.
162 
164  virtual void saveChi2MeasContributions(std::string const &filename) const = 0;
165 
167  virtual void saveChi2RefContributions(std::string const &filename) const = 0;
168 
185  std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers,
186  FittedStarList &fsOutliers) const;
187 
192  void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers,
193  TripletList &tripletList, Eigen::VectorXd &grad);
194 
196  void removeMeasOutliers(MeasuredStarList &outliers);
197 
199  void removeRefOutliers(FittedStarList &outliers);
200 
202  virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar,
203  IndexVector &indices) const = 0;
204 
206  virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const = 0;
207 
209  virtual void accumulateStatRefStars(Chi2Accumulator &accum) const = 0;
210 
216  virtual void leastSquareDerivativesMeasurement(
217  CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad,
218  MeasuredStarList const *measuredStarList = nullptr) const = 0;
219 
221  virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList,
222  TripletList &tripletList, Eigen::VectorXd &grad) const = 0;
223 
224 private:
235  double _lineSearch(Eigen::VectorXd const &delta);
236 };
237 } // namespace jointcal
238 } // namespace lsst
239 #endif // LSST_JOINTCAL_FITTER_BASE_H
Simple structure to accumulate chi2 and ndof.
Definition: Chi2.h:52
#define LOG_LOGGER
Definition: Log.h:688
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)
Find the minimum of a function(x)
Definition: minimize.cc:177
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.
LSST DM logging module built on log4cxx.
A base class for image defects.
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:123
objects measured on actual images.
Definition: MeasuredStar.h:46
std::shared_ptr< Associations > _associations
Definition: FitterBase.h:153
STL class.
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
Eigen::Index _nMeasuredStars
Definition: FitterBase.h:158