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
|
Base class for fitters. More...
#include <FitterBase.h>
Public Member Functions | |
FitterBase (std::shared_ptr< Associations > associations) | |
FitterBase (FitterBase const &)=delete | |
No copy or move: there is only ever one fitter of a given type. More... | |
FitterBase (FitterBase &&)=delete | |
FitterBase & | operator= (FitterBase const &)=delete |
FitterBase & | operator= (FitterBase &&)=delete |
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. More... | |
Chi2Statistic | computeChi2 () const |
Returns the chi2 for the current state. More... | |
void | leastSquareDerivatives (TripletList &tripletList, Eigen::VectorXd &grad) const |
Evaluates the chI^2 derivatives (Jacobian and gradient) for the current whatToFit setting. More... | |
virtual void | offsetParams (Eigen::VectorXd const &delta)=0 |
Offset the parameters by the requested quantities. More... | |
virtual void | assignIndices (std::string const &whatToFit)=0 |
Set parameters to fit and assign indices in the big matrix. More... | |
virtual void | saveChi2Contributions (std::string const &baseName) const |
Save the full chi2 term per star that was used in the minimization, for debugging. More... | |
virtual | ~FitterBase ()=default |
Protected Member Functions | |
virtual void | saveChi2MeasContributions (std::string const &filename) const =0 |
Save a CSV file containing residuals of measurement terms. More... | |
virtual void | saveChi2RefContributions (std::string const &filename) const =0 |
Save a CSV file containing residuals of reference terms. More... | |
std::size_t | findOutliers (double nSigmaCut, MeasuredStarList &msOutliers, FittedStarList &fsOutliers, double &cut) const |
Find Measurements and references contributing more than a cut, computed as. More... | |
void | outliersContributions (MeasuredStarList &msOutliers, FittedStarList &fsOutliers, TripletList &tripletList, Eigen::VectorXd &grad) |
Contributions to derivatives from (presumably) outlier terms. More... | |
void | removeMeasOutliers (MeasuredStarList &outliers) |
Remove measuredStar outliers from the fit. No Refit done. More... | |
void | removeRefOutliers (FittedStarList &outliers) |
Remove refStar outliers from the fit. No Refit done. More... | |
virtual void | getIndicesOfMeasuredStar (MeasuredStar const &measuredStar, IndexVector &indices) const =0 |
Set the indices of a measured star from the full matrix, for outlier removal. More... | |
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. More... | |
virtual void | accumulateStatRefStars (Chi2Accumulator &accum) const =0 |
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for RefStars. More... | |
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. More... | |
virtual void | leastSquareDerivativesReference (FittedStarList const &fittedStarList, TripletList &tripletList, Eigen::VectorXd &grad) const =0 |
Compute the derivatives of the reference terms. More... | |
Protected Attributes | |
std::shared_ptr< Associations > | _associations |
std::string | _whatToFit |
Eigen::Index | _lastNTrip |
Eigen::Index | _nTotal |
Eigen::Index | _nModelParams |
Eigen::Index | _nStarParams |
LOG_LOGGER | _log |
Base class for fitters.
Implements minimize and findOutliers. Chi2, residual, derivative, etc. calculations must be implemented in the child class via the virtual methods.
Definition at line 53 of file FitterBase.h.
|
inlineexplicit |
Definition at line 55 of file FitterBase.h.
|
delete |
No copy or move: there is only ever one fitter of a given type.
|
delete |
|
virtualdefault |
|
protectedpure virtual |
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for measurements.
|
protectedpure virtual |
Compute the chi2 (per star or total, depending on which Chi2Accumulator is used) for RefStars.
|
pure virtual |
Set parameters to fit and assign indices in the big matrix.
[in] | whatToFit | See child class documentation for valid string values. |
Implemented in lsst::jointcal::PhotometryFit, and lsst::jointcal::AstrometryFit.
Chi2Statistic lsst::jointcal::FitterBase::computeChi2 | ( | ) | const |
Returns the chi2 for the current state.
Definition at line 42 of file FitterBase.cc.
|
protected |
Find Measurements and references contributing more than a cut, computed as.
\[ <chi2> + nSigmaCut + rms(chi2). \]
The outliers are NOT removed, and no refit is done.
After returning from here, there are still measurements that contribute above the cut, but their contribution should be evaluated after a refit before discarding them.
[in] | nSigmaCut | Number of sigma to select on. |
[out] | msOutliers | list of MeasuredStar outliers to populate |
[out] | fsOutliers | list of FittedStar outliers to populate |
[out] | cut | value of chi2 that defines which objects are outliers |
Definition at line 52 of file FitterBase.cc.
|
protectedpure virtual |
Set the indices of a measured star from the full matrix, for outlier removal.
void lsst::jointcal::FitterBase::leastSquareDerivatives | ( | TripletList & | tripletList, |
Eigen::VectorXd & | grad | ||
) | const |
Evaluates the chI^2 derivatives (Jacobian and gradient) for the current whatToFit setting.
The Jacobian is given as triplets in a sparse matrix, the gradient as a dense vector. The parameters which vary, and their indices, are to be set using assignIndices.
tripletList | tripletList of (row,col,value) representing the Jacobian of the chi2. |
grad | The gradient of the chi2. |
Definition at line 344 of file FitterBase.cc.
|
protectedpure virtual |
Compute the derivatives of the measured stars and model for one CcdImage.
The last argument will process a sub-list for outlier removal.
|
protectedpure virtual |
Compute the derivatives of the reference terms.
MinimizeResult lsst::jointcal::FitterBase::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.
This is a complete Newton Raphson step. Compute first and second derivatives, solve for the step and apply it, with an optional line search.
It calls assignIndices, leastSquareDerivatives, solves the linear system and calls offsetParams, then removes outliers in a loop if requested. Relies on sparse linear algebra via Eigen's CholmodSupport package.
[in] | whatToFit | See child method assignIndices for valid string values. |
[in] | nSigmaCut | How many sigma to reject outliers at. Outlier rejection ignored for nSigmaCut=0. |
[in] | sigmaRelativeTolerance | Percentage change in the chi2 cut for outliers tolerated for termination. If value is zero, minimization iterations will continue until there are no outliers. |
[in] | doRankUpdate | Use CholmodSimplicialLDLT2.update() to do a fast rank update after outlier removal; otherwise do a slower full recomputation of the matrix. Only matters if nSigmaCut != 0. |
[in] | doLineSearch | Use boost's brent_find_minima to perform a line search after the gradient solution is found, and apply the scale factor to the computed offsets. The line search is done in the domain [-1, 2], but if the scale factor is far from 1.0, then the problem is likely in a significantly non-linear regime. |
[in] | dumpMatrixFile | Write the pre-fit Hessian matrix and gradient to the files with "-mat.txt" and "-grad.txt". Be aware, this requires a large increase in memory usage to create a dense matrix before writing it; the output file may be large. Writing the matrix can be helpful for debugging bad fits. Read it and compute the real eigenvalues (recall that the Hessian is symmetric by construction) with numpy: hessian = np.matrix(np.loadtxt("dumpMatrixFile-mat.txt"))
values, vectors = np.linalg.eigh(hessian)
|
Definition at line 178 of file FitterBase.cc.
|
pure virtual |
Offset the parameters by the requested quantities.
The used parameter layout is the one from the last call to assignIndices or minimize(). There is no easy way to check that the current setting of whatToFit and the provided Delta vector are compatible: we can only test the size.
[in] | delta | vector of offsets to apply |
Implemented in lsst::jointcal::PhotometryFit, and lsst::jointcal::AstrometryFit.
|
delete |
|
delete |
|
protected |
Contributions to derivatives from (presumably) outlier terms.
No discarding done.
Definition at line 319 of file FitterBase.cc.
|
protected |
Remove measuredStar outliers from the fit. No Refit done.
Definition at line 330 of file FitterBase.cc.
|
protected |
Remove refStar outliers from the fit. No Refit done.
Definition at line 338 of file FitterBase.cc.
|
virtual |
Save the full chi2 term per star that was used in the minimization, for debugging.
Saves results to text files "baseName-meas.csv" and "baseName-ref.csv" for the MeasuredStar and RefStar contributions, respectively. This method is mostly useful for debugging: we will probably want to create a better persistence system for jointcal's internal representations in the future (see DM-12446).
Definition at line 352 of file FitterBase.cc.
|
protectedpure virtual |
Save a CSV file containing residuals of measurement terms.
Implemented in lsst::jointcal::PhotometryFit, and lsst::jointcal::AstrometryFit.
|
protectedpure virtual |
Save a CSV file containing residuals of reference terms.
Implemented in lsst::jointcal::PhotometryFit, and lsst::jointcal::AstrometryFit.
|
protected |
Definition at line 163 of file FitterBase.h.
|
protected |
Definition at line 166 of file FitterBase.h.
|
protected |
Definition at line 172 of file FitterBase.h.
|
protected |
Definition at line 168 of file FitterBase.h.
|
protected |
Definition at line 169 of file FitterBase.h.
|
protected |
Definition at line 167 of file FitterBase.h.
|
protected |
Definition at line 164 of file FitterBase.h.