itk::Vector< T, NVectorDimension > Class Template Reference

#include <itkVector.h>

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

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

Detailed Description

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

A templated class holding a n-Dimensional vector.

Vector is a templated class that holds a single vector (i.e., an array of values). Vector 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.

Vector 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 ScalarVector, 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.)

See Also

Image

Mesh

Point

CovariantVector

Matrix

Wiki Examples:

• All Examples
• Create a vector
• Dot product (inner product) of two vectors

Examples:

Examples/DataRepresentation/Image/Image4.cxx, Examples/DataRepresentation/Image/VectorImage.cxx, Examples/DataRepresentation/Mesh/MeshTraits.cxx, Examples/DataRepresentation/Mesh/PointSetWithVectors.cxx, Examples/Filtering/GradientVectorFlowImageFilter.cxx, Examples/Filtering/WarpImageFilter1.cxx, Examples/IO/VectorImageReadWrite.cxx, Examples/RegistrationITKv3/BSplineWarping1.cxx, Examples/RegistrationITKv3/BSplineWarping2.cxx, Examples/RegistrationITKv3/DeformableRegistration10.cxx, Examples/RegistrationITKv3/DeformableRegistration12.cxx, Examples/RegistrationITKv3/DeformableRegistration13.cxx, Examples/RegistrationITKv3/DeformableRegistration14.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/DeformableRegistration16.cxx, Examples/RegistrationITKv3/DeformableRegistration17.cxx, Examples/RegistrationITKv3/DeformableRegistration2.cxx, Examples/RegistrationITKv3/DeformableRegistration3.cxx, Examples/RegistrationITKv3/DeformableRegistration4.cxx, Examples/RegistrationITKv3/DeformableRegistration5.cxx, Examples/RegistrationITKv3/DeformableRegistration6.cxx, Examples/RegistrationITKv3/DeformableRegistration7.cxx, Examples/RegistrationITKv3/DeformableRegistration8.cxx, Examples/RegistrationITKv3/DeformableRegistration9.cxx, Examples/RegistrationITKv3/DeformationFieldJacobian.cxx, Examples/RegistrationITKv3/DisplacementFieldInitialization.cxx, Examples/RegistrationITKv3/LandmarkWarping2.cxx, Examples/RegistrationITKv3/ThinPlateSplineWarp.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/DisplacementFieldInitialization.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx, Examples/Segmentation/WatershedSegmentation1.cxx, Examples/Statistics/BayesianPluginClassifier.cxx, Examples/Statistics/ExpectationMaximizationMixtureModelEstimator.cxx, Examples/Statistics/GaussianMembershipFunction.cxx, Examples/Statistics/KdTree.cxx, Examples/Statistics/KdTreeBasedKMeansClustering.cxx, Examples/Statistics/ListSample.cxx, Examples/Statistics/MembershipSample.cxx, Examples/Statistics/MembershipSampleGenerator.cxx, Examples/Statistics/NeighborhoodSampler.cxx, Examples/Statistics/SampleSorting.cxx, Examples/Statistics/SampleStatistics.cxx, Examples/Statistics/SampleToHistogramFilter.cxx, Examples/Statistics/SelectiveSubsampleGenerator.cxx, Examples/Statistics/Subsample.cxx, Examples/Statistics/WeightedSampleStatistics.cxx, SphinxExamples/src/Core/Common/CreateAnImageOfVectors/Code.cxx, SphinxExamples/src/Core/Common/CreateAVector/Code.cxx, SphinxExamples/src/Core/Common/ReadWriteVectorImage/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussianWithVectorInput/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/WarpAnImageUsingADeformationField/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/ComputeNormalsOfAMesh/Code.cxx, SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx, WikiExamples/ImageProcessing/UnaryFunctorImageFilter.cxx, WikiExamples/Meshes/QuadEdgeMeshNormalFilter.cxx, WikiExamples/Registration/DeformationFieldTransform.cxx, WikiExamples/Registration/WarpImageFilter.cxx, WikiExamples/SimpleOperations/BresenhamLine.cxx, WikiExamples/SimpleOperations/VariableLengthVector.cxx, WikiExamples/Smoothing/VectorMeanImageFilter.cxx, WikiExamples/Statistics/ExpectationMaximizationMixtureModelEstimator_2D.cxx, WikiExamples/Statistics/KdTree.cxx, WikiExamples/Statistics/KdTreeBasedKMeansClustering1D.cxx, WikiExamples/Statistics/ListSample.cxx, WikiExamples/Statistics/MembershipSample.cxx, and WikiExamples/Statistics/SampleToHistogramFilter.cxx.

Definition at line 62 of file itkVector.h.

Public Types
using	BaseArray = FixedArray< T, NVectorDimension >
using	ComponentType = T
using	RealValueType = typename NumericTraits< ValueType >::RealType
using	Self = Vector
using	Superclass = FixedArray< T, NVectorDimension >
using	ValueType = T
using	VectorType = Self
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
RealValueType	GetNorm () const
RealValueType	GetSquaredNorm () const
vnl_vector_ref< T >	GetVnlVector ()
vnl_vector< T >	GetVnlVector () const
RealValueType	Normalize ()
template<typename TCoordRepB >
	operator Vector< TCoordRepB, NVectorDimension > ()
ValueType	operator* (const Self &vec) const
Self	operator* (const ValueType &value) 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 &value) const
Vector &	operator= (const ValueType r[NVectorDimension])
void	SetNthComponent (int c, const ComponentType &v)
void	SetVnlVector (const vnl_vector< T > &)
	Vector (const ValueType &r)
	Vector ()=default
	Vector (const Vector &)=default
	Vector (Vector &&)=default
Vector &	operator= (const Vector &)=default
Vector &	operator= (Vector &&)=default
	~Vector ()=default
template<typename TVectorValueType >
	Vector (const Vector< TVectorValueType, NVectorDimension > &r)
	Vector (const ValueType r[Dimension])
template<typename TVectorValueType >
Vector &	operator= (const Vector< TVectorValueType, NVectorDimension > &r)
template<typename Tt >
const Self &	operator*= (const Tt &value)
template<typename Tt >
const Self &	operator/= (const Tt &value)
bool	operator== (const Self &v) const
bool	operator!= (const Self &v) const
template<typename TCoordRepB >
void	CastFrom (const Vector< 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	GetNumberOfComponents ()
static unsigned int	GetVectorDimension ()
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

Member Typedef Documentation

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::BaseArray = FixedArray< T, NVectorDimension >

The Array type from which this vector is derived.

Definition at line 84 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::ComponentType = T

Component value type

Definition at line 81 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::RealValueType = typename NumericTraits< ValueType >::RealType

Definition at line 72 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::Self = Vector

Standard class type aliases.

Definition at line 66 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::Superclass = FixedArray< T, NVectorDimension >

Definition at line 67 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::ValueType = T

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

Definition at line 71 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

using itk::Vector< T, NVectorDimension >::VectorType = Self

I am a vector type.

Definition at line 78 of file itkVector.h.

Constructor & Destructor Documentation

template<typename T, unsigned int NVectorDimension = 3>

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

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

itk::Vector< T, NVectorDimension >::Vector ( const Vector< T, NVectorDimension > &  )

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

itk::Vector< T, NVectorDimension >::Vector ( Vector< T, NVectorDimension > &&  )

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

itk::Vector< T, NVectorDimension >::~Vector ( )

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

itk::Vector< T, NVectorDimension >::Vector

(

const ValueType &

r

)

Constructor to initialize entire vector to one value.

Warning

Not intended to convert a scalar value into a Vector filled with that value.

Deprecated:

template<typename T, unsigned int NVectorDimension = 3>

template<typename TVectorValueType >

itk::Vector< T, NVectorDimension >::Vector ( const Vector< TVectorValueType, NVectorDimension > &  r )

inline

Pass-through constructor for the Array base class.

Definition at line 122 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

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

inline

Pass-through constructor for the Array base class.

Definition at line 123 of file itkVector.h.

Member Function Documentation

template<typename T, unsigned int NVectorDimension = 3>

template<typename TCoordRepB >

void itk::Vector< T, NVectorDimension >::CastFrom ( const Vector< TCoordRepB, NVectorDimension > &  pa )

inline

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

Definition at line 237 of file itkVector.h.

Referenced by itk::ImageBase< TImage::ImageDimension >::InternalSetSpacing().

template<typename T, unsigned int NVectorDimension = 3>

RealValueType itk::Vector< T, NVectorDimension >::GetNorm

(

)

const

Returns the Euclidean Norm of the vector

template<typename T, unsigned int NVectorDimension = 3>

static unsigned int itk::Vector< T, NVectorDimension >::GetNumberOfComponents ( )

inlinestatic

Returns the number of components in this vector type

Definition at line 225 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

RealValueType itk::Vector< T, NVectorDimension >::GetSquaredNorm

(

)

const

Returns vector's Squared Euclidean Norm

template<typename T, unsigned int NVectorDimension = 3>

static unsigned int itk::Vector< T, NVectorDimension >::GetVectorDimension ( )

inlinestatic

Get the dimension (size) of the vector.

Definition at line 87 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

vnl_vector_ref< T > itk::Vector< T, NVectorDimension >::GetVnlVector

(

)

Get a vnl_vector_ref referencing the same memory block.

template<typename T, unsigned int NVectorDimension = 3>

vnl_vector< T > itk::Vector< T, NVectorDimension >::GetVnlVector

(

)

const

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

template<typename T, unsigned int NVectorDimension = 3>

RealValueType itk::Vector< T, NVectorDimension >::Normalize

(

)

Divides the vector components by the vector norm (when the norm is not null). The norm used is returned.

template<typename T, unsigned int NVectorDimension = 3>

template<typename TCoordRepB >

itk::Vector< T, NVectorDimension >::operator Vector< TCoordRepB, NVectorDimension > ( )

inline

Definition at line 247 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

bool itk::Vector< T, NVectorDimension >::operator!= ( const Self &  v ) const

inline

Operators == and != compare a vector component by component. All components must be equal for two vectors to be equal. (Of course compile-time constraints on the template parameters length and type prevent comparisons between vectors of different type and length.)

Definition at line 214 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

ValueType itk::Vector< T, NVectorDimension >::operator*

(

const Self &

vec

)

const

Vector operator*. Performs the inner product of two vectors. this is also known as the scalar product.

template<typename T, unsigned int NVectorDimension = 3>

Self itk::Vector< T, NVectorDimension >::operator* ( const ValueType &  value ) const

inline

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

Definition at line 183 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

template<typename Tt >

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

inline

Scalar operator*=. Scales elements by a scalar.

Definition at line 139 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

Self itk::Vector< T, NVectorDimension >::operator+

(

const Self &

vec

)

const

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

template<typename T, unsigned int NVectorDimension = 3>

const Self& itk::Vector< T, NVectorDimension >::operator+=

(

const Self &

vec

)

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

template<typename T, unsigned int NVectorDimension = 3>

Self itk::Vector< T, NVectorDimension >::operator-

(

)

const

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

template<typename T, unsigned int NVectorDimension = 3>

Self itk::Vector< T, NVectorDimension >::operator-

(

const Self &

vec

)

const

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

template<typename T, unsigned int NVectorDimension = 3>

const Self& itk::Vector< T, NVectorDimension >::operator-=

(

const Self &

vec

)

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

template<typename T, unsigned int NVectorDimension = 3>

template<typename Tt >

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

inline

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

Definition at line 197 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

template<typename Tt >

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

inline

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

Definition at line 151 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

Vector& itk::Vector< T, NVectorDimension >::operator= ( const Vector< T, NVectorDimension > &  )

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

Vector& itk::Vector< T, NVectorDimension >::operator= ( Vector< T, NVectorDimension > &&  )

default

Default constructors, assignments and destructor

template<typename T, unsigned int NVectorDimension = 3>

template<typename TVectorValueType >

Vector& itk::Vector< T, NVectorDimension >::operator= ( const Vector< TVectorValueType, NVectorDimension > &  r )

inline

Pass-through assignment operator for the Array base class.

Definition at line 128 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

Vector& itk::Vector< T, NVectorDimension >::operator=

(

const ValueType

r[NVectorDimension]

)

template<typename T, unsigned int NVectorDimension = 3>

bool itk::Vector< T, NVectorDimension >::operator== ( const Self &  v ) const

inline

Operators == and != compare a vector component by component. All components must be equal for two vectors to be equal. (Of course compile-time constraints on the template parameters length and type prevent comparisons between vectors of different type and length.)

Definition at line 212 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

void itk::Vector< T, NVectorDimension >::SetNthComponent ( int  c, const ComponentType &  v  )

inline

Definition at line 231 of file itkVector.h.

template<typename T, unsigned int NVectorDimension = 3>

void itk::Vector< 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>

constexpr unsigned int itk::Vector< T, NVectorDimension >::Dimension = NVectorDimension

static

Dimension of the vector space.

Definition at line 75 of file itkVector.h.

---

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

• itkVector.h