WcsMap.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2017 AURA/LSST.
 *
 * 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 <https://www.lsstcorp.org/LegalNotices/>.
 */
#ifndef ASTSHIM_WCSMAP_H
#define ASTSHIM_WCSMAP_H

#include <memory>
#include <sstream>
#include <utility>

#include "astshim/base.h"
#include "astshim/detail/utils.h"
#include "astshim/Mapping.h"

namespace ast {

enum class WcsType {
    AZP = AST__AZP,
    SZP = AST__SZP,
    TAN = AST__TAN,
    STG = AST__STG,
    SIN = AST__SIN,
    ARC = AST__ARC,
    ZPN = AST__ZPN,
    ZEA = AST__ZEA,
    AIR = AST__AIR,
    CYP = AST__CYP,
    CEA = AST__CEA,
    CAR = AST__CAR,
    MER = AST__MER,
    SFL = AST__SFL,
    PAR = AST__PAR,
    MOL = AST__MOL,
    AIT = AST__AIT,
    COP = AST__COP,
    COE = AST__COE,
    COD = AST__COD,
    COO = AST__COO,
    BON = AST__BON,
    PCO = AST__PCO,
    TSC = AST__TSC,
    CSC = AST__CSC,
    QSC = AST__QSC,
    NCP = AST__NCP,
    GLS = AST__GLS,
    TPN = AST__TPN,
    HPX = AST__HPX,
    XPH = AST__XPH,
    WCSBAD = AST__WCSBAD,
};

class WcsMap : public Mapping {
    friend class Object;

public:
    explicit WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options = "")
            : Mapping(reinterpret_cast<AstMapping *>(
                      astWcsMap(ncoord, static_cast<int>(type), lonax, latax, "%s", options.c_str()))) {
        assertOK();
    }

    virtual ~WcsMap() {}

    WcsMap(WcsMap const &) = default;
    WcsMap(WcsMap &&) = default;
    WcsMap &operator=(WcsMap const &) = delete;
    WcsMap &operator=(WcsMap &&) = default;

    std::shared_ptr<WcsMap> copy() const { return std::static_pointer_cast<WcsMap>(copyPolymorphic()); }

    double getNatLat() const { return getD("NatLat"); }

    double getNatLon() const { return getD("NatLon"); }

    double getPVi_m(int i, int m) const {
        std::stringstream os;
        os << "PV" << i << "_" << m;
        return getD(os.str());
    }

    int getPVMax(int axis) const { return getI(detail::formatAxisAttr("PVMax", axis)); }

    std::pair<int, int> getWcsAxis() const {
        return std::make_pair(getI(detail::formatAxisAttr("WcsAxis", 1)),
                              getI(detail::formatAxisAttr("WcsAxis", 2)));
    }

    WcsType getWcsType() const { return static_cast<WcsType>(getI("WcsType")); }

protected:
    virtual std::shared_ptr<Object> copyPolymorphic() const override {
        return copyImpl<WcsMap, AstWcsMap>();
    }

    explicit WcsMap(AstWcsMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
        if (!astIsAWcsMap(getRawPtr())) {
            std::ostringstream os;
            os << "this is a " << getClassName() << ", which is not a WcsMap";
            throw std::invalid_argument(os.str());
        }
    }
};

}  // namespace ast

#endif