ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkVector.h>
Public Types | |
typedef FixedArray< T, NVectorDimension > | BaseArray |
typedef T | ComponentType |
typedef NumericTraits < ValueType >::RealType | RealValueType |
typedef Vector | Self |
typedef FixedArray< T, NVectorDimension > | Superclass |
typedef T | ValueType |
typedef Self | VectorType |
Public Member Functions | |
vnl_vector_ref< T > | Get_vnl_vector (void) |
vnl_vector< T > | Get_vnl_vector (void) const |
RealValueType | GetNorm (void) const |
RealValueType | GetSquaredNorm (void) const |
vnl_vector_ref< T > | GetVnlVector (void) |
vnl_vector< T > | GetVnlVector (void) const |
void | Normalize (void) |
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<class Tt > | |
Self | operator/ (const Tt &value) const |
Vector & | operator= (const ValueType r[NVectorDimension]) |
void | Set_vnl_vector (const vnl_vector< T > &) |
void | SetNthComponent (int c, const ComponentType &v) |
void | SetVnlVector (const vnl_vector< T > &) |
Vector () | |
Vector (const ValueType &r) | |
template<class TVectorValueType > | |
Vector (const Vector< TVectorValueType, NVectorDimension > &r) | |
Vector (const ValueType r[Dimension]) | |
template<class TVectorValueType > | |
Vector & | operator= (const Vector< TVectorValueType, NVectorDimension > &r) |
template<class Tt > | |
const Self & | operator*= (const Tt &value) |
template<class 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) |
Static Public Member Functions | |
static unsigned int | GetNumberOfComponents () |
static unsigned int | GetVectorDimension () |
Static Public Attributes | |
static const unsigned int | Dimension = 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.)
Definition at line 62 of file itkVector.h.
typedef FixedArray< T, NVectorDimension > itk::Vector< T, NVectorDimension >::BaseArray |
The Array type from which this vector is derived.
Definition at line 84 of file itkVector.h.
typedef T itk::Vector< T, NVectorDimension >::ComponentType |
Component value type
Definition at line 81 of file itkVector.h.
typedef NumericTraits< ValueType >::RealType itk::Vector< T, NVectorDimension >::RealValueType |
Definition at line 72 of file itkVector.h.
typedef Vector itk::Vector< T, NVectorDimension >::Self |
Standard class typedefs.
Definition at line 66 of file itkVector.h.
typedef FixedArray< T, NVectorDimension > itk::Vector< T, NVectorDimension >::Superclass |
Definition at line 67 of file itkVector.h.
typedef T itk::Vector< T, NVectorDimension >::ValueType |
ValueType can be used to declare a variable that is the same type as a data element held in an Vector.
Reimplemented from itk::FixedArray< T, NVectorDimension >.
Definition at line 71 of file itkVector.h.
typedef Self itk::Vector< T, NVectorDimension >::VectorType |
I am a vector type.
Definition at line 78 of file itkVector.h.
itk::Vector< T, NVectorDimension >::Vector | ( | ) | [inline] |
Default constructor and copy constructors.
Definition at line 111 of file itkVector.h.
itk::Vector< T, NVectorDimension >::Vector | ( | const ValueType & | r | ) |
itk::Vector< T, NVectorDimension >::Vector | ( | const Vector< TVectorValueType, NVectorDimension > & | r | ) | [inline] |
Pass-through constructor for the Array base class.
Definition at line 116 of file itkVector.h.
itk::Vector< T, NVectorDimension >::Vector | ( | const ValueType | r[Dimension] | ) | [inline] |
Pass-through constructor for the Array base class.
Definition at line 117 of file itkVector.h.
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 230 of file itkVector.h.
vnl_vector_ref< T > itk::Vector< T, NVectorDimension >::Get_vnl_vector | ( | void | ) |
Get a vnl_vector_ref referencing the same memory block.
vnl_vector< T > itk::Vector< T, NVectorDimension >::Get_vnl_vector | ( | void | ) | const |
Get a vnl_vector with a copy of the internal memory block.
RealValueType itk::Vector< T, NVectorDimension >::GetNorm | ( | void | ) | const |
Returns the Euclidean Norm of the vector
static unsigned int itk::Vector< T, NVectorDimension >::GetNumberOfComponents | ( | ) | [inline, static] |
Returns the number of components in this vector type
Definition at line 219 of file itkVector.h.
RealValueType itk::Vector< T, NVectorDimension >::GetSquaredNorm | ( | void | ) | const |
Returns vector's Squared Euclidean Norm
static unsigned int itk::Vector< T, NVectorDimension >::GetVectorDimension | ( | ) | [inline, static] |
Get the dimension (size) of the vector.
Definition at line 87 of file itkVector.h.
vnl_vector_ref< T > itk::Vector< T, NVectorDimension >::GetVnlVector | ( | void | ) |
Get a vnl_vector_ref referencing the same memory block.
vnl_vector< T > itk::Vector< T, NVectorDimension >::GetVnlVector | ( | void | ) | const |
Get a vnl_vector with a copy of the internal memory block.
void itk::Vector< T, NVectorDimension >::Normalize | ( | void | ) |
Divides the vector componets by the vector norm
itk::Vector< T, NVectorDimension >::operator Vector< TCoordRepB, NVectorDimension > | ( | ) | [inline] |
Definition at line 240 of file itkVector.h.
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 208 of file itkVector.h.
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.
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 177 of file itkVector.h.
const Self& itk::Vector< T, NVectorDimension >::operator*= | ( | const Tt & | value | ) | [inline] |
Scalar operator*=. Scales elements by a scalar.
Definition at line 133 of file itkVector.h.
Self itk::Vector< T, NVectorDimension >::operator+ | ( | const Self & | vec | ) | const |
Vector addition. Add two vectors. Return a new vector.
const Self& itk::Vector< T, NVectorDimension >::operator+= | ( | const Self & | vec | ) |
Vector operator+=. Adds a vectors to the current vector.
Self itk::Vector< T, NVectorDimension >::operator- | ( | ) | const |
Vector negation. Negate all the elements of a vector. Return a new vector
Self itk::Vector< T, NVectorDimension >::operator- | ( | const Self & | vec | ) | const |
Vector subtraction. Subtract two vectors. Return a new vector.
const Self& itk::Vector< T, NVectorDimension >::operator-= | ( | const Self & | vec | ) |
Vector operator-=. Subtracts a vector from a current vector.
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 191 of file itkVector.h.
const Self& itk::Vector< T, NVectorDimension >::operator/= | ( | const Tt & | value | ) | [inline] |
Scalar operator/=. Scales (divides) elements by a scalar.
Definition at line 145 of file itkVector.h.
Vector& itk::Vector< T, NVectorDimension >::operator= | ( | const Vector< TVectorValueType, NVectorDimension > & | r | ) | [inline] |
Pass-through assignment operator for the Array base class.
Definition at line 122 of file itkVector.h.
Vector& itk::Vector< T, NVectorDimension >::operator= | ( | const ValueType | r[NVectorDimension] | ) |
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 206 of file itkVector.h.
Referenced by itk::Vector< TScalarType, 6 >::operator!=().
void itk::Vector< T, NVectorDimension >::Set_vnl_vector | ( | const vnl_vector< T > & | ) |
Set a vnl_vector_ref referencing the same memory block.
void itk::Vector< T, NVectorDimension >::SetNthComponent | ( | int | c, |
const ComponentType & | v | ||
) | [inline] |
Definition at line 224 of file itkVector.h.
void itk::Vector< T, NVectorDimension >::SetVnlVector | ( | const vnl_vector< T > & | ) |
Set a vnl_vector_ref referencing the same memory block.
const unsigned int itk::Vector< T, NVectorDimension >::Dimension = NVectorDimension [static] |
Dimension of the vector space.
Reimplemented from itk::FixedArray< T, NVectorDimension >.
Definition at line 75 of file itkVector.h.