LSSTApplications  20.0.0
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;
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 
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
lsst::jointcal::MeasuredStar
objects measured on actual images.
Definition: MeasuredStar.h:46
LOG_LOGGER
#define LOG_LOGGER
Definition: Log.h:703
lsst::jointcal::FitterBase::saveChi2Contributions
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:325
lsst::jointcal::FitterBase::leastSquareDerivativesReference
virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList, TripletList &tripletList, Eigen::VectorXd &grad) const =0
Compute the derivatives of the reference terms.
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
lsst::jointcal::FitterBase::leastSquareDerivativesMeasurement
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.
lsst::jointcal::TripletList
Definition: Tripletlist.h:39
std::vector
STL class.
MeasuredStar.h
lsst::jointcal::FitterBase::_lastNTrip
Eigen::Index _lastNTrip
Definition: FitterBase.h:156
lsst::jointcal::FitterBase::accumulateStatImageList
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.
lsst::jointcal::FitterBase::minimize
MinimizeResult minimize(std::string const &whatToFit, double const nSigmaCut=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
lsst::jointcal::MinimizeResult::NonFinite
@ NonFinite
lsst::jointcal::FitterBase::FitterBase
FitterBase(FitterBase const &)=delete
No copy or move: there is only ever one fitter of a given type.
lsst::jointcal::FitterBase::accumulateStatRefStars
virtual void accumulateStatRefStars(Chi2Accumulator &accum) const =0
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for RefStars.
lsst::jointcal::MinimizeResult::Chi2Increased
@ Chi2Increased
lsst::jointcal::Chi2Statistic
Simple structure to accumulate chi2 and ndof.
Definition: Chi2.h:52
lsst::jointcal::FitterBase::findOutliers
std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers, FittedStarList &fsOutliers) const
Find Measurements and references contributing more than a cut, computed as.
Definition: FitterBase.cc:52
lsst::jointcal::FitterBase::_associations
std::shared_ptr< Associations > _associations
Definition: FitterBase.h:153
Chi2.h
lsst::jointcal::FitterBase::leastSquareDerivatives
void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const
Evaluates the chI^2 derivatives (Jacobian and gradient) for the current whatToFit setting.
Definition: FitterBase.cc:317
lsst::jointcal::FitterBase::FitterBase
FitterBase(std::shared_ptr< Associations > associations)
Definition: FitterBase.h:55
lsst::jointcal::CcdImage
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
lsst::jointcal::MinimizeResult::Failed
@ Failed
lsst::jointcal::FitterBase::getIndicesOfMeasuredStar
virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar, IndexVector &indices) const =0
Set the indices of a measured star from the full matrix, for outlier removal.
lsst::jointcal::MinimizeResult
MinimizeResult
Return value of minimize()
Definition: FitterBase.h:40
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
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::FitterBase::saveChi2MeasContributions
virtual void saveChi2MeasContributions(std::string const &filename) const =0
Save a CSV file containing residuals of measurement terms.
lsst::jointcal::FitterBase::FitterBase
FitterBase(FitterBase &&)=delete
lsst::jointcal::FitterBase::outliersContributions
void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers, TripletList &tripletList, Eigen::VectorXd &grad)
Contributions to derivatives from (presumably) outlier terms.
Definition: FitterBase.cc:292
lsst::jointcal::FitterBase::computeChi2
Chi2Statistic computeChi2() const
Returns the chi2 for the current state.
Definition: FitterBase.cc:42
lsst::jointcal::FitterBase::_whatToFit
std::string _whatToFit
Definition: FitterBase.h:154
lsst::jointcal::FitterBase::assignIndices
virtual void assignIndices(std::string const &whatToFit)=0
Set parameters to fit and assign indices in the big matrix.
Tripletlist.h
lsst::jointcal::FitterBase::removeMeasOutliers
void removeMeasOutliers(MeasuredStarList &outliers)
Remove measuredStar outliers from the fit. No Refit done.
Definition: FitterBase.cc:303
lsst::jointcal::FitterBase::offsetParams
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the requested quantities.
lsst::jointcal::FitterBase::operator=
FitterBase & operator=(FitterBase const &)=delete
lsst::jointcal::MinimizeResult::Converged
@ Converged
lsst::jointcal::FittedStarList
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:123
lsst::jointcal::FitterBase::_nParTot
Eigen::Index _nParTot
Definition: FitterBase.h:157
std::size_t
lsst::jointcal::Chi2Accumulator
Base class for Chi2Statistic and Chi2List, to allow addEntry inside Fitter for either class.
Definition: Chi2.h:44
FittedStar.h
lsst::jointcal::FitterBase::removeRefOutliers
void removeRefOutliers(FittedStarList &outliers)
Remove refStar outliers from the fit. No Refit done.
Definition: FitterBase.cc:311
Log.h
LSST DM logging module built on log4cxx.
lsst::jointcal::FitterBase::operator=
FitterBase & operator=(FitterBase &&)=delete
lsst::jointcal::FitterBase::_nMeasuredStars
Eigen::Index _nMeasuredStars
Definition: FitterBase.h:158
lsst::jointcal::FitterBase::saveChi2RefContributions
virtual void saveChi2RefContributions(std::string const &filename) const =0
Save a CSV file containing residuals of reference terms.