ConstrainedPhotometryModel.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_CONSTRAINED_PHOTOMETRY_MODEL_H
#define LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H

#include <map>

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

namespace lsst {
namespace jointcal {

class ConstrainedPhotometryModel : public PhotometryModel {
public:
    explicit ConstrainedPhotometryModel(CcdImageList const &ccdImageList,
                                        afw::geom::Box2D const &focalPlaneBBox, LOG_LOGGER log,
                                        int visitOrder = 7, double errorPedestal_ = 0)
            : PhotometryModel(log, errorPedestal_), _fittingChips(false), _fittingVisits(false) {
        _chipVisitMap.reserve(ccdImageList.size());
    }

    ConstrainedPhotometryModel(ConstrainedPhotometryModel const &) = delete;
    ConstrainedPhotometryModel(ConstrainedPhotometryModel &&) = delete;
    ConstrainedPhotometryModel &operator=(ConstrainedPhotometryModel const &) = delete;
    ConstrainedPhotometryModel &operator=(ConstrainedPhotometryModel &&) = 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:
    PhotometryMappingBase *findMapping(CcdImage const &ccdImage) const override;

    /* The per-ccdImage transforms, each of which is a composition of a chip and visit transform.
     * Not all pairs of _visitMap[visit] and _chipMap[chip] are guaranteed to have an entry in
     * _chipVisitMap (for example, one ccd in one visit might fail to produce a catalog).
     */
    typedef std::unordered_map<CcdImageKey, std::unique_ptr<ChipVisitPhotometryMapping>> MapType;
    MapType _chipVisitMap;

    // The per-visit transforms that go into _chipVisitMap.
    typedef std::map<VisitIdType, std::shared_ptr<PhotometryMapping>> VisitMapType;
    VisitMapType _visitMap;
    // The per-chip transforms that go into _chipVisitMap.
    typedef std::map<CcdIdType, std::shared_ptr<PhotometryMapping>> ChipMapType;
    ChipMapType _chipMap;

    template <class ChipTransform, class VisitTransform, class ChipVisitMapping>
    void initialize(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder);

    virtual double initialChipCalibration(std::shared_ptr<afw::image::PhotoCalib const> photoCalib) = 0;

    struct PrepPhotoCalib {
        double chipConstant;
        afw::geom::TransformPoint2ToGeneric visitTransform;
        std::shared_ptr<afw::geom::TransformPoint2ToPoint2> pixToFocal;
        double visitMean;
    };

    PrepPhotoCalib prepPhotoCalib(CcdImage const &ccdImage) const;

private:
    // Which components of the model are we fitting currently?
    bool _fittingChips;
    bool _fittingVisits;
};

class ConstrainedFluxModel : public ConstrainedPhotometryModel {
public:
    explicit ConstrainedFluxModel(CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox,
                                  int visitOrder = 7, double errorPedestal_ = 0)
            : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
                                         LOG_GET("jointcal.ConstrainedFluxModel"), visitOrder,
                                         errorPedestal_) {
        initialize<FluxTransformSpatiallyInvariant, FluxTransformChebyshev, ChipVisitFluxMapping>(
                ccdImageList, focalPlaneBBox, visitOrder);
    }

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

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

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

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

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

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

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

protected:
    double initialChipCalibration(std::shared_ptr<afw::image::PhotoCalib const> photoCalib) override {
        return photoCalib->getCalibrationMean();
    }
};

class ConstrainedMagnitudeModel : public ConstrainedPhotometryModel {
public:
    explicit ConstrainedMagnitudeModel(CcdImageList const &ccdImageList,
                                       afw::geom::Box2D const &focalPlaneBBox, int visitOrder = 7,
                                       double errorPedestal_ = 0)
            : ConstrainedPhotometryModel(ccdImageList, focalPlaneBBox,
                                         LOG_GET("jointcal.ConstrainedMagnitudeModel"), visitOrder,
                                         errorPedestal_) {
        initialize<MagnitudeTransformSpatiallyInvariant, MagnitudeTransformChebyshev,
                   ChipVisitMagnitudeMapping>(ccdImageList, focalPlaneBBox, visitOrder);
    }

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

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

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

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

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

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

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

protected:
    double initialChipCalibration(std::shared_ptr<afw::image::PhotoCalib const> photoCalib) override {
        return utils::nanojanskyToABMagnitude(photoCalib->getCalibrationMean());
    }
};

}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_CONSTRAINED_PHOTOMETRY_MODEL_H