TanWcs.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_AFW_IMAGE_TANWCS_H
#define LSST_AFW_IMAGE_TANWCS_H

#include "Eigen/Core"
#include "lsst/daf/base/Citizen.h"
#include "lsst/daf/base/Persistable.h"
#include "lsst/afw/image/Image.h"
#include "lsst/afw/geom/AffineTransform.h"
#include "lsst/afw/image/Wcs.h"
#include "lsst/afw/geom/Point.h"
#include "lsst/afw/geom/Extent.h"

struct wcsprm;                          // defined in wcs.h

namespace lsst {
namespace daf {
    namespace base {
        class PropertySet;
    }
}
namespace afw {
    namespace formatters {
        class TanWcsFormatter;
    }
namespace image {

class TanWcs : public afw::table::io::PersistableFacade<TanWcs>, public lsst::afw::image::Wcs {
public:
    typedef std::shared_ptr<lsst::afw::image::TanWcs> Ptr;
    typedef std::shared_ptr<lsst::afw::image::TanWcs const> ConstPtr;

    static void decodeSipHeader(
        daf::base::PropertySet const & fitsMetadata,
        std::string const & which,
        Eigen::MatrixXd & m
    );

    TanWcs(
        geom::Point2D const & crval, geom::Point2D const & crpix,
        Eigen::Matrix2d const & cd,
        double equinox=2000, std::string const & raDecSys="FK5",
        std::string const & cunits1="deg", std::string const & cunits2="deg"
    );

    TanWcs(
        geom::Point2D const & crval, geom::Point2D const & crpix,
        Eigen::Matrix2d const & cd,
        Eigen::MatrixXd const & sipA,
        Eigen::MatrixXd const & sipB,
        Eigen::MatrixXd const & sipAp,
        Eigen::MatrixXd const & sipBp,
        double equinox=2000, std::string const & raDecSys="FK5",
        std::string const & cunits1="deg", std::string const & cunits2="deg"
    );

    virtual ~TanWcs() {};

    virtual PTR(Wcs) clone() const;

    geom::Angle pixelScale() const;

    // NOTE that this accepts and returns FITS-style 1-indexed pixel coords, NOT LSST style 0-indexed
    geom::Point2D distortPixel(geom::Point2D const & pixel) const;

    // NOTE that this accepts and returns FITS-style 1-indexed pixel coords, NOT LSST style 0-indexed
    geom::Point2D undistortPixel(geom::Point2D const & pixel) const;

    bool hasDistortion() const { return _hasDistortion;};

    PTR(daf::base::PropertyList) getFitsMetadata() const;


    void setDistortionMatrices(
        Eigen::MatrixXd const & sipA,
        Eigen::MatrixXd const & sipB,
        Eigen::MatrixXd const & sipAp,
        Eigen::MatrixXd const & sipBp
    );

    virtual bool isPersistable() const;

protected:

    TanWcs(TanWcs const & rhs);

    virtual void pixelToSkyImpl(double pixel1, double pixel2, geom::Angle skyTmp[2]) const;
    virtual geom::Point2D skyToPixelImpl(geom::Angle sky1, geom::Angle sky2) const;

private:

    friend PTR(Wcs) makeWcs(PTR(daf::base::PropertySet) const& metadata, bool);

    friend class TanWcsFactory;

    virtual std::string getPersistenceName() const;

    virtual void write(OutputArchiveHandle & handle) const;

    virtual bool _isSubset(Wcs const &) const;

    // Create an empty, invalid TanWcs.  Only used by TanWcsFormatter.
    TanWcs();

    /*
     *  Create a Wcs from a fits header.
     *
     *  Don't call this directly. Use makeWcs() instead, which will figure out which (if any)
     *  sub-class of Wcs is appropriate.
     */
    TanWcs(CONST_PTR(daf::base::PropertySet) const & fitsMetadata);

    TanWcs(afw::table::BaseRecord const & mainRecord, CONST_PTR(afw::table::BaseRecord) sipRecord);

    TanWcs & operator = (const TanWcs &);

    //Allow the formatter to access private goo
    LSST_PERSIST_FORMATTER(lsst::afw::formatters::TanWcsFormatter)

    bool _hasDistortion;
    Eigen::MatrixXd _sipA, _sipB, _sipAp, _sipBp;

};

}}} // namespace lsst::afw::image

#endif