LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
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::Extent< T, 2 > Class Template Reference

A coordinate class intended to represent offsets and dimensions (2-d specialization). More...

#include <Extent.h>

Inheritance diagram for lsst::geom::Extent< T, 2 >:
lsst::geom::ExtentBase< T, 2 > lsst::geom::CoordinateBase< Extent< T, N >, T, N >

Public Types

typedef Super::EigenVector EigenVector
 
typedef T Element
 

Public Member Functions

 Extent (T val=static_cast< T >(0)) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct an Extent with all elements set to the same scalar value.
 
 Extent (EigenVector const &vector) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct an Extent from an Eigen vector.
 
 Extent (Point< T, 2 > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Explicit constructor from Point.
 
template<typename U >
 Extent (Extent< U, 2 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 Explicit constructor from Extent of different type (if allowed)
 
template<typename U >
 Extent (Point< U, 2 > const &other) noexcept(IS_NOTHROW_CONVERTIBLE< T, U >)
 
 Extent (T x, T y) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from two scalars.
 
 Extent (T const xy[2]) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from a two-element array.
 
 Extent (std::pair< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from a std::pair.
 
 Extent (std::tuple< T, T > const &xy) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Construct from std::tuple.
 
 Extent (Extent const &other)=default
 
 Extent (Extent &&other)=default
 
 ~Extent ()=default
 
Extentoperator= (Extent const &other)=default
 
Extentoperator= (Extent &&other)=default
 
void swap (Extent &other) noexcept
 
computeSquaredNorm () const
 Return the squared L2 norm of the Extent (x^2 + y^2 + ...).
 
computeNorm () const
 Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)).
 
bool operator== (Extent< T, N > const &other) const noexcept
 Standard equality comparison.
 
bool operator!= (Extent< T, N > const &other) const noexcept
 Standard inequality comparison.
 
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.
 
Named 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(extent.gt(0))) ...

are both ubiquitous and easy to interpret.

CoordinateExpr< N > eq (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > eq (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ne (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > ne (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > lt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > lt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > le (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > le (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > gt (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > gt (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
CoordinateExpr< N > ge (Extent< T, N > const &other) const noexcept
 
CoordinateExpr< N > ge (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Additive arithmetic operators

No scalar interoperability is provided for Extent additive arithmetic operations.

Point< T, N > operator+ (Point< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator+ (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator+ () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator- (Extent< T, N > const &other) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > operator- () const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 
Extent< T, N > & operator+= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
Extent< T, N > & operator-= (Extent< T, N > const &other) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 
Multiplicative arithmetic operators

As usual with matrices and vectors, Extent can be multiplied or divided by a scalar.

Extent< T, N > operator* (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Extent< T, N > & operator*= (T scalar) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Extent< T, N > operator/ (T scalar) const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Extent< T, N > & operator/= (T scalar) noexcept(Super::IS_ELEMENT_NOTHROW_ASSIGNABLE)
 Cast this object to an Extent of the same numeric type and dimensionality.
 
Point< T, N > asPoint () 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 bool constexpr IS_ELEMENT_NOTHROW_COPYABLE
 
static bool constexpr IS_ELEMENT_NOTHROW_ASSIGNABLE
 

Protected Member Functions

void _swap (CoordinateBase &other) noexcept
 

Protected Attributes

EigenVector _vector
 

Related Symbols

(Note that these are not member symbols.)

bool allclose (CoordinateBase< Extent< T, N >, T, N > const &a, CoordinateBase< Extent< 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::Extent< T, 2 >

A coordinate class intended to represent offsets and dimensions (2-d specialization).

See geomOps for mathematical operators on Extent.

Definition at line 254 of file Extent.h.

Member Typedef Documentation

◆ EigenVector

template<typename T >
typedef Super::EigenVector lsst::geom::Extent< T, 2 >::EigenVector

Definition at line 258 of file Extent.h.

◆ Element

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

Definition at line 57 of file CoordinateBase.h.

Constructor & Destructor Documentation

◆ Extent() [1/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( T val = static_cast<T>(0))
inlineexplicitnoexcept

Construct an Extent with all elements set to the same scalar value.

Definition at line 261 of file Extent.h.

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

◆ Extent() [2/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( EigenVector const & vector)
inlineexplicitnoexcept

Construct an Extent from an Eigen vector.

Definition at line 264 of file Extent.h.

264: Super(vector) {}

◆ Extent() [3/11]

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

Explicit constructor from Point.

◆ Extent() [4/11]

template<typename T >
template<typename U >
lsst::geom::Extent< T, 2 >::Extent ( Extent< U, 2 > const & other)
explicitnoexcept

Explicit constructor from Extent of different type (if allowed)

Definition at line 354 of file Extent.h.

354 {
356 "can only construct from Extent of different but integral type");
357 this->setX(static_cast<T>(other.getX()));
358 this->setY(static_cast<T>(other.getY()));
359};

◆ Extent() [5/11]

template<typename T >
template<typename U >
lsst::geom::Extent< T, 2 >::Extent ( Point< U, 2 > const & other)
explicitnoexcept

Definition at line 363 of file Extent.h.

363 {
365 "can only construct from Extent of different but integral type");
366 this->setX(static_cast<T>(other.getX()));
367 this->setY(static_cast<T>(other.getY()));
368};

◆ Extent() [6/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( T x,
T y )
inlineexplicitnoexcept

Construct from two scalars.

Definition at line 276 of file Extent.h.

276: Super(EigenVector(x, y)) {}
int y
Definition SpanSet.cc:48
Super::EigenVector EigenVector
Definition Extent.h:258

◆ Extent() [7/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( T const xy[2])
inlineexplicitnoexcept

Construct from a two-element array.

Definition at line 279 of file Extent.h.

280 : Super(EigenVector(xy[0], xy[1])) {}

◆ Extent() [8/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( std::pair< T, T > const & xy)
inlineexplicitnoexcept

Construct from a std::pair.

Definition at line 283 of file Extent.h.

284 : Super(EigenVector(xy.first, xy.second)) {}

◆ Extent() [9/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( std::tuple< T, T > const & xy)
inlineexplicitnoexcept

Construct from std::tuple.

Definition at line 287 of file Extent.h.

288 : Super(EigenVector(std::get<0>(xy), std::get<1>(xy))) {}

◆ Extent() [10/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( Extent< T, 2 > const & other)
default

◆ Extent() [11/11]

template<typename T >
lsst::geom::Extent< T, 2 >::Extent ( Extent< T, 2 > && other)
default

◆ ~Extent()

template<typename T >
lsst::geom::Extent< T, 2 >::~Extent ( )
default

Member Function Documentation

◆ _swap()

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

Definition at line 108 of file CoordinateBase.h.

◆ asEigen()

EigenVector const & lsst::geom::CoordinateBase< Extent< 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.

◆ asPoint()

Point< T, N > lsst::geom::ExtentBase< T, N >::asPoint ( ) const
noexceptinherited

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

Definition at line 177 of file Extent.cc.

◆ coeffRef() [1/2]

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

Definition at line 80 of file CoordinateBase.h.

◆ coeffRef() [2/2]

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

Definition at line 81 of file CoordinateBase.h.

◆ computeNorm()

T lsst::geom::ExtentBase< T, N >::computeNorm ( ) const
inlineinherited

Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)).

Definition at line 70 of file Extent.h.

◆ computeSquaredNorm()

T lsst::geom::ExtentBase< T, N >::computeSquaredNorm ( ) const
inlineinherited

Return the squared L2 norm of the Extent (x^2 + y^2 + ...).

Definition at line 67 of file Extent.h.

◆ eq() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::eq ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 99 of file Extent.cc.

◆ eq() [2/2]

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

Definition at line 105 of file Extent.h.

◆ ge() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ge ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 104 of file Extent.cc.

◆ ge() [2/2]

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

Definition at line 120 of file Extent.h.

◆ gt() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::gt ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 103 of file Extent.cc.

◆ gt() [2/2]

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

Definition at line 117 of file Extent.h.

◆ le() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::le ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 102 of file Extent.cc.

◆ le() [2/2]

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

Definition at line 114 of file Extent.h.

◆ lt() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::lt ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 101 of file Extent.cc.

◆ lt() [2/2]

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

Definition at line 111 of file Extent.h.

◆ ne() [1/2]

CoordinateExpr< N > lsst::geom::ExtentBase< T, N >::ne ( Extent< T, N > const & other) const
noexceptinherited

Definition at line 100 of file Extent.cc.

◆ ne() [2/2]

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

Definition at line 108 of file Extent.h.

◆ operator!=()

bool lsst::geom::ExtentBase< T, N >::operator!= ( Extent< T, N > const & other) const
inlinenoexceptinherited

Standard inequality comparison.

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

Definition at line 84 of file Extent.h.

◆ operator*()

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator* ( T scalar) const
inlinenoexceptinherited

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

Definition at line 160 of file Extent.h.

◆ operator*=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator*= ( T scalar)
inlinenoexceptinherited

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

Definition at line 163 of file Extent.h.

◆ operator+() [1/3]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator+ ( ) const
inlinenoexceptinherited

Definition at line 146 of file Extent.h.

◆ operator+() [2/3]

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

Definition at line 132 of file Extent.h.

◆ operator+() [3/3]

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

Definition at line 131 of file Extent.cc.

◆ operator+=()

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

Definition at line 138 of file Extent.h.

◆ operator-() [1/2]

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator- ( ) const
inlinenoexceptinherited

Definition at line 149 of file Extent.h.

◆ operator-() [2/2]

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

Definition at line 135 of file Extent.h.

◆ operator-=()

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

Definition at line 142 of file Extent.h.

◆ operator/()

Extent< T, N > lsst::geom::ExtentBase< T, N >::operator/ ( T scalar) const
inlinenoexceptinherited

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

Definition at line 167 of file Extent.h.

◆ operator/=()

Extent< T, N > & lsst::geom::ExtentBase< T, N >::operator/= ( T scalar)
inlinenoexceptinherited

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

Definition at line 170 of file Extent.h.

◆ operator=() [1/2]

template<typename T >
Extent & lsst::geom::Extent< T, 2 >::operator= ( Extent< T, 2 > && other)
default

◆ operator=() [2/2]

template<typename T >
Extent & lsst::geom::Extent< T, 2 >::operator= ( Extent< T, 2 > const & other)
default

◆ operator==()

bool lsst::geom::ExtentBase< T, N >::operator== ( Extent< T, N > const & other) const
inlinenoexceptinherited

Standard equality comparison.

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

Definition at line 77 of file Extent.h.

◆ operator[]() [1/2]

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

Definition at line 78 of file CoordinateBase.h.

◆ operator[]() [2/2]

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

Definition at line 79 of file CoordinateBase.h.

◆ swap()

template<typename T >
void lsst::geom::Extent< T, 2 >::swap ( Extent< T, 2 > & other)
inlinenoexcept

Definition at line 298 of file Extent.h.

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

◆ toString()

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

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

Definition at line 179 of file Extent.h.

Friends And Related Symbol Documentation

◆ allclose()

bool allclose ( CoordinateBase< Extent< T, N > , T, N > const & a,
CoordinateBase< Extent< 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

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

Definition at line 109 of file CoordinateBase.h.

◆ dimensions

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

Definition at line 58 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_ASSIGNABLE

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

Definition at line 61 of file CoordinateBase.h.

◆ IS_ELEMENT_NOTHROW_COPYABLE

bool constexpr lsst::geom::CoordinateBase< Extent< 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 file: