itk::CovariantVector< T, NVectorDimension > Class Template Reference
[Geometry Representation Objects, Data Representation Objects]

#include <itkCovariantVector.h>

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

[legend]Collaboration diagram for itk::CovariantVector< T, NVectorDimension >:

[legend]List of all members.

---

Detailed Description

template<class 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

Definition at line 64 of file itkCovariantVector.h.

Public Types
typedef FixedArray< T, NVectorDimension >	BaseArray
typedef Self	CovariantVectorType
typedef NumericTraits< ValueType >::RealType	RealValueType
typedef CovariantVector	Self
typedef FixedArray< T, NVectorDimension >	Superclass
typedef T	ValueType
Public Member Functions
template<typename TCoordRepB>
Copy from another CovariantVector with a different representation type *Casting is done with C Like rules *void	CastFrom (const CovariantVector< TCoordRepB, NVectorDimension > &pa)
	CovariantVector (const ValueType r[Dimension])
Pass through constructor for the Array base class *	CovariantVector (const Self &r)
	CovariantVector (const ValueType &r)
	CovariantVector ()
vnl_vector< T >	Get_vnl_vector (void) const
vnl_vector_ref< T >	Get_vnl_vector (void)
RealValueType	GetNorm (void) const
RealValueType	GetSquaredNorm (void) const
vnl_vector< T >	GetVnlVector (void) const
vnl_vector_ref< T >	GetVnlVector (void)
	itkStaticConstMacro (Dimension, unsigned int, NVectorDimension)
void	Normalize (void)
ValueType	operator * (const Vector< T, NVectorDimension > &vec) const
ValueType	operator * (const Self &vec) const
Scalar	operator *.Scale the elements of a vector by a scalar.*Return a new vector.*/inline Self operator * (const ValueType &val) const
Scalar	operator *=.Scales elements by a scalar.*/template (const Tt &value)
Pass through assignment	operator for the Array base class.*/CovariantVector &operator= (const Self &r)
Assignment	operator with implicit casting from another data type */template (const Tt &v)
Self	operator+ (const Self &vec) const
Self	operator- (const Self &vec) const
Self	operator- () const
const Self &	operator-= (const Self &vec)
Scalar	operator/.Scale (divide) the elements of a vector by a scalar.*Return a new vector.*/template< class Tt > inline Self operator/(const Tt &val) const
Scalar	operator/=.Scales (divides) elements by a scalar.*/template< class Tt > const Self &operator/
CovariantVector &	operator= (const ValueType r[NVectorDimension])
void	Set_vnl_vector (const vnl_vector< T > &)
void	SetVnlVector (const vnl_vector< T > &)
Static Public Member Functions
static unsigned int	GetCovariantVectorDimension ()
static unsigned int	GetNumberOfComponents ()

---

Member Typedef Documentation

template<class 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 83 of file itkCovariantVector.h.

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

I am a covariant vector. Definition at line 80 of file itkCovariantVector.h.

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

Definition at line 74 of file itkCovariantVector.h.

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

Standard class typedefs. Definition at line 68 of file itkCovariantVector.h.

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

Definition at line 69 of file itkCovariantVector.h.

template<class 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 73 of file itkCovariantVector.h.

---

Constructor & Destructor Documentation

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

Default constructor has nothing to do. Definition at line 113 of file itkCovariantVector.h.

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

template<class T, unsigned int NVectorDimension = 3> Pass through constructor for the Array base class* itk::CovariantVector< T, NVectorDimension >::CovariantVector (  const Self &  r  )  [inline]

Definition at line 117 of file itkCovariantVector.h.

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

Definition at line 118 of file itkCovariantVector.h.

---

Member Function Documentation

template<class T, unsigned int NVectorDimension = 3> template<typename TCoordRepB> Copy from another CovariantVector with a different representation type* Casting is done with C Like rules* void itk::CovariantVector< T, NVectorDimension >::CastFrom (  const CovariantVector< TCoordRepB, NVectorDimension > &  pa  )  [inline]

Definition at line 222 of file itkCovariantVector.h.

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

Get a vnl_vector with a copy of the internal memory block. Deprecated: Use GetVnlVector() instead.

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

Get a vnl_vector_ref referencing the same memory block. Deprecated: Use GetVnlVector() instead.

template<class T, unsigned int NVectorDimension = 3> static unsigned int itk::CovariantVector< T, NVectorDimension >::GetCovariantVectorDimension (   )  [inline, static]

Get the dimension (size) of the vector. Definition at line 86 of file itkCovariantVector.h.

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

Returns the Euclidean Norm of the vector

template<class T, unsigned int NVectorDimension = 3> static unsigned int itk::CovariantVector< T, NVectorDimension >::GetNumberOfComponents (   )  [inline, static]

Returns the number of components in this vector type Definition at line 211 of file itkCovariantVector.h.

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

Returns vector's Squared Euclidean Norm

template<class 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<class 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<class T, unsigned int NVectorDimension = 3> itk::CovariantVector< T, NVectorDimension >::itkStaticConstMacro (  Dimension  , unsigned  int, NVectorDimension  )

Dimension of the Space

template<class T, unsigned int NVectorDimension = 3> void itk::CovariantVector< T, NVectorDimension >::Normalize (  void   )

Divides the covariant vector componets by the norm

template<class 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<class 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<class T, unsigned int NVectorDimension = 3> Scalar itk::CovariantVector< T, NVectorDimension >::operator *.Scale the elements of a vector by a scalar.*Return a new vector.*/inline Self operator * (  const ValueType &  val  )  const [inline]

Definition at line 183 of file itkCovariantVector.h.

template<class T, unsigned int NVectorDimension = 3> Scalar itk::CovariantVector< T, NVectorDimension >::operator *=.Scales elements by a scalar.*/template (  const Tt &  value  )  [inline]

Definition at line 136 of file itkCovariantVector.h.

template<class T, unsigned int NVectorDimension = 3> Pass through assignment itk::CovariantVector< T, NVectorDimension >::operator for the Array base class.*/CovariantVector &operator= (  const Self &  r  )

template<class T, unsigned int NVectorDimension = 3> Assignment itk::CovariantVector< T, NVectorDimension >::operator with implicit casting from another data type */template (  const Tt &  v  )  [inline]

Definition at line 123 of file itkCovariantVector.h.

template<class 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<class 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<class 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<class 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<class T, unsigned int NVectorDimension = 3> Scalar itk::CovariantVector< T, NVectorDimension >::operator/.Scale (  divide   )  const [inline]

Definition at line 194 of file itkCovariantVector.h.

template<class T, unsigned int NVectorDimension = 3> Scalar itk::CovariantVector< T, NVectorDimension >::operator/=.Scales (  divides   )  const

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

template<class T, unsigned int NVectorDimension = 3> void itk::CovariantVector< T, NVectorDimension >::Set_vnl_vector (  const vnl_vector< T > &   )

Set a vnl_vector_ref referencing the same memory block. Deprecated: Use SetVnlVector() instead.

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

---

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

• itkCovariantVector.h

---