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:: Examples/DataRepresentation/Image/ImageAdaptor3.cxx, Examples/DataRepresentation/Mesh/PointSetWithCovariantVectors.cxx, Examples/Filtering/GradientRecursiveGaussianImageFilter.cxx, Examples/Filtering/VectorCurvatureAnisotropicDiffusionImageFilter.cxx, Examples/Filtering/VectorGradientAnisotropicDiffusionImageFilter.cxx, Examples/IO/CovariantVectorImageExtractComponent.cxx, Examples/IO/CovariantVectorImageRead.cxx, Examples/IO/CovariantVectorImageWrite.cxx, SphinxExamples/src/Core/Common/CovariantVectorDotProduct/Code.cxx, SphinxExamples/src/Core/Common/CreateACovariantVector/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussian/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussianWithVectorInput/Code.cxx, WikiExamples/EdgesAndGradients/GradientRecursiveGaussianImageFilter.cxx, WikiExamples/ImageProcessing/ImageAdaptorExtractVectorComponent.cxx, WikiExamples/ImageProcessing/NthElementImageAdaptor.cxx, WikiExamples/ImageProcessing/ProcessingNthImageElement.cxx, and WikiExamples/ImageSegmentation/ExtractContourWithSnakes.cxx.

Definition at line 67 of file itkCovariantVector.h.

Public Types
using	BaseArray = FixedArray< T, NVectorDimension >

using	ComponentType = T

using	CovariantVectorType = Self

using	RealValueType = typename NumericTraits< ValueType >::RealType

using	Self = CovariantVector

using	Superclass = FixedArray< T, NVectorDimension >

using	ValueType = T

Public Types inherited from itk::FixedArray< T, NVectorDimension >
typedef ValueType	CArray [VLength]

using	const_pointer = const ValueType *

using	const_reference = const ValueType &

using	ConstIterator = const ValueType *

using	Iterator = ValueType *

using	pointer = ValueType *

using	reference = ValueType &

using	SizeType = unsigned int

using	ValueType = T

Public Member Functions
	CovariantVector (const ValueType &r)

RealValueType	GetNorm () const

RealValueType	GetSquaredNorm () const

vnl_vector_ref< T >	GetVnlVector ()

vnl_vector< T >	GetVnlVector () const

RealValueType	Normalize ()

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 Self &	operator+= (const Self &vec)

Self	operator- () const

Self	operator- (const Self &vec) const

const Self &	operator-= (const Self &vec)

template<typename Tt >
Self	operator/ (const Tt &val) const

CovariantVector &	operator= (const ValueType r[NVectorDimension])

void	SetVnlVector (const vnl_vector< T > &)


	CovariantVector ()=default

	CovariantVector (const CovariantVector &)=default

	CovariantVector (CovariantVector &&)=default

CovariantVector &	operator= (const CovariantVector &)=default

CovariantVector &	operator= (CovariantVector &&)=default

	~CovariantVector ()=default


template<typename TVectorValueType >
	CovariantVector (const CovariantVector< TVectorValueType, NVectorDimension > &r)

	CovariantVector (const ValueType r[Dimension])


template<typename TCovariantVectorValueType >
Self &	operator= (const CovariantVector< TCovariantVectorValueType, NVectorDimension > &r)


template<typename Tt >
const Self &	operator*= (const Tt &value)


template<typename Tt >
const Self &	operator/= (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)

ValueType *	GetDataPointer ()

const ValueType *	GetDataPointer () const

bool	operator!= (const FixedArray &r) const

FixedArray &	operator= (const ValueType r[VLength])

bool	operator== (const FixedArray &r) const

ReverseIterator	rBegin ()

ConstReverseIterator	rBegin () const

ReverseIterator	rEnd ()

ConstReverseIterator	rEnd () const

SizeType	Size () const

void	swap (FixedArray &other)

	FixedArray ()=default

	FixedArray (const FixedArray &)=default

	FixedArray (FixedArray &&)=default

FixedArray &	operator= (const FixedArray &)=default

FixedArray &	operator= (FixedArray &&)=default

	~FixedArray ()=default

	FixedArray (const ValueType r[VLength])

	FixedArray (const ValueType &)

	FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)

FixedArray &	operator= (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 constexpr unsigned int	Dimension = NVectorDimension

Static Public Attributes inherited from itk::FixedArray< T, NVectorDimension >
static constexpr unsigned int	Dimension

static constexpr unsigned int	Length