LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | Protected Member Functions | Private Types | List of all members
lsst.afw.geom::ExtentBase< T, N > Class Template Reference

#include <Extent.h>

Inheritance diagram for lsst.afw.geom::ExtentBase< T, N >:
lsst.afw.geom::CoordinateBase< Extent< T, N >, T, N > lsst.afw.geom::Extent< double, 2 > lsst.afw.geom::Extent< int, 2 > lsst.afw.geom::Extent< T, N >

Public Member Functions

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...
 
Point< T, N > asPoint () const
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
std::string toString () const
 
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
 
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
 
Additive arithmetic operators

No scalar interoperability is provided for Extent additive arithmetic operations.

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

Protected Member Functions

 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)
 

Private Types

typedef CoordinateBase< Extent
< T, N >, T, N > 		Super
 

Additional Inherited Members

- 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
 
- Static Public Attributes inherited from lsst.afw.geom::CoordinateBase< Extent< T, N >, T, N >
static int const dimensions
 
- Protected Attributes inherited from lsst.afw.geom::CoordinateBase< Extent< T, N >, T, N >
EigenVector _vector
 

Detailed Description

template<typename T, int N>
class lsst.afw.geom::ExtentBase< T, N >

Definition at line 64 of file Extent.h.

Member Typedef Documentation

template<typename T, int N>
typedef CoordinateBase<Extent<T,N>,T,N> lsst.afw.geom::ExtentBase< T, N >::Super
private

Definition at line 65 of file Extent.h.

Constructor & Destructor Documentation

template<typename T, int N>
lsst.afw.geom::ExtentBase< T, N >::ExtentBase ( T  val = static_cast<T>(0))
inlineexplicitprotected

Construct an Extent<T,N> with all elements set to the same scalar value.

Definition at line 171 of file Extent.h.

171 : Super(val) {}
val
ImageT val
Definition: CR.cc:154
lsst.afw.geom::ExtentBase::Super
CoordinateBase< Extent< T, N >, T, N > Super
Definition: Extent.h:65
template<typename T, int N>
template<typename Vector >
lsst.afw.geom::ExtentBase< T, N >::ExtentBase ( Eigen::MatrixBase< Vector > const &  vector)
inlineexplicitprotected

Construct an Extent from an Eigen vector.

Definition at line 175 of file Extent.h.

175 : Super(vector) {}
lsst.afw.geom::ExtentBase::Super
CoordinateBase< Extent< T, N >, T, N > Super
Definition: Extent.h:65

Member Function Documentation

template<typename T, int N>
Point<T,N> lsst.afw.geom::ExtentBase< T, N >::asPoint ( ) const

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

template<typename T, int N>
T lsst.afw.geom::ExtentBase< T, N >::computeNorm ( ) const
inline

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

Definition at line 72 of file Extent.h.

72 { return detail::computeExtentNorm(static_cast<Extent<T,N> const &>(*this)); }
lsst.afw.geom::detail::computeExtentNorm
double computeExtentNorm(Extent< double, N > const &s)
Definition: Extent.h:45
template<typename T, int N>
T lsst.afw.geom::ExtentBase< T, N >::computeSquaredNorm ( ) const
inline

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

Definition at line 69 of file Extent.h.

69 { 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>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::eq ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::eq ( T  scalar) const
inline

Definition at line 107 of file Extent.h.

107 { return this->eq(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::eq
CoordinateExpr< N > eq(Extent< T, N > const &other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::ge ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::ge ( T  scalar) const
inline

Definition at line 112 of file Extent.h.

112 { return this->ge(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::ge
CoordinateExpr< N > ge(Extent< T, N > const &other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::gt ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::gt ( T  scalar) const
inline

Definition at line 111 of file Extent.h.

111 { return this->gt(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::gt
CoordinateExpr< N > gt(Extent< T, N > const &other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::le ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::le ( T  scalar) const
inline

Definition at line 110 of file Extent.h.

110 { return this->le(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::le
CoordinateExpr< N > le(Extent< T, N > const &other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::lt ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::lt ( T  scalar) const
inline

Definition at line 109 of file Extent.h.

109 { return this->lt(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::lt
CoordinateExpr< N > lt(Extent< T, N > const &other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::ne ( Extent< T, N > const &  other) const
template<typename T, int N>
CoordinateExpr<N> lsst.afw.geom::ExtentBase< T, N >::ne ( T  scalar) const
inline

Definition at line 108 of file Extent.h.

108 { return this->ne(Extent<T,N>(scalar)); }
lsst.afw.geom::ExtentBase::ne
CoordinateExpr< N > ne(Extent< T, N > const &other) const
template<typename T, int N>
bool lsst.afw.geom::ExtentBase< T, N >::operator!= ( Extent< T, N > const &  other) const
inline

Standard inequality comparison.

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

Definition at line 86 of file Extent.h.

86 { return any(this->ne(other)); }
lsst.afw.geom::any
bool any(CoordinateExpr< N > const &expr)
Return true if any elements are true.
Definition: CoordinateExpr.h:87
lsst.afw.geom::ExtentBase::ne
CoordinateExpr< N > ne(Extent< T, N > const &other) const
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator* ( T  scalar) const
inline

Definition at line 146 of file Extent.h.

146 { return Extent<T,N>(this->_vector * scalar); }
template<typename T, int N>
Extent<T,N>& lsst.afw.geom::ExtentBase< T, N >::operator*= ( T  scalar)
inline

Definition at line 147 of file Extent.h.

147 { this->_vector *= scalar; return static_cast<Extent<T,N>&>(*this); }
template<typename T, int N>
Point<T,N> lsst.afw.geom::ExtentBase< T, N >::operator+ ( Point< T, N > const &  other) const
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator+ ( Extent< T, N > const &  other) const
inline

Definition at line 122 of file Extent.h.

122  {
123  return Extent<T,N>(this->_vector + other._vector);
124  }
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator+ ( ) const
inline

Definition at line 136 of file Extent.h.

136 { return static_cast<Extent<T,N> const &>(*this); }
template<typename T, int N>
Extent<T,N>& lsst.afw.geom::ExtentBase< T, N >::operator+= ( Extent< T, N > const &  other)
inline

Definition at line 128 of file Extent.h.

128  {
129  this->_vector += other._vector;
130  return static_cast<Extent<T,N>&>(*this);
131  }
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator- ( Extent< T, N > const &  other) const
inline

Definition at line 125 of file Extent.h.

125  {
126  return Extent<T,N>(this->_vector - other._vector);
127  }
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator- ( ) const
inline

Definition at line 137 of file Extent.h.

137 { return Extent<T,N>(-this->_vector); }
template<typename T, int N>
Extent<T,N>& lsst.afw.geom::ExtentBase< T, N >::operator-= ( Extent< T, N > const &  other)
inline

Definition at line 132 of file Extent.h.

132  {
133  this->_vector -= other._vector;
134  return static_cast<Extent<T,N>&>(*this);
135  }
template<typename T, int N>
Extent<T,N> lsst.afw.geom::ExtentBase< T, N >::operator/ ( T  scalar) const
inline

Definition at line 148 of file Extent.h.

148 { return Extent<T,N>(this->_vector / scalar); }
template<typename T, int N>
Extent<T,N>& lsst.afw.geom::ExtentBase< T, N >::operator/= ( T  scalar)
inline

Definition at line 149 of file Extent.h.

149 { this->_vector /= scalar; return static_cast<Extent<T,N>&>(*this); }
template<typename T, int N>
bool lsst.afw.geom::ExtentBase< T, N >::operator== ( Extent< T, N > const &  other) const
inline

Standard equality comparison.

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

Definition at line 79 of file Extent.h.

79 { return all(this->eq(other)); }
lsst.afw.geom::all
bool all(CoordinateExpr< N > const &expr)
Return true if all elements are true.
Definition: CoordinateExpr.h:80
lsst.afw.geom::ExtentBase::eq
CoordinateExpr< N > eq(Extent< T, N > const &other) const
template<typename T, int N>
std::string lsst.afw.geom::ExtentBase< T, N >::toString ( void  ) const
inline

Definition at line 155 of file Extent.h.

155  {
156  std::stringstream out;
157  out << "Extent(";
158  for (size_t i = 0; i < N; ++i) {
159  if (i != 0) {
160  out << ",";
161  }
162  out << (*this)[i];
163  }
164  out << ")";
165  return out.str();
166  }
The documentation for this class was generated from the following file:
Generated on Wed Sep 16 2015 13:35:39 for LSSTApplications by   doxygen 1.8.5