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 >: 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. More...

Point (Point const &)=default

Point (Point &&)=default

~Point ()=default

Pointoperator= (Point const &)=default

Pointoperator= (Point &&)=default

template<typename U >
Point (Point< U, N > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
Explicit converting constructor. More...

Point (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Construct a Point from an Eigen vector. More...

Point (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Explicit constructor from Extent. More...

void swap (Point &other) noexcept

bool operator== (Point< T, N > const &other) const noexcept
Standard equality comparison. More...

bool operator!= (Point< T, N > const &other) const noexcept
Standard inequality comparison. More...

T & operator[] (int n)

T const & operator[] (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. 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 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. More...

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. More...

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. More...

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. More...

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. More...

Extent< T, N > asExtent () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Cast this object to an Extent of the same numeric type and dimensionality. More...

void shift (Extent< T, N > const &offset) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Shift the point by the given offset. More...

void scale (double factor) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
Cast this object to an Extent of the same numeric type and dimensionality. More...

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. More...

std::string toString () const
Cast this object to an Extent of the same numeric type and dimensionality. More...

Static Public Attributes

static int const dimensions

static constexpr bool IS_ELEMENT_NOTHROW_COPYABLE

static constexpr bool IS_ELEMENT_NOTHROW_ASSIGNABLE

Protected Member Functions

void _swap (CoordinateBase &other) noexcept

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)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value)
Floating-point comparison with tolerance. More...

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.

◆ 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.

◆ Point() [1/6]

template<typename T , int N>
 lsst::geom::Point< T, N >::Point ( T val = static_cast(0) )
inlineexplicitnoexcept

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

Definition at line 176 of file Point.h.

176 : Super(val) {}
ImageT val
Definition: CR.cc:146

◆ 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.

53  : Super() {
54  for (int n = 0; n < N; ++n) {
55  this->_vector[n] = detail::PointSpecialized<T>::template convert<U>(other[n]);
56  }
57 }

◆ 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.

196 : Super(vector) {}

◆ 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.

200  : Super(other.asEigen()) {}

◆ _swap()

 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.

108 { _vector.swap(other._vector); }

◆ asEigen()

 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.

89 { return _vector; }

◆ asExtent()

template<typename T , int N>
 Extent 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.

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

◆ coeffRef() [1/2]

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

Definition at line 80 of file CoordinateBase.h.

80 { return _vector.coeffRef(n); }

◆ coeffRef() [2/2]

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

Definition at line 81 of file CoordinateBase.h.

81 { return const_cast<EigenVector&>(_vector).coeffRef(n); }
Eigen::Matrix< T, N, 1, Eigen::DontAlign > EigenVector

◆ 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.

138  {
139  // the cast to double is lame but Eigen seems to require they be the same type
140  return (this->asEigen() - other.asEigen()).squaredNorm();
141  }
EigenVector const & asEigen() const noexcept(IS_ELEMENT_NOTHROW_COPYABLE)
Return a fixed-size Eigen representation of the coordinate object.

◆ 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.

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

◆ eq() [2/2]

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

Definition at line 81 of file Point.h.

81  {
82  return this->eq(Point<T, N>(scalar));
83  }
CoordinateExpr< N > eq(Point< T, N > const &other) const noexcept
Definition: Point.cc:76

◆ 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.

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

◆ ge() [2/2]

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

Definition at line 96 of file Point.h.

96  {
97  return this->ge(Point<T, N>(scalar));
98  }
CoordinateExpr< N > ge(Point< T, N > const &other) const noexcept
Definition: Point.cc:111

◆ 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.

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

◆ gt() [2/2]

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

Definition at line 93 of file Point.h.

93  {
94  return this->gt(Point<T, N>(scalar));
95  }
CoordinateExpr< N > gt(Point< T, N > const &other) const noexcept
Definition: Point.cc:104

◆ 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.

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

◆ le() [2/2]

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

Definition at line 90 of file Point.h.

90  {
91  return this->le(Point<T, N>(scalar));
92  }
CoordinateExpr< N > le(Point< T, N > const &other) const noexcept
Definition: Point.cc:97

◆ 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.

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

◆ lt() [2/2]

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

Definition at line 87 of file Point.h.

87  {
88  return this->lt(Point<T, N>(scalar));
89  }
CoordinateExpr< N > lt(Point< T, N > const &other) const noexcept
Definition: Point.cc:90

◆ 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.

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

◆ ne() [2/2]

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

Definition at line 84 of file Point.h.

84  {
85  return this->ne(Point<T, N>(scalar));
86  }
CoordinateExpr< N > ne(Point< T, N > const &other) const noexcept
Definition: Point.cc:83

◆ 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.

60 { return any(this->ne(other)); }
bool any(CoordinateExpr< N > const &expr) noexcept
Return true if any elements are true.

◆ operator+()

template<typename T , int N>
 Point 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.

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

◆ operator+=()

template<typename T , int N>
 Point& 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.

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

◆ operator-() [1/2]

template<typename T , int N>
 Point 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.

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

◆ operator-() [2/2]

template<typename T , int N>
 Extent 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.

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

◆ operator-=()

template<typename T , int N>
 Point& 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.

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

◆ 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.

53 { return all(this->eq(other)); }
bool all(CoordinateExpr< N > const &expr) noexcept
Return true if all elements are true.

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

78 { return _vector[n]; }

◆ operator[]() [2/2]

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

Definition at line 79 of file CoordinateBase.h.

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

◆ 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.

136 { this->_vector *= factor; }

◆ 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.

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

◆ 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.

202 { this->_swap(other); }
void _swap(CoordinateBase &other) noexcept

◆ 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.

143  {
144  std::stringstream out;
145  out << "Point(";
146  for (size_t i = 0; i < N; ++i) {
147  if (i != 0) {
148  out << ",";
149  }
150  out << (*this)[i];
151  }
152  out << ")";
153  return out.str();
154  }
T str(T... args)

◆ allclose()

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

Floating-point comparison with tolerance.

Interface, naming, and default tolerances matches Numpy.

Definition at line 120 of file CoordinateBase.cc.

32  {
33  Eigen::Array<T, N, 1> diff = (a.asEigen().array() - b.asEigen().array()).abs();
34  Eigen::Array<T, N, 1> rhs = (0.5 * (a.asEigen().array() + b.asEigen().array())).abs();
35  rhs *= rtol;
36  rhs += atol;
37  return (diff <= rhs).all();
38 }
table::Key< int > b
table::Key< int > a
T atol(T... args)
Angle abs(Angle const &a)
Definition: Angle.h:106

◆ _vector

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

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

 constexpr bool 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

 constexpr bool 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:
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/geom/22.0.1-6-g8d3140d+720564cf76/include/lsst/geom/CoordinateBase.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/geom/22.0.1-6-g8d3140d+720564cf76/include/lsst/geom/Point.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/geom/22.0.1-6-g8d3140d+720564cf76/src/Point.cc