SimplePhotometryModel.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_SIMPLE_PHOTOMETRY_MODEL_H
#define LSST_JOINTCAL_SIMPLE_PHOTOMETRY_MODEL_H

#include <map>

#include "lsst/jointcal/CcdImage.h"
#include "lsst/jointcal/Eigenstuff.h"
#include "lsst/jointcal/PhotometryMapping.h"
#include "lsst/jointcal/PhotometryModel.h"
#include "lsst/jointcal/Point.h"

namespace lsst {
namespace jointcal {

class CcdImage;
class Point;

class SimplePhotometryModel : public PhotometryModel {
public:
    SimplePhotometryModel(CcdImageList const &ccdImageList, LOG_LOGGER log, double errorPedestal_ = 0)
            : PhotometryModel(log, errorPedestal_) {
        _myMap.reserve(ccdImageList.size());
    }

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

    Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) override;

    void offsetParams(Eigen::VectorXd const &delta) override;

    void freezeErrorTransform() override;

    void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override;

    std::size_t getTotalParameters() const override;

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

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

protected:
    typedef std::unordered_map<CcdImageKey, std::unique_ptr<PhotometryMapping>> MapType;
    MapType _myMap;

    PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;
};

class SimpleFluxModel : public SimplePhotometryModel {
public:
    SimpleFluxModel(CcdImageList const &ccdImageList, double errorPedestal_ = 0);

    void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
        fittedStar.getFlux() -= delta;
    }

    double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double getRefError(RefStar const &refStar) const override { return refStar.getFluxErr(); }

    double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
        return fittedStar.getFlux() - refStar.getFlux();
    };

    std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
};

class SimpleMagnitudeModel : public SimplePhotometryModel {
public:
    SimpleMagnitudeModel(CcdImageList const &ccdImageList, double errorPedestal_ = 0);

    void offsetFittedStar(FittedStar &fittedStar, double delta) const override {
        fittedStar.getMag() -= delta;
    }

    double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override;

    double getRefError(RefStar const &refStar) const override { return refStar.getMagErr(); }

    double computeRefResidual(FittedStar const &fittedStar, RefStar const &refStar) const override {
        return fittedStar.getMag() - refStar.getMag();
    };

    std::shared_ptr<afw::image::PhotoCalib> toPhotoCalib(CcdImage const &ccdImage) const override;
};

}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_SIMPLE_PHOTOMETRY_MODEL_H