lsst::geom::Point< T, 2 > Class Template Reference

A coordinate class intended to represent absolute positions (2-d specialization). More...

#include <Point.h>

Inheritance diagram for lsst::geom::Point< T, 2 >:

Public Types
typedef Super::EigenVector	EigenVector
typedef Super::EigenVector	EigenVector
typedef T	Element

Public Member Functions
	Point (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct a Point with all elements set to the same scalar value.
	Point (Point const &)=default
	Point (Point &&)=default
	~Point ()=default
Point &	operator= (Point const &)=default
Point &	operator= (Point &&)=default
template<typename U>
	Point (Point< U, 2 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
	Explicit converting constructor.
	Point (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct a Point from an Eigen vector.
	Point (Extent< T, 2 > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Explicit constructor from Extent.
	Point (T x, T y) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Explicit constructor from a pair of doubles.
	Point (T const xy[2]) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct from a two-element array.
	Point (std::pair< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct from a std::pair.
	Point (std::tuple< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct from std::tuple.
void	swap (Point &other) noexcept
	Point (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct a Point with all elements set to the same scalar value.
	Point (Point const &)=default
	Point (Point &&)=default
	Point (Point< U, N > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
	Explicit converting constructor.
	Point (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Construct a Point from an Eigen vector.
	Point (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Explicit constructor from Extent.
	~Point ()=default
Point &	operator= (Point const &)=default
Point &	operator= (Point &&)=default
void	swap (Point &other) noexcept
bool	operator== (Point< T, N > const &other) const noexcept
	Standard equality comparison.
bool	operator!= (Point< T, N > const &other) const noexcept
	Standard inequality comparison.
T &	operator[] (int n)
T const &	operator[] (int n) const
T &	operator[] (int n)
T const &	operator[] (int n) const
T &	coeffRef (int n)
T const &	coeffRef (int n) const
T &	coeffRef (int n)
T const &	coeffRef (int n) const
EigenVector const &	asEigen () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
	Return a fixed-size Eigen representation of the coordinate object.
EigenVector const &	asEigen () const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
	Return a fixed-size Eigen representation of the coordinate object.
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 noexcept
CoordinateExpr< N >	eq (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateExpr< N >	ne (Point< T, N > const &other) const noexcept
CoordinateExpr< N >	ne (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateExpr< N >	lt (Point< T, N > const &other) const noexcept
CoordinateExpr< N >	lt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateExpr< N >	le (Point< T, N > const &other) const noexcept
CoordinateExpr< N >	le (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateExpr< N >	gt (Point< T, N > const &other) const noexcept
CoordinateExpr< N >	gt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
CoordinateExpr< N >	ge (Point< T, N > const &other) const noexcept
CoordinateExpr< N >	ge (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Arithmetic operators
No scalar interoperability is provided for Point arithmetic operations.
Extent< T, N >	operator- (Point< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
Point< T, N >	operator- (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
Point< T, N >	operator+ (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
Point< T, N > &	operator+= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
Point< T, N > &	operator-= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
Extent< T, N >	asExtent () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
void	shift (Extent< T, N > const &offset) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Shift the point by the given offset.
void	scale (double factor) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
double	distanceSquared (PointBase< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
	Cast this object to an Extent of the same numeric type and dimensionality.
std::string	toString () const
	Cast this object to an Extent of the same numeric type and dimensionality.

Static Public Attributes
static int const	dimensions
static int const	dimensions
static bool constexpr	IS_ELEMENT_NOTHROW_COPYABLE
static bool constexpr	IS_ELEMENT_NOTHROW_COPYABLE
static bool constexpr	IS_ELEMENT_NOTHROW_ASSIGNABLE
static bool constexpr	IS_ELEMENT_NOTHROW_ASSIGNABLE

Protected Member Functions
void	_swap (CoordinateBase &other) noexcept
void	_swap (CoordinateBase &other) noexcept

Protected Attributes
EigenVector	_vector
EigenVector	_vector

Related Symbols
(Note that these are not member symbols.)
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)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
	Floating-point comparison with tolerance.
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)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
	Floating-point comparison with tolerance.

Detailed Description

template<typename T>
class lsst::geom::Point< T, 2 >

A coordinate class intended to represent absolute positions (2-d specialization).

See geomOps for mathematical operators on Point.

Definition at line 211 of file Point.h.

Member Typedef Documentation

EigenVector [1/2]

typedef Super::EigenVector lsst::geom::Point< T, N >::EigenVector

Definition at line 173 of file Point.h.

EigenVector [2/2]

template<typename T>

typedef Super::EigenVector lsst::geom::Point< T, 2 >::EigenVector

Definition at line 215 of file Point.h.

Element

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

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

Point() [1/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( T val = static_cast<T>(0) )

inlineexplicitnoexcept

Construct a Point with all elements set to the same scalar value.

Definition at line 218 of file Point.h.

Point() [2/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( Point< T, 2 > const & )

default

Point() [3/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( Point< T, 2 > && )

default

~Point() [1/2]

template<typename T>

lsst::geom::Point< T, 2 >::~Point ( )

default

Point() [4/16]

template<typename T>

template<typename U>

lsst::geom::Point< T, 2 >::Point ( Point< U, 2 > const & other )

explicitnoexcept

Explicit converting constructor.

Converting from floating point to integer rounds to the nearest integer instead of truncating. This ensures that a floating-point pixel coordinate converts to the coordinate of the pixel it lies on (assuming the floating point origin is the center of the first pixel).

Definition at line 61 of file Point.cc.

Point() [5/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( EigenVector const & vector )

inlineexplicitnoexcept

Construct a Point from an Eigen vector.

Definition at line 238 of file Point.h.

Point() [6/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( Extent< T, 2 > const & other )

inlineexplicitnoexcept

Explicit constructor from Extent.

Definition at line 241 of file Point.h.

Point() [7/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( T x, T y )

inlineexplicitnoexcept

Explicit constructor from a pair of doubles.

Definition at line 245 of file Point.h.

Point() [8/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( T const xy[2] )

inlineexplicitnoexcept

Construct from a two-element array.

Definition at line 248 of file Point.h.

Point() [9/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( std::pair< T, T > const & xy )

inlineexplicitnoexcept

Construct from a std::pair.

Definition at line 252 of file Point.h.

Point() [10/16]

template<typename T>

lsst::geom::Point< T, 2 >::Point ( std::tuple< T, T > const & xy )

inlineexplicitnoexcept

Construct from std::tuple.

Definition at line 256 of file Point.h.

Point() [11/16]

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

inlineexplicitnoexcept

Construct a Point with all elements set to the same scalar value.

Definition at line 176 of file Point.h.

Point() [12/16]

lsst::geom::Point< T, N >::Point ( Point< T, 2 > const & )

default

Point() [13/16]

lsst::geom::Point< T, N >::Point ( Point< T, 2 > && )

default

Point() [14/16]

lsst::geom::Point< T, N >::Point ( Point< U, N > const & other )

explicitnoexcept

Explicit converting constructor.

Converting from floating point to integer rounds to the nearest integer instead of truncating. This ensures that a floating-point pixel coordinate converts to the coordinate of the pixel it lies on (assuming the floating point origin is the center of the first pixel).

Definition at line 193 of file Point.cc.

Point() [15/16]

lsst::geom::Point< T, N >::Point ( EigenVector const & vector )

inlineexplicitnoexcept

Construct a Point from an Eigen vector.

Definition at line 196 of file Point.h.

Point() [16/16]

lsst::geom::Point< T, N >::Point ( Extent< T, N > const & other )

inlineexplicitnoexcept

Explicit constructor from Extent.

Definition at line 199 of file Point.h.

~Point() [2/2]

lsst::geom::Point< T, N >::~Point ( )

default

Member Function Documentation

_swap() [1/2]

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

inlineprotectednoexcept

Definition at line 108 of file CoordinateBase.h.

_swap() [2/2]

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

inlineprotectednoexcept

Definition at line 108 of file CoordinateBase.h.

asEigen() [1/2]

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

inlinenoexcept

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 89 of file CoordinateBase.h.

asEigen() [2/2]

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

inlinenoexcept

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 89 of file CoordinateBase.h.

asExtent()

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

inlinenoexcept

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

Definition at line 127 of file Point.h.

coeffRef() [1/4]

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

inline

Definition at line 80 of file CoordinateBase.h.

coeffRef() [2/4]

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

inline

Definition at line 80 of file CoordinateBase.h.

coeffRef() [3/4]

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

inline

Definition at line 81 of file CoordinateBase.h.

coeffRef() [4/4]

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

inline

Definition at line 81 of file CoordinateBase.h.

distanceSquared()

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

inlinenoexcept

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

Definition at line 138 of file Point.h.

eq() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::eq ( Point< T, N > const & other ) const

noexcept

Definition at line 75 of file Point.cc.

eq() [2/2]

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

inlinenoexcept

Definition at line 81 of file Point.h.

ge() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::ge ( Point< T, N > const & other ) const

noexcept

Definition at line 80 of file Point.cc.

ge() [2/2]

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

inlinenoexcept

Definition at line 96 of file Point.h.

gt() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::gt ( Point< T, N > const & other ) const

noexcept

Definition at line 79 of file Point.cc.

gt() [2/2]

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

inlinenoexcept

Definition at line 93 of file Point.h.

le() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::le ( Point< T, N > const & other ) const

noexcept

Definition at line 78 of file Point.cc.

le() [2/2]

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

inlinenoexcept

Definition at line 90 of file Point.h.

lt() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::lt ( Point< T, N > const & other ) const

noexcept

Definition at line 77 of file Point.cc.

lt() [2/2]

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

inlinenoexcept

Definition at line 87 of file Point.h.

ne() [1/2]

CoordinateExpr< N > lsst::geom::PointBase< T, N >::ne ( Point< T, N > const & other ) const

noexcept

Definition at line 76 of file Point.cc.

ne() [2/2]

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

inlinenoexcept

Definition at line 84 of file Point.h.

operator!=()

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

inlinenoexcept

Standard inequality comparison.

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

Definition at line 60 of file Point.h.

operator+()

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

inlinenoexcept

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

Definition at line 110 of file Point.h.

operator+=()

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

inlinenoexcept

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

Definition at line 116 of file Point.h.

operator-() [1/2]

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

inlinenoexcept

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

Definition at line 113 of file Point.h.

operator-() [2/2]

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

inlinenoexcept

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

Definition at line 107 of file Point.h.

operator-=()

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

inlinenoexcept

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

Definition at line 120 of file Point.h.

operator=() [1/4]

Point & lsst::geom::Point< T, N >::operator= ( Point< T, 2 > && )

default

operator=() [2/4]

template<typename T>

Point & lsst::geom::Point< T, 2 >::operator= ( Point< T, 2 > && )

default

operator=() [3/4]

Point & lsst::geom::Point< T, N >::operator= ( Point< T, 2 > const & )

default

operator=() [4/4]

template<typename T>

Point & lsst::geom::Point< T, 2 >::operator= ( Point< T, 2 > const & )

default

operator==()

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

inlinenoexcept

Standard equality comparison.

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

Definition at line 53 of file Point.h.

operator[]() [1/4]

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

inline

Definition at line 78 of file CoordinateBase.h.

operator[]() [2/4]

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

inline

Definition at line 78 of file CoordinateBase.h.

operator[]() [3/4]

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

inline

Definition at line 79 of file CoordinateBase.h.

operator[]() [4/4]

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

inline

Definition at line 79 of file CoordinateBase.h.

scale()

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

inlinenoexcept

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

Definition at line 136 of file Point.h.

shift()

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

inlinenoexcept

Shift the point by the given offset.

Definition at line 132 of file Point.h.

swap() [1/2]

void lsst::geom::Point< T, N >::swap ( Point< T, 2 > & other )

inlinenoexcept

Definition at line 202 of file Point.h.

swap() [2/2]

template<typename T>

void lsst::geom::Point< T, 2 >::swap ( Point< T, 2 > & other )

inlinenoexcept

Definition at line 259 of file Point.h.

toString()

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

inline

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

Definition at line 143 of file Point.h.

Friends And Related Symbol Documentation

allclose() [1/2]

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 120 of file CoordinateBase.cc.

allclose() [2/2]

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 120 of file CoordinateBase.cc.

Member Data Documentation

_vector [1/2]

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

protected

Definition at line 109 of file CoordinateBase.h.

_vector [2/2]

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

protected

Definition at line 109 of file CoordinateBase.h.

dimensions [1/2]

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

static

Definition at line 58 of file CoordinateBase.h.

dimensions [2/2]

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

static

Definition at line 58 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_ASSIGNABLE [1/2]

bool constexpr lsst::geom::CoordinateBase< Point< T, N >, T, N >::IS_ELEMENT_NOTHROW_ASSIGNABLE

staticconstexpr

Definition at line 61 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_ASSIGNABLE [2/2]

bool constexpr lsst::geom::CoordinateBase< Point< T, N >, T, N >::IS_ELEMENT_NOTHROW_ASSIGNABLE

staticconstexpr

Definition at line 61 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_COPYABLE [1/2]

bool constexpr lsst::geom::CoordinateBase< Point< T, N >, T, N >::IS_ELEMENT_NOTHROW_COPYABLE

staticconstexpr

Definition at line 60 of file CoordinateBase.h.

IS_ELEMENT_NOTHROW_COPYABLE [2/2]

bool constexpr lsst::geom::CoordinateBase< Point< T, N >, T, N >::IS_ELEMENT_NOTHROW_COPYABLE

staticconstexpr

Definition at line 60 of file CoordinateBase.h.

---

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

• include/lsst/geom/Point.h
• src/Point.cc