SkyFrame.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_SKYFRAME_H
#define ASTSHIM_SKYFRAME_H

#include <memory>
#include <vector>

#include "astshim/Frame.h"

namespace ast {

class SkyFrame : public Frame {
    friend class Object;

public:
    explicit SkyFrame(std::string const &options = "")
            : Frame(reinterpret_cast<AstFrame *>(astSkyFrame("%s", options.c_str()))) {}

    virtual ~SkyFrame() {}

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

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

    bool getAlignOffset() const { return getB("AlignOffset"); }

    bool getAsTime(int axis) const { return getB(detail::formatAxisAttr("AsTime", axis)); }

    double getEquinox() const { return getD("Equinox"); }

    bool getIsLatAxis(int axis) const { return getB(detail::formatAxisAttr("IsLatAxis", axis)); }

    bool getIsLonAxis(int axis) const { return getB(detail::formatAxisAttr("IsLonAxis", axis)); }

    int getLatAxis() const { return getI("LatAxis"); }

    int getLonAxis() const { return getI("LonAxis"); }

    bool getNegLon() const { return getB("NegLon"); }

    std::string getProjection() const { return getC("Projection"); }

    std::vector<double> getSkyRef() const {
        std::vector<double> ret;
        for (int axis = 1; axis < 3; ++axis) {
            ret.push_back(getD(detail::formatAxisAttr("SkyRef", axis)));
        }
        return ret;
    }

    std::string getSkyRefIs() const { return getC("SkyRefIs"); }

    std::vector<double> getSkyRefP() const {
        std::vector<double> ret;
        for (int axis = 1; axis < 3; ++axis) {
            ret.push_back(getD(detail::formatAxisAttr("SkyRefP", axis)));
        }
        return ret;
    }

    double getSkyTol() const { return getD("SkyTol"); }

    void setAlignOffset(bool alignOffset) { setB("AlignOffset", alignOffset); }

    void setAsTime(int axis, bool asTime) { setB(detail::formatAxisAttr("AsTime", axis), asTime); }

    void setEquinox(double equinox) { setD("Equinox", equinox); }

    void setNegLon(bool negLon) { setB("NegLon", negLon); }

    void setProjection(std::string const &projection) { setC("Projection", projection); }

    void setSkyRef(std::vector<double> const &skyRef) {
        detail::assertEqual(skyRef.size(), "skyRef length", 2u, "number of axes");
        for (int i = 0; i < 2; ++i) {
            setD(detail::formatAxisAttr("SkyRef", i + 1), skyRef[i]);
        }
    }

    void setSkyRefIs(std::string const &skyRefIs) { setC("SkyRefIs", skyRefIs); }

    void setSkyRefP(std::vector<double> const &skyRefP) {
        detail::assertEqual(skyRefP.size(), "skyRefP length", 2u, "number of axes");
        for (int i = 0; i < 2; ++i) {
            setD(detail::formatAxisAttr("SkyRefP", i + 1), skyRefP[i]);
        }
    }

    void setSkyTol(double skyTol) { setD("SkyTol", skyTol); }

    std::shared_ptr<Mapping> skyOffsetMap() {
        auto *rawMap = reinterpret_cast<AstObject *>(astSkyOffsetMap(getRawPtr()));
        return Object::fromAstObject<Mapping>(rawMap, false);
    }

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

    explicit SkyFrame(AstSkyFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
        if (!astIsASkyFrame(getRawPtr())) {
            std::ostringstream os;
            os << "this is a " << getClassName() << ", which is not a SkyFrame";
            throw std::invalid_argument(os.str());
        }
    }
};

}  // namespace ast

#endif