Mapping.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_MAPPING_H
#define ASTSHIM_MAPPING_H

#include <memory>
#include <vector>

#include "ndarray.h"

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

namespace ast {

class ParallelMap;
class SeriesMap;

class Mapping : public Object {
    friend class Object;

public:
    virtual ~Mapping() {}

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

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

    int getNIn() const { return getI("NIn"); }

    int getNOut() const { return getI("NOut"); }

    bool getIsSimple() const { return getI("IsSimple"); }

    bool isInverted() const { return getB("Invert"); }

    bool getIsLinear() const { return getB("IsLinear"); }

    bool getReport() const { return getB("Report"); }

    bool hasForward() const { return getB("TranForward"); }

    bool hasInverse() const { return getB("TranInverse"); }

    std::shared_ptr<Mapping> inverted() const;

    Array2D linearApprox(PointD const &lbnd, PointD const &ubnd, double tol) const;

    SeriesMap then(Mapping const &next) const;

    ParallelMap under(Mapping const &next) const;

    double rate(PointD const &at, int ax1, int ax2) const {
        detail::assertEqual(at.size(), "at.size", static_cast<std::size_t>(getNIn()), "nIn");
        double result = astRate(getRawPtr(), const_cast<double *>(at.data()), ax1, ax2);
        assertOK();
        return result;
    }

    void setReport(bool report) { setB("Report", report); }

    std::shared_ptr<Mapping> simplified() const {
        AstObject *rawSimpMap = reinterpret_cast<AstObject *>(astSimplify(getRawPtr()));
        assertOK(rawSimpMap);
        return Object::fromAstObject<Mapping>(rawSimpMap, true);
    }

    void applyForward(ConstArray2D const &from, Array2D const &to) const { _tran(from, true, to); }

    Array2D applyForward(ConstArray2D const &from) const {
        Array2D to = ndarray::allocate(getNOut(), from.getSize<1>());
        _tran(from, true, to);
        return to;
    }

    std::vector<double> applyForward(std::vector<double> const &from) const {
        auto fromArr = arrayFromVector(from, getNIn());
        std::vector<double> to(fromArr.getSize<1>() * getNOut());
        auto toArr = arrayFromVector(to, getNOut());
        _tran(fromArr, true, toArr);
        return to;
    }

    void applyInverse(ConstArray2D const &from, Array2D const &to) const { _tran(from, false, to); }

    Array2D applyInverse(ConstArray2D const &from) const {
        Array2D to = ndarray::allocate(getNIn(), from.getSize<1>());
        _tran(from, false, to);
        return to;
    }

    std::vector<double> applyInverse(std::vector<double> const &from) const {
        auto fromArr = arrayFromVector(from, getNOut());
        std::vector<double> to(fromArr.getSize<1>() * getNIn());
        auto toArr = arrayFromVector(to, getNIn());
        _tran(fromArr, false, toArr);
        return to;
    }

    void tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix,
                         Array2D const &to) const {
        _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
    }

    Array2D tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const {
        Array2D to = ndarray::allocate(nPts, getNOut());
        _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
        return to;
    }

    void tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix,
                         Array2D const &to) const {
        _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
    }

    Array2D tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const {
        Array2D to = ndarray::allocate(nPts, getNIn());
        _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
        return to;
    }

protected:
    explicit Mapping(AstMapping *rawMap) : Object(reinterpret_cast<AstObject *>(rawMap)) {
        assertOK();
        if (!astIsAMapping(getRawPtr())) {
            std::ostringstream os;
            os << "this is a " << getClassName() << ", which is not a Mapping";
            throw std::invalid_argument(os.str());
        }
    }

    // Protected implementation of deep-copy.
    virtual std::shared_ptr<Object> copyPolymorphic() const override {
        return std::static_pointer_cast<Mapping>(copyImpl<Mapping, AstMapping>());
    }

    template <typename Class>
    std::shared_ptr<Class> decompose(int i, bool copy) const;

private:
    void _tran(ConstArray2D const &from, bool doForward, Array2D const &to) const;

    void _tranGrid(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, bool doForward,
                   Array2D const &to) const;
};

}  // namespace ast

#endif