PhotometryModel.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_PHOTOMETRY_MODEL_H
#define LSST_JOINTCAL_PHOTOMETRY_MODEL_H

#include <string>
#include <vector>

#include "lsst/afw/image/PhotoCalib.h"
#include "lsst/log/Log.h"

#include "lsst/jointcal/CcdImage.h"
#include "lsst/jointcal/Eigenstuff.h"
#include "lsst/jointcal/PhotometryMapping.h"
#include "lsst/jointcal/FittedStar.h"
#include "lsst/jointcal/MeasuredStar.h"
#include "lsst/jointcal/RefStar.h"

namespace lsst {
namespace jointcal {

class PhotometryModel {
public:
    PhotometryModel(LOG_LOGGER log, double errorPedestal_ = 0) : _log(log), errorPedestal(errorPedestal_) {}

    virtual Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) = 0;

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

    virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const = 0;

    virtual double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;

    virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;

    virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const = 0;

    virtual void freezeErrorTransform() = 0;

    virtual void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const = 0;

    virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage,
                                             Eigen::VectorXd &derivatives) const = 0;

    virtual double getRefError(RefStar const &refStar) const = 0;

    virtual double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const = 0;

    virtual std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const = 0;

    std::size_t getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }

    PhotometryMappingBase const &getMapping(CcdImage const &ccdImage) const {
        return *(findMapping(ccdImage));
    }

    virtual std::size_t getTotalParameters() const = 0;

    virtual void dump(std::ostream &stream = std::cout) const = 0;

    bool validate(CcdImageList const &ccdImageList, int ndof) const;

    bool checkPositiveOnBBox(CcdImage const &ccdImage) const;

    friend std::ostream &operator<<(std::ostream &s, PhotometryModel const &model) {
        model.dump(s);
        return s;
    }

    double getErrorPedestal() { return errorPedestal; }

    double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const {
        if (errorPedestal == 0) {
            return measuredStar.getInstFluxErr();
        } else {
            return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
        }
    }

    double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const {
        if (errorPedestal == 0) {
            return measuredStar.getInstMagErr();
        } else {
            return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
        }
    }

protected:
    virtual PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const = 0;

    LOG_LOGGER _log;

    // Pedestal on flux/magnitude error (percent of flux or delta magnitude)
    double errorPedestal;
};
}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_PHOTOMETRY_MODEL_H