ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::CovariantVector< T, NVectorDimension > Class Template Reference

#include <itkCovariantVector.h>

+ Inheritance diagram for itk::CovariantVector< T, NVectorDimension >:
+ Collaboration diagram for itk::CovariantVector< T, NVectorDimension >:

Detailed Description

template<typename T, unsigned int NVectorDimension = 3>
class itk::CovariantVector< T, NVectorDimension >

A templated class holding a n-Dimensional covariant vector.

CovariantVector is a templated class that holds a single vector (i.e., an array of values). CovariantVector can be used as the data type held at each pixel in an Image or at each vertex of an Mesh. The template parameter T can be any data type that behaves like a primitive (or atomic) data type (int, short, float, complex). The NVectorDimension defines the number of components in the vector array.

CovariantVector is not a dynamically extendible array like std::vector. It is intended to be used like a mathematical vector.

If you wish a simpler pixel types, you can use Scalar, which represents a single data value at a pixel. There is also the more complex type ScalarCovariantVector, which supports (for a given pixel) a single scalar value plus an array of vector values. (The scalar and vectors can be of different data type.)

CovariantVector is the type that should be used for representing normals to surfaces and gradients of functions. AffineTransform transform covariant vectors different than vectors.

See Also
Image
Mesh
Point
Vector
Matrix
Wiki Examples:
Examples:
DataRepresentation/Image/ImageAdaptor3.cxx, DataRepresentation/Mesh/PointSetWithCovariantVectors.cxx, Filtering/GradientRecursiveGaussianImageFilter.cxx, Filtering/VectorCurvatureAnisotropicDiffusionImageFilter.cxx, Filtering/VectorGradientAnisotropicDiffusionImageFilter.cxx, IO/CovariantVectorImageExtractComponent.cxx, IO/CovariantVectorImageRead.cxx, and IO/CovariantVectorImageWrite.cxx.

Definition at line 67 of file itkCovariantVector.h.

Public Types

typedef FixedArray< T,
NVectorDimension > 
BaseArray
 
typedef T ComponentType
 
typedef Self CovariantVectorType
 
typedef NumericTraits
< ValueType >::RealType 
RealValueType
 
typedef CovariantVector Self
 
typedef FixedArray< T,
NVectorDimension > 
Superclass
 
typedef T ValueType
 
- Public Types inherited from itk::FixedArray< T, NVectorDimension >
typedef ValueType CArray [VLength]
 
typedef const ValueTypeconst_pointer
 
typedef const ValueTypeconst_reference
 
typedef const ValueTypeConstIterator
 
typedef ValueTypeIterator
 
typedef ValueTypepointer
 
typedef ValueTypereference
 
typedef unsigned int SizeType
 
typedef T ValueType
 

Public Member Functions

 CovariantVector ()
 
 CovariantVector (const ValueType &r)
 
RealValueType GetNorm (void) const
 
RealValueType GetSquaredNorm (void) const
 
vnl_vector_ref< T > GetVnlVector (void)
 
vnl_vector< T > GetVnlVector (void) const
 
 itkLegacyMacro (void Set_vnl_vector(const vnl_vector< T > &))
 
 itkLegacyMacro (vnl_vector_ref< T > Get_vnl_vector(void))
 
 itkLegacyMacro (vnl_vector< T > Get_vnl_vector(void) const)
 
void Normalize (void)
 
ValueType operator* (const Self &vec) const
 
ValueType operator* (const Vector< T, NVectorDimension > &vec) const
 
Self operator* (const ValueType &val) const
 
Self operator+ (const Self &vec) const
 
const Selfoperator+= (const Self &vec)
 
Self operator- () const
 
Self operator- (const Self &vec) const
 
const Selfoperator-= (const Self &vec)
 
template<typename Tt >
Self operator/ (const Tt &val) const
 
CovariantVectoroperator= (const Self &r)
 
CovariantVectoroperator= (const ValueType r[NVectorDimension])
 
void SetVnlVector (const vnl_vector< T > &)
 
template<typename TVectorValueType >
 CovariantVector (const CovariantVector< TVectorValueType, NVectorDimension > &r)
 
 CovariantVector (const ValueType r[Dimension])
 
template<typename Tt >
Selfoperator= (const Tt &v)
 
template<typename Tt >
const Selfoperator*= (const Tt &value)
 
template<typename Tt >
const Selfoperator/= (const Tt &value)
 
template<typename TCoordRepB >
void CastFrom (const CovariantVector< TCoordRepB, NVectorDimension > &pa)
 
- Public Member Functions inherited from itk::FixedArray< T, NVectorDimension >
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
void Fill (const ValueType &)
 
 FixedArray (const TScalarValue *r)
 
ValueTypeGetDataPointer ()
 
const ValueTypeGetDataPointer () const
 
bool operator!= (const FixedArray &r) const
 
FixedArrayoperator= (const ValueType r[VLength])
 
bool operator== (const FixedArray &r) const
 
ReverseIterator rBegin ()
 
ConstReverseIterator rBegin () const
 
ReverseIterator rEnd ()
 
ConstReverseIterator rEnd () const
 
SizeType Size () const
 
 FixedArray ()
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &r)
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArrayoperator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
reference operator[] (short index)
 
const_reference operator[] (short index) const
 
reference operator[] (unsigned short index)
 
const_reference operator[] (unsigned short index) const
 
reference operator[] (int index)
 
const_reference operator[] (int index) const
 
reference operator[] (unsigned int index)
 
const_reference operator[] (unsigned int index) const
 
reference operator[] (long index)
 
const_reference operator[] (long index) const
 
reference operator[] (unsigned long index)
 
const_reference operator[] (unsigned long index) const
 
reference operator[] (long long index)
 
const_reference operator[] (long long index) const
 
reference operator[] (unsigned long long index)
 
const_reference operator[] (unsigned long long index) const
 
void SetElement (unsigned short index, const_reference value)
 
const_reference GetElement (unsigned short index) const
 

Static Public Member Functions

static unsigned int GetCovariantVectorDimension ()
 
static unsigned int GetNumberOfComponents ()
 
- Static Public Member Functions inherited from itk::FixedArray< T, NVectorDimension >
static FixedArray Filled (const ValueType &)
 

Static Public Attributes

static const unsigned int Dimension = NVectorDimension
 
- Static Public Attributes inherited from itk::FixedArray< T, NVectorDimension >
static const unsigned int Dimension
 
static const unsigned int Length
 

Member Typedef Documentation

template<typename T, unsigned int NVectorDimension = 3>
typedef FixedArray< T, NVectorDimension > itk::CovariantVector< T, NVectorDimension >::BaseArray

The Array type from which this CovariantVector is derived.

Definition at line 89 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef T itk::CovariantVector< T, NVectorDimension >::ComponentType

Component value type

Definition at line 80 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef Self itk::CovariantVector< T, NVectorDimension >::CovariantVectorType

I am a covariant vector.

Definition at line 86 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef NumericTraits< ValueType >::RealType itk::CovariantVector< T, NVectorDimension >::RealValueType

Definition at line 77 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef CovariantVector itk::CovariantVector< T, NVectorDimension >::Self

Standard class typedefs.

Definition at line 71 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef FixedArray< T, NVectorDimension > itk::CovariantVector< T, NVectorDimension >::Superclass

Definition at line 72 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
typedef T itk::CovariantVector< T, NVectorDimension >::ValueType

ValueType can be used to declare a variable that is the same type as a data element held in an CovariantVector.

Definition at line 76 of file itkCovariantVector.h.

Constructor & Destructor Documentation

template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::CovariantVector ( )
inline

Default constructor and copy constructors.

Definition at line 117 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::CovariantVector ( const ValueType r)
template<typename T, unsigned int NVectorDimension = 3>
template<typename TVectorValueType >
itk::CovariantVector< T, NVectorDimension >::CovariantVector ( const CovariantVector< TVectorValueType, NVectorDimension > &  r)
inline

Pass-through constructor for the Array base class. Implicit casting is performed to initialize constructor from any another one of datatype.

Definition at line 123 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::CovariantVector ( const ValueType  r[Dimension])
inline

Pass-through constructor for the Array base class. Implicit casting is performed to initialize constructor from any another one of datatype.

Definition at line 125 of file itkCovariantVector.h.

Member Function Documentation

template<typename T, unsigned int NVectorDimension = 3>
template<typename TCoordRepB >
void itk::CovariantVector< T, NVectorDimension >::CastFrom ( const CovariantVector< TCoordRepB, NVectorDimension > &  pa)
inline

Copy from another CovariantVector with a different representation type. Casting is done with C-Like rules

Definition at line 234 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
static unsigned int itk::CovariantVector< T, NVectorDimension >::GetCovariantVectorDimension ( )
inlinestatic

Get the dimension (size) of the vector.

Definition at line 92 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
RealValueType itk::CovariantVector< T, NVectorDimension >::GetNorm ( void  ) const

Returns the Euclidean Norm of the vector

template<typename T, unsigned int NVectorDimension = 3>
static unsigned int itk::CovariantVector< T, NVectorDimension >::GetNumberOfComponents ( )
inlinestatic

Returns the number of components in this vector type

Definition at line 223 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
RealValueType itk::CovariantVector< T, NVectorDimension >::GetSquaredNorm ( void  ) const

Returns vector's Squared Euclidean Norm

template<typename T, unsigned int NVectorDimension = 3>
vnl_vector_ref< T > itk::CovariantVector< T, NVectorDimension >::GetVnlVector ( void  )

Get a vnl_vector_ref referencing the same memory block.

template<typename T, unsigned int NVectorDimension = 3>
vnl_vector< T > itk::CovariantVector< T, NVectorDimension >::GetVnlVector ( void  ) const

Get a vnl_vector with a copy of the internal memory block.

template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::itkLegacyMacro ( void   Set_vnl_vectorconst vnl_vector< T > &)

Set a vnl_vector_ref referencing the same memory block.

Deprecated:
Use SetVnlVector() instead.
template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::itkLegacyMacro ( vnl_vector_ref< T >   Get_vnl_vectorvoid)

Get a vnl_vector_ref referencing the same memory block.

Deprecated:
Use GetVnlVector() instead.
template<typename T, unsigned int NVectorDimension = 3>
itk::CovariantVector< T, NVectorDimension >::itkLegacyMacro ( vnl_vector< T > Get_vnl_vector(void)  const)

Get a vnl_vector with a copy of the internal memory block.

Deprecated:
Use GetVnlVector() instead.
template<typename T, unsigned int NVectorDimension = 3>
void itk::CovariantVector< T, NVectorDimension >::Normalize ( void  )

Divides the covariant vector componets by the norm

template<typename T, unsigned int NVectorDimension = 3>
ValueType itk::CovariantVector< T, NVectorDimension >::operator* ( const Self vec) const

CovariantVector operator*. Performs the inner product of two covariant vectors.

Warning
This is equivalent to the scalar product only if the reference system has orthogonal axis and equal scales.
template<typename T, unsigned int NVectorDimension = 3>
ValueType itk::CovariantVector< T, NVectorDimension >::operator* ( const Vector< T, NVectorDimension > &  vec) const

operator*. Performs the scalar product with a vector (contravariant). This scalar product is invariant under affine transformations

template<typename T, unsigned int NVectorDimension = 3>
Self itk::CovariantVector< T, NVectorDimension >::operator* ( const ValueType val) const
inline

Scalar operator*. Scale the elements of a vector by a scalar. Return a new vector.

Definition at line 194 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
template<typename Tt >
const Self& itk::CovariantVector< T, NVectorDimension >::operator*= ( const Tt &  value)
inline

Scalar operator*=. Scales elements by a scalar.

Definition at line 144 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
Self itk::CovariantVector< T, NVectorDimension >::operator+ ( const Self vec) const

CovariantVector addition. Add two vectors. Return a new vector.

template<typename T, unsigned int NVectorDimension = 3>
const Self& itk::CovariantVector< T, NVectorDimension >::operator+= ( const Self vec)

CovariantVector operator+=. Adds a vectors to the current vector.

template<typename T, unsigned int NVectorDimension = 3>
Self itk::CovariantVector< T, NVectorDimension >::operator- ( ) const

CovariantVector negation. Negate all the elements of a vector. Return a new vector

template<typename T, unsigned int NVectorDimension = 3>
Self itk::CovariantVector< T, NVectorDimension >::operator- ( const Self vec) const

CovariantVector subtraction. Subtract two vectors. Return a new vector.

template<typename T, unsigned int NVectorDimension = 3>
const Self& itk::CovariantVector< T, NVectorDimension >::operator-= ( const Self vec)

CovariantVector operator-=. Subtracts a vector from a current vector.

template<typename T, unsigned int NVectorDimension = 3>
template<typename Tt >
Self itk::CovariantVector< T, NVectorDimension >::operator/ ( const Tt &  val) const
inline

Scalar operator/. Scale (divide) the elements of a vector by a scalar. Return a new vector.

Definition at line 208 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
template<typename Tt >
const Self& itk::CovariantVector< T, NVectorDimension >::operator/= ( const Tt &  value)
inline

Scalar operator/=. Scales (divides) elements by a scalar.

Definition at line 156 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
template<typename Tt >
Self& itk::CovariantVector< T, NVectorDimension >::operator= ( const Tt &  v)
inline

Assignment operator with implicit casting from another data type

Definition at line 130 of file itkCovariantVector.h.

template<typename T, unsigned int NVectorDimension = 3>
CovariantVector& itk::CovariantVector< T, NVectorDimension >::operator= ( const Self r)

Pass-through assignment operator for the Array base class.

template<typename T, unsigned int NVectorDimension = 3>
CovariantVector& itk::CovariantVector< T, NVectorDimension >::operator= ( const ValueType  r[NVectorDimension])
template<typename T, unsigned int NVectorDimension = 3>
void itk::CovariantVector< T, NVectorDimension >::SetVnlVector ( const vnl_vector< T > &  )

Set a vnl_vector_ref referencing the same memory block.

Member Data Documentation

template<typename T, unsigned int NVectorDimension = 3>
const unsigned int itk::CovariantVector< T, NVectorDimension >::Dimension = NVectorDimension
static

Dimension of the Space

Definition at line 83 of file itkCovariantVector.h.


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