lsst::afw::geom::PointBase< T, N > Class Template Reference

#include <Point.h>

Inheritance diagram for lsst::afw::geom::PointBase< T, N >:

Public Types
typedef T	Element
typedef Eigen::Matrix< T, N, 1, Eigen::DontAlign >	EigenVector

Public Member Functions
	PointBase (PointBase const &)=default
	PointBase (PointBase &&)=default
PointBase &	operator= (PointBase const &)=default
PointBase &	operator= (PointBase &&)=default
	~PointBase ()=default
bool	operator== (Point< T, N > const &other) const
	Standard equality comparison. More...
bool	operator!= (Point< T, N > const &other) const
	Standard inequality comparison. More...
Extent< T, N >	asExtent () const
	Cast this object to an Extent of the same numeric type and dimensionality. More...
void	shift (Extent< T, N > const &offset)
	Shift the point by the given offset. More...
void	scale (double factor)
double	distanceSquared (PointBase< T, N > const &other) const
std::string	toString () const
T &	operator[] (int n)
T const &	operator[] (int n) const
T &	coeffRef (int n)
T const &	coeffRef (int n) const
EigenVector const &	asEigen () const
	Return a fixed-size Eigen representation of the coordinate object. More...
Named vectorized comparison functions
Note that these return CoordinateExpr, not bool. Unlike most arithmetic and assignment operators, scalar interoperability is provided for comparisons; expressions like if (all(point.gt(0))) ... are both ubiquitous and easy to interpret.
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
CoordinateExpr< N >	ne (T scalar) const
CoordinateExpr< N >	lt (T scalar) const
CoordinateExpr< N >	le (T scalar) const
CoordinateExpr< N >	gt (T scalar) const
CoordinateExpr< N >	ge (T scalar) const
Arithmetic operators
No scalar interoperability is provided for Point arithmetic operations.
Extent< T, N >	operator- (Point< T, N > const &other) const
Point< T, N >	operator+ (Extent< T, N > const &other) const
Point< T, N >	operator- (Extent< T, N > const &other) const
Point< T, N > &	operator+= (Extent< T, N > const &other)
Point< T, N > &	operator-= (Extent< T, N > const &other)

Static Public Attributes
static int const	dimensions

Protected Member Functions
	PointBase (T val=static_cast< T >(0))
template<typename Vector >
	PointBase (Eigen::MatrixBase< Vector > const &vector)
void	_swap (CoordinateBase &other)

Protected Attributes
EigenVector	_vector

Related Functions
(Note that these are not member functions.)
bool	allclose (CoordinateBase< Point< T, N >, T, N > const &a, CoordinateBase< Point< T, N >, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8))
	Floating-point comparison with tolerance. More...

Detailed Description

template<typename T, int N>
class lsst::afw::geom::PointBase< T, N >

Definition at line 42 of file Point.h.

Member Typedef Documentation

EigenVector

typedef Eigen::Matrix<T, N, 1, Eigen::DontAlign> lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::EigenVector

inherited

Definition at line 56 of file CoordinateBase.h.

Element

typedef T lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::Element

inherited

Definition at line 54 of file CoordinateBase.h.

Constructor & Destructor Documentation

PointBase() [1/4]

template<typename T, int N>

lsst::afw::geom::PointBase< T, N >::PointBase ( PointBase< T, N > const &  )

default

PointBase() [2/4]

template<typename T, int N>

lsst::afw::geom::PointBase< T, N >::PointBase ( PointBase< T, N > &&  )

default

~PointBase()

template<typename T, int N>

lsst::afw::geom::PointBase< T, N >::~PointBase ( )

default

PointBase() [3/4]

template<typename T, int N>

lsst::afw::geom::PointBase< T, N >::PointBase ( T  val = static_cast<T>(0) )

inlineexplicitprotected

Definition at line 145 of file Point.h.

: Super(val) {}

PointBase() [4/4]

template<typename T, int N>

template<typename Vector >

lsst::afw::geom::PointBase< T, N >::PointBase ( Eigen::MatrixBase< Vector > const &  vector )

inlineexplicitprotected

Definition at line 148 of file Point.h.

: Super(vector) {}

Member Function Documentation

_swap()

void lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::_swap ( CoordinateBase< Point< T, N >, T, N > &  other )

inlineprotectedinherited

Definition at line 93 of file CoordinateBase.h.

{ _vector.swap(other._vector); }

asEigen()

EigenVector const& lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::asEigen ( ) const

inlineinherited

Return a fixed-size Eigen representation of the coordinate object.

The fact that this returns by const reference rather than by value should not be considered part of the API; this is merely an optimization enabled by the implementation.

Definition at line 75 of file CoordinateBase.h.

{ return _vector; }

asExtent()

template<typename T, int N>

Extent<T, N> lsst::afw::geom::PointBase< T, N >::asExtent ( ) const

inline

Cast this object to an Extent of the same numeric type and dimensionality.

Definition at line 119 of file Point.h.

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

coeffRef() [1/2]

T& lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::coeffRef ( int  n )

inlineinherited

Definition at line 66 of file CoordinateBase.h.

{ return _vector.coeffRef(n); }

coeffRef() [2/2]

T const& lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::coeffRef ( int  n ) const

inlineinherited

Definition at line 67 of file CoordinateBase.h.

{ return const_cast<EigenVector&>(_vector).coeffRef(n); }

distanceSquared()

template<typename T, int N>

double lsst::afw::geom::PointBase< T, N >::distanceSquared ( PointBase< T, N > const &  other ) const

inline

Definition at line 126 of file Point.h.

                                                               {
        // the cast to double is lame but Eigen seems to require they be the same type
        return (this->asEigen() - other.asEigen()).squaredNorm();
    }

eq() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::eq

(

Point< T, N > const &

other

)

const

Definition at line 78 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] == other[n];
    return r;
}

eq() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::eq ( T  scalar ) const

inline

Definition at line 85 of file Point.h.

{ return this->eq(Point<T, N>(scalar)); }

ge() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::ge

(

Point< T, N > const &

other

)

const

Definition at line 113 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] >= other[n];
    return r;
}

ge() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::ge ( T  scalar ) const

inline

Definition at line 90 of file Point.h.

{ return this->ge(Point<T, N>(scalar)); }

gt() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::gt

(

Point< T, N > const &

other

)

const

Definition at line 106 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] > other[n];
    return r;
}

gt() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::gt ( T  scalar ) const

inline

Definition at line 89 of file Point.h.

{ return this->gt(Point<T, N>(scalar)); }

le() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::le

(

Point< T, N > const &

other

)

const

Definition at line 99 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] <= other[n];
    return r;
}

le() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::le ( T  scalar ) const

inline

Definition at line 88 of file Point.h.

{ return this->le(Point<T, N>(scalar)); }

lt() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::lt

(

Point< T, N > const &

other

)

const

Definition at line 92 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] < other[n];
    return r;
}

lt() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::lt ( T  scalar ) const

inline

Definition at line 87 of file Point.h.

{ return this->lt(Point<T, N>(scalar)); }

ne() [1/2]

template<typename T, int N>

CoordinateExpr< N > lsst::afw::geom::PointBase< T, N >::ne

(

Point< T, N > const &

other

)

const

Definition at line 85 of file Point.cc.

                                                                    {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] != other[n];
    return r;
}

ne() [2/2]

template<typename T, int N>

CoordinateExpr<N> lsst::afw::geom::PointBase< T, N >::ne ( T  scalar ) const

inline

Definition at line 86 of file Point.h.

{ return this->ne(Point<T, N>(scalar)); }

operator!=()

template<typename T, int N>

bool lsst::afw::geom::PointBase< T, N >::operator!= ( Point< T, N > const &  other ) const

inline

Standard inequality comparison.

Returns true iff any(this->ne(other));

Definition at line 64 of file Point.h.

{ return any(this->ne(other)); }

operator+()

template<typename T, int N>

Point<T, N> lsst::afw::geom::PointBase< T, N >::operator+ ( Extent< T, N > const &  other ) const

inline

Definition at line 102 of file Point.h.

                                                           {
        return Point<T, N>(this->_vector + other.asEigen());
    }

operator+=()

template<typename T, int N>

Point<T, N>& lsst::afw::geom::PointBase< T, N >::operator+= ( Extent< T, N > const &  other )

inline

Definition at line 108 of file Point.h.

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

operator-() [1/2]

template<typename T, int N>

Extent<T, N> lsst::afw::geom::PointBase< T, N >::operator- ( Point< T, N > const &  other ) const

inline

Definition at line 99 of file Point.h.

                                                           {
        return Extent<T, N>(this->_vector - other._vector);
    }

operator-() [2/2]

template<typename T, int N>

Point<T, N> lsst::afw::geom::PointBase< T, N >::operator- ( Extent< T, N > const &  other ) const

inline

Definition at line 105 of file Point.h.

                                                           {
        return Point<T, N>(this->_vector - other.asEigen());
    }

operator-=()

template<typename T, int N>

Point<T, N>& lsst::afw::geom::PointBase< T, N >::operator-= ( Extent< T, N > const &  other )

inline

Definition at line 112 of file Point.h.

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

operator=() [1/2]

template<typename T, int N>

PointBase& lsst::afw::geom::PointBase< T, N >::operator= ( PointBase< T, N > const &  )

default

operator=() [2/2]

template<typename T, int N>

PointBase& lsst::afw::geom::PointBase< T, N >::operator= ( PointBase< T, N > &&  )

default

operator==()

template<typename T, int N>

bool lsst::afw::geom::PointBase< T, N >::operator== ( Point< T, N > const &  other ) const

inline

Standard equality comparison.

Returns true iff all(this->eq(other));

Definition at line 57 of file Point.h.

{ return all(this->eq(other)); }

operator[]() [1/2]

T& lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::operator[] ( int  n )

inlineinherited

Definition at line 64 of file CoordinateBase.h.

{ return _vector[n]; }

operator[]() [2/2]

T const& lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::operator[] ( int  n ) const

inlineinherited

Definition at line 65 of file CoordinateBase.h.

{ return const_cast<EigenVector&>(_vector)[n]; }

scale()

template<typename T, int N>

void lsst::afw::geom::PointBase< T, N >::scale ( double  factor )

inline

Definition at line 124 of file Point.h.

{ this->_vector *= factor; }

shift()

template<typename T, int N>

void lsst::afw::geom::PointBase< T, N >::shift ( Extent< T, N > const &  offset )

inline

Shift the point by the given offset.

Definition at line 122 of file Point.h.

{ this->_vector += offset.asEigen(); }

toString()

template<typename T, int N>

std::string lsst::afw::geom::PointBase< T, N >::toString ( ) const

inline

Definition at line 131 of file Point.h.

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

Friends And Related Function Documentation

allclose()

bool allclose ( CoordinateBase< Point< T, N > , T, N > const &  a, CoordinateBase< Point< T, N > , T, N > const &  b, T  rtol = static_cast<T>(1E-5), T  atol = static_cast<T>(1E-8)  )

related

Floating-point comparison with tolerance.

Interface, naming, and default tolerances matches Numpy.

Definition at line 32 of file CoordinateBase.cc.

                      {
    Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
    Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
    rhs *= rtol;
    rhs += atol;
    return (diff <= rhs).all();
}

Member Data Documentation

_vector

EigenVector lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::_vector

protectedinherited

Definition at line 94 of file CoordinateBase.h.

dimensions

int const lsst::afw::geom::CoordinateBase< Point< T, N > , T, N >::dimensions

staticinherited

Definition at line 55 of file CoordinateBase.h.

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/include/lsst/afw/geom/Point.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-29-ga12a2b06e/src/geom/Point.cc