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

#include <Point.h>

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

Public Member Functions
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
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)
Public Member Functions inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
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...

Protected Member Functions
	PointBase (T val=static_cast< T >(0))
template<typename Vector >
	PointBase (Eigen::MatrixBase< Vector > const &vector)
Protected Member Functions inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
	CoordinateBase (T val=static_cast< T >(0))
	Initialize all elements to a scalar. More...
	CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
	Initialize all elements from an N-d Eigen vector. More...
void	_swap (CoordinateBase &other)

Private Types
typedef CoordinateBase< Point < T, N >, T, N >	Super

Additional Inherited Members
Public Types inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
typedef T	Element
typedef Eigen::Matrix< T, N, 1, Eigen::DontAlign >	EigenVector
Static Public Attributes inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
static int const	dimensions
Protected Attributes inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
EigenVector	_vector

Detailed Description

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

Definition at line 39 of file Point.h.

Member Typedef Documentation

template<typename T, int N>

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

private

Definition at line 40 of file Point.h.

Constructor & Destructor Documentation

template<typename T, int N>

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

inlineexplicitprotected

Definition at line 138 of file Point.h.

: Super(val) {}

template<typename T, int N>

template<typename Vector >

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

inlineexplicitprotected

Definition at line 141 of file Point.h.

: Super(vector) {}

Member Function Documentation

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 110 of file Point.h.

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

template<typename T, int N>

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

inline

Definition at line 118 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();
    }

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 76 of file Point.h.

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

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 81 of file Point.h.

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

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 80 of file Point.h.

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

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 79 of file Point.h.

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

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 78 of file Point.h.

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

template<typename T, int N>

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

(

Point< T, N > const &

other

)

const

template<typename T, int N>

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

inline

Definition at line 77 of file Point.h.

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

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 55 of file Point.h.

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

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 93 of file Point.h.

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

template<typename T, int N>

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

inline

Definition at line 99 of file Point.h.

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

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 90 of file Point.h.

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

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 96 of file Point.h.

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

template<typename T, int N>

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

inline

Definition at line 103 of file Point.h.

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

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 48 of file Point.h.

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

template<typename T, int N>

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

inline

Definition at line 116 of file Point.h.

{ this->_vector *= factor; }

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 113 of file Point.h.

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

template<typename T, int N>

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

inline

Definition at line 123 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();
    }

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/Point.h