AstrometryModel.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_ASTROMETRY_MODEL_H
#define LSST_JOINTCAL_ASTROMETRY_MODEL_H

#include "memory"

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

namespace lsst {
namespace jointcal {

class CcdImage;
class AstrometryTransform;

/* For an implementation example, see SimplePolyModel, and the comments at
the top of simplepolymodel.h */
class AstrometryModel {
public:
    int getNpar(CcdImage const &ccdImage) const { return findMapping(ccdImage)->getNpar(); }

    virtual const AstrometryMapping *getMapping(CcdImage const &) const = 0;

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

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


    virtual const std::shared_ptr<AstrometryTransform const> getSkyToTangentPlane(
            CcdImage const &ccdImage) const = 0;

    virtual std::shared_ptr<afw::geom::SkyWcs> makeSkyWcs(CcdImage const &ccdImage) const = 0;

    virtual void freezeErrorTransform() = 0;

    virtual int getTotalParameters() const = 0;

    virtual ~AstrometryModel(){};

    bool validate(CcdImageList const &ccdImageList) const { return true; }

protected:
    virtual AstrometryMapping *findMapping(CcdImage const &ccdImage) const = 0;
};
}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_ASTROMETRY_MODEL_H