A templated class holding a n-Dimensional covariant vector. More...

#include <itkCovariantVector.h>

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

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

Public Types
typedef FixedArray< T, NVectorDimension >	BaseArray
typedef ValueType	CArray [VLength]
typedef const ValueType *	const_pointer
typedef const ValueType &	const_reference
typedef const ValueType *	ConstIterator
typedef Self	CovariantVectorType
typedef ValueType *	Iterator
typedef ValueType *	pointer
typedef NumericTraits < ValueType >::RealType	RealValueType
typedef ValueType &	reference
typedef CovariantVector	Self
typedef unsigned int	SizeType
typedef FixedArray< T, NVectorDimension >	Superclass
typedef T	ValueType

Public Member Functions
	CovariantVector ()
	CovariantVector (const ValueType &r)
template<class TVectorValueType >
	CovariantVector (const CovariantVector< TVectorValueType, NVectorDimension > &r)
	CovariantVector (const ValueType r[Dimension])
Iterator	Begin ()
ConstIterator	Begin () const
template<typename TCoordRepB >
void	CastFrom (const CovariantVector< TCoordRepB, NVectorDimension > &pa)
Iterator	End ()
ConstIterator	End () const
void	Fill (const ValueType &)
vnl_vector_ref< T >	Get_vnl_vector (void)
vnl_vector< T >	Get_vnl_vector (void) const
ValueType *	GetDataPointer ()
const ValueType *	GetDataPointer () const
const_reference	GetElement (unsigned short index) const
RealValueType	GetNorm (void) const
RealValueType	GetSquaredNorm (void) const
vnl_vector_ref< T >	GetVnlVector (void)
vnl_vector< T >	GetVnlVector (void) const
void	Normalize (void)
bool	operator!= (const FixedArray &r) const
ValueType	operator* (const Self &vec) const
ValueType	operator* (const Vector< T, NVectorDimension > &vec) const
Self	operator* (const ValueType &val) const
template<class Tt >
const Self &	operator*= (const Tt &value)
Self	operator+ (const Self &vec) const
const Self &	operator+= (const Self &vec)
Self	operator- () const
Self	operator- (const Self &vec) const
const Self &	operator-= (const Self &vec)
template<class Tt >
Self	operator/ (const Tt &val) const
template<class Tt >
const Self &	operator/= (const Tt &value)
template<class Tt >
Self &	operator= (const Tt &v)
CovariantVector &	operator= (const Self &r)
CovariantVector &	operator= (const ValueType r[NVectorDimension])
bool	operator== (const FixedArray &r) const
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
ReverseIterator	rBegin ()
ConstReverseIterator	rBegin () const
ReverseIterator	rEnd ()
ConstReverseIterator	rEnd () const
void	Set_vnl_vector (const vnl_vector< T > &)
void	SetElement (unsigned short index, const_reference value)
void	SetVnlVector (const vnl_vector< T > &)
SizeType	Size () const

Static Public Member Functions
static FixedArray	Filled (const ValueType &)
static unsigned int	GetCovariantVectorDimension ()
static unsigned int	GetNumberOfComponents ()

Static Public Attributes
static const unsigned int	Dimension = NVectorDimension
static const unsigned int	Length

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

Examples:: FeatureExtraction/ExtractRoadByStepsExample.cxx.

Definition at line 64 of file itkCovariantVector.h.

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 84 of file itkCovariantVector.h.

typedef ValueType itk::FixedArray< T , VLength >::CArray[VLength]

inherited

A type representing the C-array version of this FixedArray.

Definition at line 77 of file itkFixedArray.h.

typedef const ValueType* itk::FixedArray< T , VLength >::const_pointer

inherited

A const pointer to the ValueType.

Definition at line 129 of file itkFixedArray.h.

typedef const ValueType& itk::FixedArray< T , VLength >::const_reference

inherited

A const reference to the ValueType.

Definition at line 135 of file itkFixedArray.h.

typedef const ValueType* itk::FixedArray< T , VLength >::ConstIterator

inherited

A const iterator through the array.

Definition at line 83 of file itkFixedArray.h.

template<class T, unsigned int NVectorDimension = 3>

typedef Self itk::CovariantVector< T, NVectorDimension >::CovariantVectorType

I am a covariant vector.

Definition at line 81 of file itkCovariantVector.h.

typedef ValueType* itk::FixedArray< T , VLength >::Iterator

inherited

An iterator through the array.

Definition at line 80 of file itkFixedArray.h.

typedef ValueType* itk::FixedArray< T , VLength >::pointer

inherited

A pointer to the ValueType.

Definition at line 126 of file itkFixedArray.h.

template<class T, unsigned int NVectorDimension = 3>

typedef NumericTraits< ValueType >::RealType itk::CovariantVector< T, NVectorDimension >::RealValueType

Definition at line 75 of file itkCovariantVector.h.

typedef ValueType& itk::FixedArray< T , VLength >::reference

inherited

A reference to the ValueType.

Definition at line 132 of file itkFixedArray.h.

template<class T, unsigned int NVectorDimension = 3>

typedef CovariantVector itk::CovariantVector< T, NVectorDimension >::Self

Standard class typedefs.

Definition at line 69 of file itkCovariantVector.h.

typedef unsigned int itk::FixedArray< T , VLength >::SizeType

inherited

Definition at line 137 of file itkFixedArray.h.

template<class T, unsigned int NVectorDimension = 3>

typedef FixedArray<T,NVectorDimension> itk::CovariantVector< T, NVectorDimension >::Superclass

Definition at line 70 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.

Reimplemented from itk::FixedArray< T, NVectorDimension >.

Definition at line 74 of file itkCovariantVector.h.

Constructor & Destructor Documentation

template<class T, unsigned int NVectorDimension = 3>

itk::CovariantVector< T, NVectorDimension >::CovariantVector ( )

inline

Default constructor and copy constructors.

Definition at line 113 of file itkCovariantVector.h.

template<class T , unsigned int TVectorDimension>

itk::CovariantVector< T, TVectorDimension >::CovariantVector ( const ValueType & r )

Constructor to initialize entire vector to one value.

Definition at line 32 of file itkCovariantVector.txx.

template<class T, unsigned int NVectorDimension = 3>

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

template<class T, unsigned int NVectorDimension = 3>

itk::CovariantVector< T, NVectorDimension >::CovariantVector ( const ValueType r[Dimension] )

inline

Definition at line 121 of file itkCovariantVector.h.

Member Function Documentation

Iterator itk::FixedArray< T , VLength >::Begin ( void )

inherited

Get various iterators to the array.

Get an Iterator for the beginning of the FixedArray.

ConstIterator itk::FixedArray< T , VLength >::Begin ( void ) const

inherited

Get a ConstIterator for the beginning of the FixedArray.

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

Iterator itk::FixedArray< T , VLength >::End ( void )

inherited

Get an Iterator for the end of the FixedArray.

ConstIterator itk::FixedArray< T , VLength >::End ( void ) const

inherited

Get a ConstIterator for the end of the FixedArray.

void itk::FixedArray< T , VLength >::Fill ( const ValueType & )

inherited

Fill all elements of the array with the given value.

Referenced by itk::VectorFuzzyConnectednessImageFilter< TInputImage, TOutputImage >::Compute_Scale(), and itk::MetaDTITubeConverter< NDimensions >::MetaDTITubeToDTITubeSpatialObject().

static FixedArray itk::FixedArray< T , VLength >::Filled ( const ValueType & )

staticinherited

Return an FixedArray with all elements assigned to the given value.

template<class T , unsigned int NVectorDimension>

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.

Return a vnl_vector_ref

Definition at line 285 of file itkCovariantVector.txx.

Referenced by itk::DeformableSimplexMesh3DGradientConstraintForceFilter< TInputMesh, TOutputMesh >::ComputeExternalForce(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::ComputeExternalForce(), and itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::ComputeGeometry().

template<class T , unsigned int NVectorDimension>

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.

Return a vnl_vector const

Definition at line 297 of file itkCovariantVector.txx.

template<class T, unsigned int NVectorDimension = 3>

static unsigned int itk::CovariantVector< T, NVectorDimension >::GetCovariantVectorDimension ( )

inlinestatic

Get the dimension (size) of the vector.

Definition at line 87 of file itkCovariantVector.h.

ValueType* itk::FixedArray< T , VLength >::GetDataPointer ( )

inlineinherited

Return a pointer to the data.

Definition at line 216 of file itkFixedArray.h.

Referenced by itk::MetaArrayWriter::SetInput().

const ValueType* itk::FixedArray< T , VLength >::GetDataPointer ( ) const

inlineinherited

Definition at line 217 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::GetElement ( unsigned short index ) const

inlineinherited

Definition at line 213 of file itkFixedArray.h.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::RealValueType itk::CovariantVector< T, NVectorDimension >::GetNorm ( void ) const

Returns the Euclidean Norm of the vector

Returns vector's Euclidean Norm

Definition at line 198 of file itkCovariantVector.txx.

Referenced by itk::BloxBoundaryProfileImageToBloxCoreAtomImageFilter< TInputImage, TOutputImage, TSourceImage >::FindCoreAtomsAtBoundaryPoint(), itk::BloxBoundaryPointToCoreAtomImageFilter< dim >::FindCoreAtomsAtBoundaryPoint(), and itk::BloxBoundaryPointImageToBloxBoundaryProfileImageFilter< TSourceImage >::GenerateData().

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

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::RealValueType itk::CovariantVector< T, NVectorDimension >::GetSquaredNorm ( void ) const

Returns vector's Squared Euclidean Norm

Definition at line 181 of file itkCovariantVector.txx.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate().

template<class T , unsigned int NVectorDimension>

vnl_vector_ref< T > itk::CovariantVector< T, NVectorDimension >::GetVnlVector ( void )

Get a vnl_vector_ref referencing the same memory block.

Return a vnl_vector_ref

Definition at line 241 of file itkCovariantVector.txx.

Referenced by itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::ComputeCellParameters(), itk::DeformableSimplexMesh3DBalloonForceFilter< TInputMesh, TOutputMesh >::ComputeExternalForce(), itk::BloxBoundaryProfileImageToBloxCoreAtomImageFilter< TInputImage, TOutputImage, TSourceImage >::FindCoreAtomsAtBoundaryPoint(), itk::BloxBoundaryPointToCoreAtomImageFilter< dim >::FindCoreAtomsAtBoundaryPoint(), and itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetOriginGradient().

template<class T , unsigned int NVectorDimension>

vnl_vector< T > itk::CovariantVector< T, NVectorDimension >::GetVnlVector ( void ) const

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

Return a vnl_vector const

Definition at line 253 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

void itk::CovariantVector< T, NVectorDimension >::Normalize ( void )

Divides the covariant vector componets by the norm

Divide vector's components by vector's norm

Definition at line 210 of file itkCovariantVector.txx.

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::ComputeGeometry(), and itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >::ComputeNormal().

bool itk::FixedArray< T , VLength >::operator!= ( const FixedArray< T, NVectorDimension > & r ) const

inlineinherited

Definition at line 191 of file itkFixedArray.h.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::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.

Definition at line 147 of file itkCovariantVector.txx.

template<class T, unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::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

Definition at line 164 of file itkCovariantVector.txx.

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

template<class T, unsigned int NVectorDimension = 3>

template<class Tt >

const Self& itk::CovariantVector< T, NVectorDimension >::operator*= ( const Tt & value )

inline

Scalar operator*=. Scales elements by a scalar.

Definition at line 136 of file itkCovariantVector.h.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::Self itk::CovariantVector< T, NVectorDimension >::operator+ ( const Self & vec ) const

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

Returns a temporary copy of a vector

Definition at line 114 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

const CovariantVector< T, NVectorDimension >::Self & itk::CovariantVector< T, NVectorDimension >::operator+= ( const Self & vec )

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

Definition at line 66 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension > itk::CovariantVector< T, NVectorDimension >::operator- ( ) const

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

Returns a temporary copy of a vector

Definition at line 98 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension >::Self itk::CovariantVector< T, NVectorDimension >::operator- ( const Self & vec ) const

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

Returns a temporary copy of a vector

Definition at line 130 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

const CovariantVector< T, NVectorDimension >::Self & itk::CovariantVector< T, NVectorDimension >::operator-= ( const Self & vec )

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

Definition at line 82 of file itkCovariantVector.txx.

template<class T, unsigned int NVectorDimension = 3>

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

template<class T, unsigned int NVectorDimension = 3>

template<class Tt >

const Self& itk::CovariantVector< T, NVectorDimension >::operator/= ( const Tt & value )

inline

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

Definition at line 146 of file itkCovariantVector.h.

template<class T, unsigned int NVectorDimension = 3>

template<class Tt >

Self& itk::CovariantVector< T, NVectorDimension >::operator= ( const Tt & v )

inline

Assignment operator with implicit casting from another data type

Definition at line 125 of file itkCovariantVector.h.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension > & itk::CovariantVector< T, NVectorDimension >::operator= ( const Self & r )

Pass-through assignment operator for the Array base class.

Definition at line 43 of file itkCovariantVector.txx.

template<class T , unsigned int NVectorDimension>

CovariantVector< T, NVectorDimension > & itk::CovariantVector< T, NVectorDimension >::operator= ( const ValueType r[NVectorDimension] )

Definition at line 53 of file itkCovariantVector.txx.

bool itk::FixedArray< T , VLength >::operator== ( const FixedArray< T, NVectorDimension > & r ) const

inherited

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

Operator != compares different types of arrays.

Referenced by itk::Vector< CoordRepType, itkGetStaticConstMacro(SpaceDimension)>::operator==().

reference itk::FixedArray< T , VLength >::operator[] ( short index )

inlineinherited

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 197 of file itkFixedArray.h.

Referenced by itk::Vector< CoordRepType, itkGetStaticConstMacro(SpaceDimension)>::SetNthComponent().

const_reference itk::FixedArray< T , VLength >::operator[] ( short index ) const

inlineinherited

Definition at line 198 of file itkFixedArray.h.

reference itk::FixedArray< T , VLength >::operator[] ( unsigned short index )

inlineinherited

Definition at line 199 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::operator[] ( unsigned short index ) const

inlineinherited

Definition at line 200 of file itkFixedArray.h.

reference itk::FixedArray< T , VLength >::operator[] ( int index )

inlineinherited

Definition at line 201 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::operator[] ( int index ) const

inlineinherited

Definition at line 202 of file itkFixedArray.h.

reference itk::FixedArray< T , VLength >::operator[] ( unsigned int index )

inlineinherited

Definition at line 203 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::operator[] ( unsigned int index ) const

inlineinherited

Definition at line 204 of file itkFixedArray.h.

reference itk::FixedArray< T , VLength >::operator[] ( long index )

inlineinherited

Definition at line 205 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::operator[] ( long index ) const

inlineinherited

Definition at line 206 of file itkFixedArray.h.

reference itk::FixedArray< T , VLength >::operator[] ( unsigned long index )

inlineinherited

Definition at line 207 of file itkFixedArray.h.

const_reference itk::FixedArray< T , VLength >::operator[] ( unsigned long index ) const

inlineinherited

Definition at line 208 of file itkFixedArray.h.

ReverseIterator itk::FixedArray< T , VLength >::rBegin ( )

inherited

Get a begin ReverseIterator.

ConstReverseIterator itk::FixedArray< T , VLength >::rBegin ( ) const

inherited

Get a begin ConstReverseIterator.

ReverseIterator itk::FixedArray< T , VLength >::rEnd ( )

inherited

Get an end ReverseIterator.

ConstReverseIterator itk::FixedArray< T , VLength >::rEnd ( ) const

inherited

Get an end ConstReverseIterator.

template<class T, unsigned int NVectorDimension>

void itk::CovariantVector< T, NVectorDimension >::Set_vnl_vector ( const vnl_vector< T > & v )

Set a vnl_vector_ref referencing the same memory block.

Deprecated:: Use SetVnlVector() instead.

Set a vnl_vector

Definition at line 270 of file itkCovariantVector.txx.

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::ComputeGeometry().

void itk::FixedArray< T , VLength >::SetElement	(	unsigned short	index,
		const_reference	value
	)

inlineinherited

Set/Get element methods are more convenient in wrapping languages

Definition at line 211 of file itkFixedArray.h.

template<class T, unsigned int NVectorDimension>

void itk::CovariantVector< T, NVectorDimension >::SetVnlVector ( const vnl_vector< T > & v )

Set a vnl_vector_ref referencing the same memory block.

Set a vnl_vector

Definition at line 226 of file itkCovariantVector.txx.

Referenced by itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >::ComputeNormal().

SizeType itk::FixedArray< T , VLength >::Size ( void ) const

inherited

Get the size of the FixedArray.

Member Data Documentation

template<class T, unsigned int NVectorDimension = 3>

const unsigned int itk::CovariantVector< T, NVectorDimension >::Dimension = NVectorDimension

static

Dimension of the Space

Reimplemented from itk::FixedArray< T, NVectorDimension >.

Definition at line 78 of file itkCovariantVector.h.

const unsigned int itk::FixedArray< T , VLength >::Length

staticinherited

Length constant

Definition at line 68 of file itkFixedArray.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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