lsst.geom g19811a7679+8681a15dd0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Related Symbols | List of all members
lsst::geom::Point< T, N > Class Template Reference

A coordinate class intended to represent absolute positions. More...

#include <Point.h>

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

Public Types

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, 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.
 
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, int N>
class lsst::geom::Point< T, N >

A coordinate class intended to represent absolute positions.

See geomOps for mathematical operators on Point.

Definition at line 169 of file Point.h.

Member Typedef Documentation

◆ EigenVector

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

Definition at line 173 of file Point.h.

◆ Element

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

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ Point() [1/6]

template<typename T, int N>
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() [2/6]

template<typename T, int N>
lsst::geom::Point< T, N >::Point ( Point< T, N > const & )
default

◆ Point() [3/6]

template<typename T, int N>
lsst::geom::Point< T, N >::Point ( Point< T, N > && )
default

◆ ~Point()

template<typename T, int N>
lsst::geom::Point< T, N >::~Point ( )
default

◆ Point() [4/6]

template<typename T, int N>
template<typename U>
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 53 of file Point.cc.

◆ Point() [5/6]

template<typename T, int N>
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() [6/6]

template<typename T, int N>
lsst::geom::Point< T, N >::Point ( Extent< T, N > const & other)
inlineexplicitnoexcept

Explicit constructor from Extent.

Definition at line 199 of file Point.h.

Member Function Documentation

◆ _swap() [1/2]

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

Definition at line 108 of file CoordinateBase.h.

◆ _swap() [2/2]

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

Definition at line 108 of file CoordinateBase.h.

◆ asEigen() [1/2]

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

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
inlinenoexceptinherited

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()

template<typename T, int N>
Extent< T, N > lsst::geom::PointBase< T, N >::asExtent ( ) const
inlinenoexceptinherited

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)
inlineinherited

Definition at line 80 of file CoordinateBase.h.

◆ coeffRef() [2/4]

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

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
inlineinherited

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
inlineinherited

Definition at line 81 of file CoordinateBase.h.

◆ distanceSquared()

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

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

Definition at line 138 of file Point.h.

◆ eq() [1/2]

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

Definition at line 76 of file Point.cc.

◆ eq() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::eq ( T scalar) const
inlinenoexceptinherited

Definition at line 81 of file Point.h.

◆ ge() [1/2]

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

Definition at line 111 of file Point.cc.

◆ ge() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ge ( T scalar) const
inlinenoexceptinherited

Definition at line 96 of file Point.h.

◆ gt() [1/2]

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

Definition at line 104 of file Point.cc.

◆ gt() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::gt ( T scalar) const
inlinenoexceptinherited

Definition at line 93 of file Point.h.

◆ le() [1/2]

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

Definition at line 97 of file Point.cc.

◆ le() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::le ( T scalar) const
inlinenoexceptinherited

Definition at line 90 of file Point.h.

◆ lt() [1/2]

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

Definition at line 90 of file Point.cc.

◆ lt() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::lt ( T scalar) const
inlinenoexceptinherited

Definition at line 87 of file Point.h.

◆ ne() [1/2]

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

Definition at line 83 of file Point.cc.

◆ ne() [2/2]

template<typename T, int N>
CoordinateExpr< N > lsst::geom::PointBase< T, N >::ne ( T scalar) const
inlinenoexceptinherited

Definition at line 84 of file Point.h.

◆ operator!=()

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

Standard inequality comparison.

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

Definition at line 60 of file Point.h.

◆ operator+()

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

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

Definition at line 110 of file Point.h.

◆ operator+=()

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

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

Definition at line 116 of file Point.h.

◆ operator-() [1/2]

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

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

Definition at line 113 of file Point.h.

◆ operator-() [2/2]

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

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

Definition at line 107 of file Point.h.

◆ operator-=()

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

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

Definition at line 120 of file Point.h.

◆ operator=() [1/2]

template<typename T, int N>
Point & lsst::geom::Point< T, N >::operator= ( Point< T, N > && )
default

◆ operator=() [2/2]

template<typename T, int N>
Point & lsst::geom::Point< T, N >::operator= ( Point< T, N > const & )
default

◆ operator==()

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

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)
inlineinherited

Definition at line 78 of file CoordinateBase.h.

◆ operator[]() [2/4]

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

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
inlineinherited

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
inlineinherited

Definition at line 79 of file CoordinateBase.h.

◆ scale()

template<typename T, int N>
void lsst::geom::PointBase< T, N >::scale ( double factor)
inlinenoexceptinherited

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

Definition at line 136 of file Point.h.

◆ shift()

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

Shift the point by the given offset.

Definition at line 132 of file Point.h.

◆ swap()

template<typename T, int N>
void lsst::geom::Point< T, N >::swap ( Point< T, N > & other)
inlinenoexcept

Definition at line 202 of file Point.h.

◆ toString()

template<typename T, int N>
std::string lsst::geom::PointBase< T, N >::toString ( ) const
inlineinherited

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
protectedinherited

Definition at line 109 of file CoordinateBase.h.

◆ _vector [2/2]

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

Definition at line 109 of file CoordinateBase.h.

◆ dimensions [1/2]

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

Definition at line 58 of file CoordinateBase.h.

◆ dimensions [2/2]

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

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
staticconstexprinherited

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
staticconstexprinherited

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
staticconstexprinherited

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
staticconstexprinherited

Definition at line 60 of file CoordinateBase.h.

The documentation for this class was generated from the following files:
Generated on Sun Apr 26 2026 08:50:16 for lsst.geom by doxygen 1.13.2