ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::Vector< T, VVectorDimension > Class Template Reference
Data Representation Objects » Geometry Representation Objects | Data Representation ObjectsGroup Core » | Module ITKCommon

#include <itkVector.h>

Detailed Description

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

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 VVectorDimension 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
ITK Sphinx Examples:
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/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/ApplyCustomOperationToEachPixelInImage/Code.cxx, SphinxExamples/src/Core/Common/BresenhamLine/Code.cxx, SphinxExamples/src/Core/Common/CreateAnImageOfVectors/Code.cxx, SphinxExamples/src/Core/Common/CreateAVector/Code.cxx, SphinxExamples/src/Core/Common/ReadWriteVectorImage/Code.cxx, SphinxExamples/src/Core/Common/VariableLengthVector/Code.cxx, SphinxExamples/src/Core/Common/VectorDotProduct/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ApplyGradientRecursiveGaussianWithVectorInput/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/FitSplineIntoPointSet/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/WarpAnImageUsingADeformationField/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/ComputeNormalsOfAMesh/Code.cxx, SphinxExamples/src/Numerics/Statistics/2DGaussianMixtureModelExpectMax/Code.cxx, SphinxExamples/src/Numerics/Statistics/CreateHistogramFromListOfMeasurements/Code.cxx, SphinxExamples/src/Numerics/Statistics/CreateListOfSampleMeasurements/Code.cxx, SphinxExamples/src/Numerics/Statistics/CreateListOfSamplesWithIDs/Code.cxx, SphinxExamples/src/Numerics/Statistics/DistributeSamplingUsingGMM/Code.cxx, SphinxExamples/src/Numerics/Statistics/SpatialSearch/Code.cxx, SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx, and SphinxExamples/src/Segmentation/Classifiers/KMeansClusterOfPixelsInImage/Code.cxx.

Definition at line 62 of file itkVector.h.

+ Inheritance diagram for itk::Vector< T, VVectorDimension >:
+ Collaboration diagram for itk::Vector< T, VVectorDimension >:

Public Types

using BaseArray = FixedArray< T, VVectorDimension >
 
using ComponentType = T
 
using RealValueType = typename NumericTraits< ValueType >::RealType
 
using Self = Vector
 
using Superclass = FixedArray< T, VVectorDimension >
 
using ValueType = T
 
using VectorType = Self
 
- Public Types inherited from itk::FixedArray< T, VVectorDimension >
using CArray = ValueType[VLength]
 
using const_iterator = const ValueType *
 
using const_pointer = const ValueType *
 
using const_reference = const ValueType &
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using ConstIterator = const ValueType *
 
using Iterator = ValueType *
 
using iterator = ValueType *
 
using pointer = ValueType *
 
using reference = ValueType &
 
using reverse_iterator = std::reverse_iterator< iterator >
 
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
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
RealValueType Normalize ()
 
template<typename TCoordinateB >
 operator Vector< TCoordinateB, VVectorDimension > ()
 
ValueType operator* (const Self &other) 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[VVectorDimension])
 
bool operator== (const Self &v) const
 
void SetNthComponent (int c, const ComponentType &v)
 
void SetVnlVector (const vnl_vector< T > &)
 
 Vector ()=default
 
 Vector (const std::array< ValueType, VVectorDimension > &stdArray)
 
 Vector (const ValueType &r)
 
 Vector (std::nullptr_t)=delete
 
template<typename TVectorValueType >
 Vector (const Vector< TVectorValueType, VVectorDimension > &r)
 
 Vector (const ValueType r[Dimension])
 
template<typename TVectorValueType >
 Vector (const TVectorValueType r[Dimension])
 
template<typename TVectorValueType >
Vector & operator= (const Vector< TVectorValueType, VVectorDimension > &r)
 
template<typename Tt >
const Self & operator*= (const Tt &value)
 
template<typename Tt >
const Self & operator/= (const Tt &value)
 
template<typename TCoordinateB >
void CastFrom (const Vector< TCoordinateB, VVectorDimension > &pa)
 
- Public Member Functions inherited from itk::FixedArray< T, VVectorDimension >
Iterator Begin ()
 
ConstIterator Begin () const
 
constexpr const_iterator begin () const noexcept
 
constexpr iterator begin () noexcept
 
constexpr const_iterator cbegin () const noexcept
 
constexpr const_iterator cend () const noexcept
 
const_reverse_iterator crbegin () const
 
const_reverse_iterator crend () const
 
ValueType * data ()
 
const ValueType * data () const
 
Iterator End ()
 
ConstIterator End () const
 
constexpr const_iterator end () const noexcept
 
constexpr iterator end () noexcept
 
void Fill (const ValueType &)
 
 FixedArray ()=default
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
 FixedArray (const std::array< ValueType, VLength > &stdArray)
 
 FixedArray (const TScalarValue *r)
 
ValueType * GetDataPointer ()
 
const ValueType * GetDataPointer () const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (FixedArray)
 
 itkLegacyMacro (ReverseIterator rBegin();) itkLegacyMacro(ConstReverseIterator rBegin() const
 
 itkLegacyMacro (ReverseIterator rEnd();) itkLegacyMacro(ConstReverseIterator rEnd() const
 
FixedArray & operator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArray & operator= (const ValueType r[VLength])
 
bool operator== (const FixedArray &r) const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
SizeType Size () const
 
constexpr SizeType size () const
 
void swap (FixedArray &other) noexcept
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &)
 
ITK_GCC_PRAGMA_PUSH constexpr ITK_GCC_SUPPRESS_Warray_bounds reference operator[] (unsigned int index)
 
constexpr const_reference operator[] (unsigned int index) const
 
ITK_GCC_PRAGMA_POP void SetElement (unsigned int index, const_reference value)
 
const_reference GetElement (unsigned int index) const
 

Static Public Member Functions

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

Static Public Attributes

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

Member Typedef Documentation

◆ BaseArray

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::BaseArray = FixedArray<T, VVectorDimension>

The Array type from which this vector is derived.

Definition at line 84 of file itkVector.h.

◆ ComponentType

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::ComponentType = T

Component value type

Definition at line 81 of file itkVector.h.

◆ RealValueType

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::RealValueType = typename NumericTraits<ValueType>::RealType

Definition at line 72 of file itkVector.h.

◆ Self

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::Self = Vector

Standard class type aliases.

Definition at line 66 of file itkVector.h.

◆ Superclass

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::Superclass = FixedArray<T, VVectorDimension>

Definition at line 67 of file itkVector.h.

◆ ValueType

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::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.

◆ VectorType

template<typename T, unsigned int VVectorDimension = 3>
using itk::Vector< T, VVectorDimension >::VectorType = Self

I am a vector type.

Definition at line 78 of file itkVector.h.

Constructor & Destructor Documentation

◆ Vector() [1/7]

template<typename T, unsigned int VVectorDimension = 3>
itk::Vector< T, VVectorDimension >::Vector ( )
default

Default-constructor.

Note
The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero".

◆ Vector() [2/7]

template<typename T, unsigned int VVectorDimension = 3>
itk::Vector< T, VVectorDimension >::Vector ( const ValueType &  r)
explicit

Constructor to initialize entire vector to one value, if explicitly invoked.

◆ Vector() [3/7]

template<typename T, unsigned int VVectorDimension = 3>
itk::Vector< T, VVectorDimension >::Vector ( std::nullptr_t  )
delete

Prevents copy-initialization from nullptr, as well as from 0 (NULL).

◆ Vector() [4/7]

template<typename T, unsigned int VVectorDimension = 3>
template<typename TVectorValueType >
itk::Vector< T, VVectorDimension >::Vector ( const Vector< TVectorValueType, VVectorDimension > &  r)
inline

Pass-through constructor for the Array base class.

Definition at line 128 of file itkVector.h.

◆ Vector() [5/7]

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

Pass-through constructor for the Array base class.

Definition at line 131 of file itkVector.h.

◆ Vector() [6/7]

template<typename T, unsigned int VVectorDimension = 3>
template<typename TVectorValueType >
itk::Vector< T, VVectorDimension >::Vector ( const TVectorValueType  r[Dimension])
inline

Pass-through constructor for the Array base class.

Definition at line 135 of file itkVector.h.

◆ Vector() [7/7]

template<typename T, unsigned int VVectorDimension = 3>
itk::Vector< T, VVectorDimension >::Vector ( const std::array< ValueType, VVectorDimension > &  stdArray)
inlineexplicit

Explicit constructor for std::array.

Definition at line 141 of file itkVector.h.

Member Function Documentation

◆ CastFrom()

template<typename T, unsigned int VVectorDimension = 3>
template<typename TCoordinateB >
void itk::Vector< T, VVectorDimension >::CastFrom ( const Vector< TCoordinateB, VVectorDimension > &  pa)
inline

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

Definition at line 281 of file itkVector.h.

◆ GetNorm()

template<typename T, unsigned int VVectorDimension = 3>
RealValueType itk::Vector< T, VVectorDimension >::GetNorm ( ) const

Returns the Euclidean Norm of the vector (also referred to as its "magnitude").

◆ GetNumberOfComponents()

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

Returns the number of components in this vector type

Definition at line 261 of file itkVector.h.

◆ GetSquaredNorm()

template<typename T, unsigned int VVectorDimension = 3>
RealValueType itk::Vector< T, VVectorDimension >::GetSquaredNorm ( ) const

Returns vector's Squared Euclidean Norm

◆ GetVectorDimension()

template<typename T, unsigned int VVectorDimension = 3>
static unsigned int itk::Vector< T, VVectorDimension >::GetVectorDimension ( )
inlinestatic

Get the dimension (size) of the vector.

Definition at line 88 of file itkVector.h.

◆ GetVnlVector() [1/2]

template<typename T, unsigned int VVectorDimension = 3>
vnl_vector_ref<T> itk::Vector< T, VVectorDimension >::GetVnlVector ( )

Get a vnl_vector_ref referencing the same memory block.

◆ GetVnlVector() [2/2]

template<typename T, unsigned int VVectorDimension = 3>
vnl_vector<T> itk::Vector< T, VVectorDimension >::GetVnlVector ( ) const

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

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename T, unsigned int VVectorDimension = 3>
itk::Vector< T, VVectorDimension >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( Self  )

◆ Normalize()

template<typename T, unsigned int VVectorDimension = 3>
RealValueType itk::Vector< T, VVectorDimension >::Normalize ( )

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

◆ operator Vector< TCoordinateB, VVectorDimension >()

template<typename T, unsigned int VVectorDimension = 3>
template<typename TCoordinateB >
itk::Vector< T, VVectorDimension >::operator Vector< TCoordinateB, VVectorDimension > ( )
inline

Definition at line 291 of file itkVector.h.

◆ operator*() [1/2]

template<typename T, unsigned int VVectorDimension = 3>
ValueType itk::Vector< T, VVectorDimension >::operator* ( const Self &  other) const

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

◆ operator*() [2/2]

template<typename T, unsigned int VVectorDimension = 3>
Self itk::Vector< T, VVectorDimension >::operator* ( const ValueType &  value) const
inline

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

Definition at line 213 of file itkVector.h.

◆ operator*=()

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

Scalar operator*=. Scales elements by a scalar.

Definition at line 161 of file itkVector.h.

◆ operator+()

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

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

◆ operator+=()

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

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

◆ operator-() [1/2]

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

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

◆ operator-() [2/2]

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

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

◆ operator-=()

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

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

◆ operator/()

template<typename T, unsigned int VVectorDimension = 3>
template<typename Tt >
Self itk::Vector< T, VVectorDimension >::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 228 of file itkVector.h.

◆ operator/=()

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

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

Definition at line 174 of file itkVector.h.

◆ operator=() [1/2]

template<typename T, unsigned int VVectorDimension = 3>
Vector& itk::Vector< T, VVectorDimension >::operator= ( const ValueType  r[VVectorDimension])

◆ operator=() [2/2]

template<typename T, unsigned int VVectorDimension = 3>
template<typename TVectorValueType >
Vector& itk::Vector< T, VVectorDimension >::operator= ( const Vector< TVectorValueType, VVectorDimension > &  r)
inline

Pass-through assignment operator for the Array base class.

Definition at line 148 of file itkVector.h.

◆ operator==()

template<typename T, unsigned int VVectorDimension = 3>
bool itk::Vector< T, VVectorDimension >::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 244 of file itkVector.h.

◆ SetNthComponent()

template<typename T, unsigned int VVectorDimension = 3>
void itk::Vector< T, VVectorDimension >::SetNthComponent ( int  c,
const ComponentType &  v 
)
inline

Definition at line 272 of file itkVector.h.

◆ SetVnlVector()

template<typename T, unsigned int VVectorDimension = 3>
void itk::Vector< T, VVectorDimension >::SetVnlVector ( const vnl_vector< T > &  )

Copy values from the vnl_vector input to the internal memory block. The minimum of VVectorDimension and vnl_vector::size() elements are copied.

Member Data Documentation

◆ Dimension

template<typename T, unsigned int VVectorDimension = 3>
constexpr unsigned int itk::Vector< T, VVectorDimension >::Dimension = VVectorDimension
staticconstexpr

Dimension of the vector space.

Definition at line 75 of file itkVector.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16