A coordinate class intended to represent offsets and dimensions. More...

#include <CoordinateBase.h>

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

Public Types
typedef Super::EigenVector	EigenVector

Public Types inherited from lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >
typedef T	Element

typedef Eigen::Matrix< T, N, 1, Eigen::DontAlign >	EigenVector

Public Member Functions
	Extent (T val=static_cast< T >(0))
	Construct an Extent with all elements set to the same scalar value. More...

	Extent (EigenVector const &vector)
	Construct an Extent from an Eigen vector. More...

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

template<typename U >
	Extent (Extent< U, N > const &other)
	Explicit constructor from Extent of different type (if allowed) More...

template<typename U >
	Extent (Point< U, N > const &other)

T	computeSquaredNorm () const
	Return the squared L2 norm of the Extent (x^2 + y^2 + ...). More...

T	computeNorm () const
	Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)). More...

void	swap (Extent &other)

Public Member Functions inherited from lsst::afw::geom::ExtentBase< T, N >
T	computeSquaredNorm () const
	Return the squared L2 norm of the Extent (x^2 + y^2 + ...). More...

T	computeNorm () const
	Return the L2 norm of the Extent (sqrt(x^2 + y^2 + ...)). More...

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

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

std::string	toString () const

CoordinateExpr< N >	eq (Extent< T, N > const &other) const

CoordinateExpr< N >	ne (Extent< T, N > const &other) const

CoordinateExpr< N >	lt (Extent< T, N > const &other) const

CoordinateExpr< N >	le (Extent< T, N > const &other) const

CoordinateExpr< N >	gt (Extent< T, N > const &other) const

CoordinateExpr< N >	ge (Extent< 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

Point< T, N >	operator+ (Point< T, N > const &other) const

Extent< T, N >	operator+ (Extent< T, N > const &other) const

Extent< T, N >	operator- (Extent< T, N > const &other) const

Extent< T, N > &	operator+= (Extent< T, N > const &other)

Extent< T, N > &	operator-= (Extent< T, N > const &other)

Extent< T, N >	operator+ () const

Extent< T, N >	operator- () const

Extent< T, N >	operator* (T scalar) const

Extent< T, N > &	operator*= (T scalar)

Extent< T, N >	operator/ (T scalar) const

Extent< T, N > &	operator/= (T scalar)

Public Member Functions inherited from lsst::afw::geom::CoordinateBase< Extent< 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...

Private Types
typedef ExtentBase< T, N >	Super

Additional Inherited Members
Static Public Attributes inherited from lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >
static int const	dimensions

Protected Member Functions inherited from lsst::afw::geom::ExtentBase< T, N >
	ExtentBase (T val=static_cast< T >(0))
	Construct an Extent<T,N> with all elements set to the same scalar value. More...

template<typename Vector >
	ExtentBase (Eigen::MatrixBase< Vector > const &vector)
	Construct an Extent from an Eigen vector. More...

Protected Member Functions inherited from lsst::afw::geom::CoordinateBase< Extent< 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)

Protected Attributes inherited from lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >
EigenVector	_vector

Detailed Description

template<typename T, int N = 2>
class lsst::afw::geom::Extent< T, N >

A coordinate class intended to represent offsets and dimensions.

Much of the functionality of Extent is provided by its CRTP base class, CoordinateBase.

Unlike Point, Extent does not have a type-converting constructor, because the rounding semantics are not as clear. In most cases, conversions between integer and floating point dimensions are best handled by Box objects, where the rounding semantics make more sense.

Definition at line 41 of file CoordinateBase.h.

Member Typedef Documentation

template<typename T, int N = 2>

typedef Super::EigenVector lsst::afw::geom::Extent< T, N >::EigenVector

Definition at line 189 of file Extent.h.

template<typename T, int N = 2>

typedef ExtentBase<T,N> lsst::afw::geom::Extent< T, N >::Super

private

Definition at line 187 of file Extent.h.

Constructor & Destructor Documentation

template<typename T, int N = 2>

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

inlineexplicit

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

Definition at line 192 of file Extent.h.

192 : Super(val) {}

lsst::afw::geom::Extent::Super

ExtentBase< T, N > Super

Definition: Extent.h:187

val

ImageT val

Definition: CR.cc:154

template<typename T, int N = 2>

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

inlineexplicit

Construct an Extent from an Eigen vector.

Definition at line 195 of file Extent.h.

195 : Super(vector) {}

lsst::afw::geom::Extent::Super

ExtentBase< T, N > Super

Definition: Extent.h:187

template<typename T, int N = 2>

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

explicit

Explicit constructor from Point.

template<typename T, int N = 2>

template<typename U >

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

explicit

Explicit constructor from Extent of different type (if allowed)

template<typename T, int N = 2>

template<typename U >

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

explicit

Member Function Documentation

template<typename T, int N = 2>

T lsst::afw::geom::Extent< T, N >::computeNorm ( ) const

inline

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

Definition at line 210 of file Extent.h.

210 { return this->asEigen().norm(); }

lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >::asEigen

EigenVector const & asEigen() const

Return a fixed-size Eigen representation of the coordinate object.

Definition: CoordinateBase.h:67

template<typename T, int N = 2>

T lsst::afw::geom::Extent< T, N >::computeSquaredNorm ( ) const

inline

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

Definition at line 207 of file Extent.h.

207 { return this->asEigen().squaredNorm(); }

lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >::asEigen

EigenVector const & asEigen() const

Return a fixed-size Eigen representation of the coordinate object.

Definition: CoordinateBase.h:67

template<typename T, int N = 2>

void lsst::afw::geom::Extent< T, N >::swap ( Extent< T, N > & other )

inline

Definition at line 212 of file Extent.h.

212 { this->_swap(other); }

lsst::afw::geom::CoordinateBase< Extent< T, N >, T, N >::_swap

void _swap(CoordinateBase &other)

Definition: CoordinateBase.h:88

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

/lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/geom/CoordinateBase.h
/lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/geom/Extent.h

Public Types

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

template<typename T, int N = 2> class lsst::afw::geom::Extent< T, N >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename T, int N = 2>
class lsst::afw::geom::Extent< T, N >