SimpleAstrometryMapping.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_ASTROMETRY_MAPPING_H
#define LSST_JOINTCAL_SIMPLE_ASTROMETRY_MAPPING_H

#include <memory>  // for unique_ptr

#include "lsst/jointcal/AstrometryMapping.h"
#include "lsst/jointcal/AstrometryTransform.h"
#include "lsst/jointcal/CcdImage.h"


namespace lsst {
namespace jointcal {

class SimpleAstrometryMapping : public AstrometryMapping {
public:
    SimpleAstrometryMapping(AstrometryTransform const &astrometryTransform, bool toBeFit = true)
            : toBeFit(toBeFit),
              transform(astrometryTransform.clone()),
              errorProp(transform),
              lin(new AstrometryTransformLinear) {
        // in this order:
        // take a copy of the input transform,
        // assign the transformation used to propagate errors to the transform itself
        // reserve some memory space to compute the derivatives (efficiency).
    }

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

    virtual void freezeErrorTransform() {
        // from there on, updating the transform does not change the errors.
        errorProp = transform->clone();
    }

    // interface Mapping functions:

    std::size_t getNpar() const {
        if (toBeFit)
            return transform->getNpar();
        else
            return 0;
    }

    void getMappingIndices(IndexVector &indices) const {
        if (indices.size() < getNpar()) indices.resize(getNpar());
        for (std::size_t k = 0; k < getNpar(); ++k) indices[k] = index + k;
    }

    void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const {
        transform->transformPosAndErrors(where, outPoint);
        FatPoint tmp;
        errorProp->transformPosAndErrors(where, tmp);
        outPoint.vx = tmp.vx;
        outPoint.vy = tmp.vy;
        outPoint.vxy = tmp.vxy;
    }

    void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const {
        errorProp->computeDerivative(where, *lin, epsilon);
        derivative(0, 0) = lin->coeff(1, 0, 0);
        //
        /* This does not work : it was proved by rotating the frame
           see the compilation switch ROTATE_T2 in constrainedAstrometryModel.cc
        derivative(1,0) = lin->coeff(1,0,1);
        derivative(0,1) = lin->coeff(0,1,0);
        */
        derivative(1, 0) = lin->coeff(0, 1, 0);
        derivative(0, 1) = lin->coeff(1, 0, 1);
        derivative(1, 1) = lin->coeff(0, 1, 1);
    }

    void offsetParams(Eigen::VectorXd const &delta) {
        if (toBeFit) transform->offsetParams(delta);
    }

    Eigen::Index getIndex() const { return index; }

    void setIndex(Eigen::Index i) { index = i; }

    virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
                                                Eigen::MatrixX2d &H) const {
        transformPosAndErrors(where, outPoint);
        transform->paramDerivatives(where, &H(0, 0), &H(0, 1));
    }

    virtual AstrometryTransform const &getTransform() const { return *transform; }

    bool getToBeFit() const { return toBeFit; }
    void setToBeFit(bool value) { toBeFit = value; }

protected:
    // Whether this Mapping is fit as part of a Model.
    bool toBeFit;
    Eigen::Index index;
    /* inheritance may also work. Perhaps with some trouble because
       some routines in Mapping and AstrometryTransform have the same name */
    std::shared_ptr<AstrometryTransform> transform;

    std::shared_ptr<AstrometryTransform> errorProp;
    /* to avoid allocation at every call of positionDerivative.
       use a pointer for constness */
    std::unique_ptr<AstrometryTransformLinear> lin;
};

class SimplePolyMapping : public SimpleAstrometryMapping {
public:
    ~SimplePolyMapping() {}

    // ! contructor.
    SimplePolyMapping(AstrometryTransformLinear const &CenterAndScale,
                      AstrometryTransformPolynomial const &transform)
            : SimpleAstrometryMapping(transform), _centerAndScale(CenterAndScale) {
        // We assume that the initialization was done properly, for example that
        // transform = pixToTangentPlane*CenterAndScale.inverted(), so we do not touch transform.
        /* store the (spatial) derivative of _centerAndScale. For the extra
           diagonal terms, just copied the ones in positionDerivatives */
        preDer(0, 0) = _centerAndScale.coeff(1, 0, 0);
        preDer(1, 0) = _centerAndScale.coeff(0, 1, 0);
        preDer(0, 1) = _centerAndScale.coeff(1, 0, 1);
        preDer(1, 1) = _centerAndScale.coeff(0, 1, 1);

        // check of matrix indexing (once for all)
        MatrixX2d H(3, 2);
        assert((&H(1, 0) - &H(0, 0)) == 1);
    }

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

    /* The SimpleAstrometryMapping version does not account for the
       _centerAndScale transform */

    void positionDerivative(Point const &where, Eigen::Matrix2d &derivative, double epsilon) const {
        Point tmp = _centerAndScale.apply(where);
        errorProp->computeDerivative(tmp, *lin, epsilon);
        derivative(0, 0) = lin->coeff(1, 0, 0);
        //
        /* This does not work : it was proved by rotating the frame
           see the compilation switch ROTATE_T2 in constrainedAstrometryModel.cc
        derivative(1,0) = lin->coeff(1,0,1);
        derivative(0,1) = lin->coeff(0,1,0);
        */
        derivative(1, 0) = lin->coeff(0, 1, 0);
        derivative(0, 1) = lin->coeff(1, 0, 1);
        derivative(1, 1) = lin->coeff(0, 1, 1);
        derivative = preDer * derivative;
    }

    /* We should put the computation of error propagation and
       parameter derivatives into the same AstrometryTransform routine because
       it could be significantly faster */
    virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
                                                Eigen::MatrixX2d &H) const {
        FatPoint mid;
        _centerAndScale.transformPosAndErrors(where, mid);
        transform->transformPosAndErrors(mid, outPoint);
        FatPoint tmp;
        errorProp->transformPosAndErrors(mid, tmp);
        outPoint.vx = tmp.vx;
        outPoint.vy = tmp.vy;
        outPoint.vxy = tmp.vxy;
        transform->paramDerivatives(mid, &H(0, 0), &H(0, 1));
    }

    void transformPosAndErrors(FatPoint const &where, FatPoint &outPoint) const {
        FatPoint mid;
        _centerAndScale.transformPosAndErrors(where, mid);
        transform->transformPosAndErrors(mid, outPoint);
        FatPoint tmp;
        errorProp->transformPosAndErrors(mid, tmp);
        outPoint.vx = tmp.vx;
        outPoint.vy = tmp.vy;
        outPoint.vxy = tmp.vxy;
    }

    AstrometryTransform const &getTransform() const {
        // Cannot fail given the contructor:
        const AstrometryTransformPolynomial *fittedPoly =
                dynamic_cast<const AstrometryTransformPolynomial *>(&(*transform));
        actualResult = (*fittedPoly) * _centerAndScale;
        return actualResult;
    }

private:
    /* to better condition the 2nd derivative matrix, the
    transformed coordinates are mapped (roughly) on [-1,1].
    We need both the transform and its derivative. */
    AstrometryTransformLinear _centerAndScale;
    Eigen::Matrix2d preDer;

    /* Where we store the combination. */
    mutable AstrometryTransformPolynomial actualResult;
};

#ifdef STORAGE

class SimpleIdentityMapping : public SimpleAstrometryMapping<AstrometryTransformIdentity> {
public:
    virtual void computeTransformAndDerivatives(FatPoint const &where, FatPoint &outPoint,
                                                Eigen::MatrixX2d &H) const {
        outPoint = where;
    }
};
#endif
}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_SIMPLE_ASTROMETRY_MAPPING_H