Point.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_GEOM_POINT_H
#define LSST_AFW_GEOM_POINT_H

#include <tuple>

#include "lsst/afw/geom/CoordinateBase.h"
#include "lsst/afw/geom/CoordinateExpr.h"
#include "lsst/afw/geom/Extent.h"

namespace lsst { namespace afw { namespace geom {

template <typename T, int N>
class PointBase : public CoordinateBase<Point<T,N>,T,N> {
    typedef CoordinateBase<Point<T,N>,T,N> Super;
public:

    bool operator==(Point<T,N> const & other) const { return all(this->eq(other)); }

    bool operator!=(Point<T,N> const & other) const { return any(this->ne(other)); }

    CoordinateExpr<N> eq(Point<T,N> const & other) const;
    CoordinateExpr<N> ne(Point<T,N> const & other) const;
    CoordinateExpr<N> lt(Point<T,N> const & other) const;
    CoordinateExpr<N> le(Point<T,N> const & other) const;
    CoordinateExpr<N> gt(Point<T,N> const & other) const;
    CoordinateExpr<N> ge(Point<T,N> const & other) const;
    CoordinateExpr<N> eq(T scalar) const { return this->eq(Point<T,N>(scalar)); }
    CoordinateExpr<N> ne(T scalar) const { return this->ne(Point<T,N>(scalar)); }
    CoordinateExpr<N> lt(T scalar) const { return this->lt(Point<T,N>(scalar)); }
    CoordinateExpr<N> le(T scalar) const { return this->le(Point<T,N>(scalar)); }
    CoordinateExpr<N> gt(T scalar) const { return this->gt(Point<T,N>(scalar)); }
    CoordinateExpr<N> ge(T scalar) const { return this->ge(Point<T,N>(scalar)); }

    Extent<T,N> operator-(Point<T,N> const & other) const {
        return Extent<T,N>(this->_vector - other._vector);
    }
    Point<T,N> operator+(Extent<T,N> const & other) const {
        return Point<T,N>(this->_vector + other.asEigen());
    }
    Point<T,N> operator-(Extent<T,N> const & other) const {
        return Point<T,N>(this->_vector - other.asEigen());
    }
    Point<T,N> & operator+=(Extent<T,N> const & other) {
        this->_vector += other.asEigen();
        return static_cast<Point<T,N> &>(*this);
    }
    Point<T,N> & operator-=(Extent<T,N> const & other) {
        this->_vector -= other.asEigen();
        return static_cast<Point<T,N> &>(*this);
    }

    Extent<T,N> asExtent() const { return Extent<T,N>(static_cast<Point<T,N> const &>(*this)); }

    void shift(Extent<T,N> const & offset) { this->_vector += offset.asEigen(); }


    void scale(double factor) { this->_vector *= factor; }

    double distanceSquared(PointBase<T,N> const & other) const {
        // the cast to double is lame but Eigen seems to require they be the same type
        return (this->asEigen() - other.asEigen()).squaredNorm();
    }

    std::string toString() const {
        std::stringstream out;
        out << "Point(";
        for (size_t i = 0; i < N; ++i) {
            if (i != 0) {
                out << ",";
            }
            out << (*this)[i];
        }
        out << ")";
        return out.str();
    }

protected:

    explicit PointBase(T val = static_cast<T>(0)) : Super(val) {}

    template <typename Vector>
    explicit PointBase(Eigen::MatrixBase<Vector> const & vector) : Super(vector) {}
};

template<typename T, int N>
class Point : public PointBase<T,N> {
    typedef PointBase<T,N> Super;
public:
    typedef typename Super::EigenVector EigenVector;

    explicit Point(T val=static_cast<T>(0)) : Super(val) {}

    template <typename U>
    explicit Point(Point<U,N> const & other);

    explicit Point(EigenVector const & vector) : Super(vector) {}

    explicit Point(Extent<T,N> const & other) : Super(other.asEigen()) {}

    void swap(Point & other) { this->_swap(other); }
};

template<typename T>
class Point<T,2> : public PointBase<T,2> {
    typedef PointBase<T,2> Super;
public:
    typedef typename Super::EigenVector EigenVector;

    explicit Point(T val=static_cast<T>(0)) : Super(val) {}

    template <typename U>
    explicit Point(Point<U,2> const & other);

    explicit Point(EigenVector const & vector) : Super(vector) {}

    explicit Point(Extent<T,2> const & other) : Super(other.asEigen()) {}

    explicit Point(T x, T y) : Super(EigenVector(x,y)) {}

    explicit Point(T const xy[2]) : Super(EigenVector(xy[0], xy[1])) {}

    explicit Point(std::pair<T,T> const & xy) : Super(EigenVector(xy.first, xy.second)) {}

    explicit Point(std::tuple<T,T> const & xy) :
        Super(EigenVector(std::get<0>(xy), std::get<1>(xy))) {}

#ifdef SWIG
    T getX() const;
    T getY() const;
    void setX(T x);
    void setY(T y);
#endif

    void swap(Point & other) { this->_swap(other); }
};

template<typename T>
class Point<T,3> : public PointBase<T,3> {
    typedef PointBase<T,3> Super;
public:
    typedef typename Super::EigenVector EigenVector;

    explicit Point(T val=static_cast<T>(0)) : Super(val) {}

    template <typename U>
    explicit Point(Point<U,3> const & other);

    explicit Point(EigenVector const & vector) : Super(vector) {}

    explicit Point(Extent<T,3> const & other) : Super(other.asEigen()) {}

    explicit Point(T x, T y, T z) : Super(EigenVector(x,y,z)) {}

    explicit Point(T const xyz[3]) : Super(EigenVector(xyz[0], xyz[1], xyz[2])) {}

    explicit Point(std::tuple<T,T,T> const & xyz) :
        Super(EigenVector(std::get<0>(xyz), std::get<1>(xyz), std::get<2>(xyz))) {}

#ifdef SWIG
    T getX() const;
    T getY() const;
    T getZ() const;
    void setX(T x);
    void setY(T y);
    void setZ(T z);
#endif

    void swap(Point & other) { this->_swap(other); }
};

typedef Point<int,2> PointI;
typedef Point<int,2> Point2I;
typedef Point<int,3> Point3I;
typedef Point<double,2> PointD;
typedef Point<double,2> Point2D;
typedef Point<double,3> Point3D;

template <int N>
Point<double,N> operator+(Point<double,N> const & lhs, Extent<int,N> const & rhs) {
    return lhs + Extent<double,N>(rhs);
}

template <int N>
Point<double,N> operator+(Extent<int,N> const & rhs, Point<double,N> const & lhs) {
    return Point<double,N>(lhs) + rhs;
}

template <int N>
Point<double,N> & operator+=(Point<double,N> & lhs, Extent<int,N> const & rhs) {
    return lhs += Extent<double,N>(rhs);
}

template <int N>
Point<double,N> operator+(Point<int,N> const & lhs, Extent<double,N> const & rhs) {
    return Point<double,N>(lhs) + rhs;
}

template <int N>
Point<double,N> operator-(Point<double,N> const & lhs, Extent<int,N> const & rhs) {
    return lhs - Extent<double,N>(rhs);
}

template <int N>
Point<double,N> & operator-=(Point<double,N> & lhs, Extent<int,N> const & rhs) {
    return lhs -= Extent<double,N>(rhs);
}

template <int N>
Point<double,N> operator-(Point<int,N> const & lhs, Extent<double,N> const & rhs) {
    return Point<double,N>(lhs) - rhs;
}

template <int N>
Extent<double,N> operator-(Point<double,N> const & lhs, Point<int,N> const & rhs) {
    return lhs - Point<double,N>(rhs);
}

template <int N>
Extent<double,N> operator-(Point<int,N> const & lhs, Point<double,N> const & rhs) {
    return Point<double,N>(lhs) - rhs;
}

}}}

#endif