FitterBase.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of jointcal.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_JOINTCAL_FITTER_BASE_H
#define LSST_JOINTCAL_FITTER_BASE_H
 
#include <utility>
 
#include "lsst/log/Log.h"
#include "lsst/jointcal/Associations.h"
#include "lsst/jointcal/CcdImage.h"
#include "lsst/jointcal/Chi2.h"
#include "lsst/jointcal/FittedStar.h"
#include "lsst/jointcal/MeasuredStar.h"
#include "lsst/jointcal/Tripletlist.h"
 
namespace lsst {
namespace jointcal {

enum class MinimizeResult {
    Converged,      // fit has converged - no more outliers
    Chi2Increased,  // still some ouliers but chi2 increases
    Failed,         // factorization failed
    NonFinite       // non-finite chi2 statistic
};

class FitterBase {
public:
    explicit FitterBase(std::shared_ptr<Associations> associations)
            : _associations(std::move(associations)),
              _whatToFit(""),
              _lastNTrip(0),
              _nTotal(0),
              _nModelParams(0),
              _nStarParams(0) {}

    FitterBase(FitterBase const &) = delete;
    FitterBase(FitterBase &&) = delete;
    FitterBase &operator=(FitterBase const &) = delete;
    FitterBase &operator=(FitterBase &&) = delete;

    MinimizeResult minimize(std::string const &whatToFit, double nSigmaCut = 0, 
                            double sigmaRelativeTolerance = 0, bool doRankUpdate = true,
                            bool doLineSearch = false, std::string const &dumpMatrixFile = "");

    Chi2Statistic computeChi2() const;

    void leastSquareDerivatives(TripletList &tripletList, Eigen::VectorXd &grad) const;

    virtual void offsetParams(Eigen::VectorXd const &delta) = 0;

    virtual void assignIndices(std::string const &whatToFit) = 0;

    virtual void saveChi2Contributions(std::string const &baseName) const;
 
    virtual ~FitterBase() = default;
 
protected:
    std::shared_ptr<Associations> _associations;
    std::string _whatToFit;
 
    Eigen::Index _lastNTrip;     // last triplet count, used to speed up allocation
    Eigen::Index _nTotal;        // Total number of parameters being fit.
    Eigen::Index _nModelParams;  // Number of model parameters that are being fit.
    Eigen::Index _nStarParams;   // Number of star positions/fluxes that are being fit.
 
    // lsst.logging instance, to be created by subclass so that messages have consistent name while fitting.
    LOG_LOGGER _log;

    virtual void saveChi2MeasContributions(std::string const &filename) const = 0;

    virtual void saveChi2RefContributions(std::string const &filename) const = 0;

    std::size_t findOutliers(double nSigmaCut, MeasuredStarList &msOutliers,
                             FittedStarList &fsOutliers, double &cut) const;

    void outliersContributions(MeasuredStarList &msOutliers, FittedStarList &fsOutliers,
                               TripletList &tripletList, Eigen::VectorXd &grad);

    void removeMeasOutliers(MeasuredStarList &outliers);

    void removeRefOutliers(FittedStarList &outliers);

    virtual void getIndicesOfMeasuredStar(MeasuredStar const &measuredStar, IndexVector &indices) const = 0;

    virtual void accumulateStatImageList(CcdImageList const &ccdImageList, Chi2Accumulator &accum) const = 0;

    virtual void accumulateStatRefStars(Chi2Accumulator &accum) const = 0;

    virtual void leastSquareDerivativesMeasurement(
            CcdImage const &ccdImage, TripletList &tripletList, Eigen::VectorXd &grad,
            MeasuredStarList const *measuredStarList = nullptr) const = 0;

    virtual void leastSquareDerivativesReference(FittedStarList const &fittedStarList,
                                                 TripletList &tripletList, Eigen::VectorXd &grad) const = 0;
 
private:
    double _lineSearch(Eigen::VectorXd const &delta);
};
}  // namespace jointcal
}  // namespace lsst
#endif  // LSST_JOINTCAL_FITTER_BASE_H