Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
itk::Vector

itk::Vector< T, NVectorDimension > Class Template Reference
[Geometry Representation Objects, Data Representation Objects]

#include <itkVector.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::Vector< T, NVectorDimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class 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

Definition at line 58 of file 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

template<typename TCoordRepB>
Copy from another Vector with
a different representation
type *Casting is done with
C Like rules *void 		CastFrom (const Vector< TCoordRepB, NVectorDimension > &pa)
vnl_vector< T > Get_vnl_vector (void) const
vnl_vector_ref< T > Get_vnl_vector (void)
RealValueType GetSquaredNorm (void) const
vnl_vector< T > GetVnlVector (void) const
vnl_vector_ref< T > GetVnlVector (void)
 itkStaticConstMacro (Dimension, unsigned int, NVectorDimension)
void Normalize (void)
ValueType operator * (const Self &vec) const
Scalar operator *.Scale the elements of a vector by a scalar.*Return a new vector.*/inline Self operator * (const ValueType &value) const
Scalar operator *=.Scales elements by a scalar.*/template (const Tt &value)
Pass through assignment operator for the Array base class.*/template (const Vector< TVectorValueType, NVectorDimension > &r)
Self operator+ (const Self &vec) const
Self operator- (const Self &vec) const
Self operator- () const
const Self & operator-= (const Self &vec)
Scalar operator/.Scale (divide) the elements of a vector by a scalar.*Return a new vector.*/template< class Tt > inline Self operator/(const Tt &value) const
Scalar operator/=.Scales (divides) elements by a scalar.*/template< class Tt > inline const Self &operator/
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 (const ValueType r[Dimension])
template<class TVectorValueType>
Pass through constructor for
the Array base class * 		Vector (const Vector< TVectorValueType, NVectorDimension > &r)
 Vector (const ValueType &r)
 Vector ()

Static Public Member Functions

static unsigned int GetNumberOfComponents ()
static unsigned int GetVectorDimension ()

Public Attributes

 Operators

Member Typedef Documentation

template<class T, unsigned int NVectorDimension = 3>
typedef FixedArray<T, NVectorDimension> itk::Vector< T, NVectorDimension >::BaseArray
 

The Array type from which this vector is derived.

Definition at line 80 of file itkVector.h.

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

Component value type

Definition at line 77 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
typedef NumericTraits< ValueType >::RealType itk::Vector< T, NVectorDimension >::RealValueType
 

Definition at line 68 of file itkVector.h.

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

Standard class typedefs.

Definition at line 62 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
typedef FixedArray<T,NVectorDimension> itk::Vector< T, NVectorDimension >::Superclass
 

Definition at line 63 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
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.

Definition at line 67 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
typedef Self itk::Vector< T, NVectorDimension >::VectorType
 

I am a vector type.

Definition at line 74 of file itkVector.h.

Constructor & Destructor Documentation

template<class T, unsigned int NVectorDimension = 3>
itk::Vector< T, NVectorDimension >::Vector (   )  [inline]
 

Default constructor and copy constructors.

Definition at line 109 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
itk::Vector< T, NVectorDimension >::Vector (  const ValueType &  r  ) 
 

template<class T, unsigned int NVectorDimension = 3>
template<class TVectorValueType>
Pass through constructor for the Array base class* itk::Vector< T, NVectorDimension >::Vector (  const Vector< TVectorValueType, NVectorDimension > &  r  )  [inline]
 

Definition at line 114 of file itkVector.h.

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

Definition at line 115 of file itkVector.h.

Member Function Documentation

template<class T, unsigned int NVectorDimension = 3>
template<typename TCoordRepB>
Copy from another Vector with a different representation type* Casting is done with C Like rules* void itk::Vector< T, NVectorDimension >::CastFrom (  const Vector< TCoordRepB, NVectorDimension > &  pa  )  [inline]
 

Definition at line 225 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
vnl_vector<T> itk::Vector< T, NVectorDimension >::Get_vnl_vector (  void   )  const
 

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

Deprecated:
Use GetVnlVector() instead.

template<class T, unsigned int NVectorDimension = 3>
vnl_vector_ref<T> itk::Vector< T, NVectorDimension >::Get_vnl_vector (  void   ) 
 

Get a vnl_vector_ref referencing the same memory block.

Deprecated:
Use GetVnlVector() instead.

template<class T, unsigned int NVectorDimension = 3>
static unsigned int itk::Vector< T, NVectorDimension >::GetNumberOfComponents (   )  [inline, static]
 

Returns the number of components in this vector type

Definition at line 214 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
RealValueType itk::Vector< T, NVectorDimension >::GetSquaredNorm (  void   )  const
 

Returns vector's Squared Euclidean Norm

template<class T, unsigned int NVectorDimension = 3>
static unsigned int itk::Vector< T, NVectorDimension >::GetVectorDimension (   )  [inline, static]
 

Get the dimension (size) of the vector.

Definition at line 83 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
vnl_vector<T> itk::Vector< T, NVectorDimension >::GetVnlVector (  void   )  const
 

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

template<class T, unsigned int NVectorDimension = 3>
vnl_vector_ref<T> itk::Vector< T, NVectorDimension >::GetVnlVector (  void   ) 
 

Get a vnl_vector_ref referencing the same memory block.

template<class T, unsigned int NVectorDimension = 3>
itk::Vector< T, NVectorDimension >::itkStaticConstMacro (  Dimension  ,
unsigned  int,
NVectorDimension 
) 
 

Dimension of the vector space.

template<class T, unsigned int NVectorDimension = 3>
void itk::Vector< T, NVectorDimension >::Normalize (  void   ) 
 

Divides the vector componets by the vector norm

template<class 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<class T, unsigned int NVectorDimension = 3>
Scalar itk::Vector< T, NVectorDimension >::operator *.Scale the elements of a vector by a scalar.*Return a new vector.*/inline Self operator * (  const ValueType &  value  )  const [inline]
 

Definition at line 173 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
Scalar itk::Vector< T, NVectorDimension >::operator *=.Scales elements by a scalar.*/template (  const Tt &  value  )  [inline]
 

Definition at line 130 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
Pass through assignment itk::Vector< T, NVectorDimension >::operator for the Array base class.*/template (  const Vector< TVectorValueType, NVectorDimension > &  r  )  [inline]
 

Definition at line 120 of file itkVector.h.

template<class 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<class 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<class 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<class 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<class T, unsigned int NVectorDimension = 3>
Scalar itk::Vector< T, NVectorDimension >::operator/.Scale (  divide   )  const [inline]
 

Definition at line 184 of file itkVector.h.

template<class T, unsigned int NVectorDimension = 3>
Scalar itk::Vector< T, NVectorDimension >::operator/=.Scales (  divides   )  const
 

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

template<class T, unsigned int NVectorDimension = 3>
void itk::Vector< T, NVectorDimension >::Set_vnl_vector (  const vnl_vector< T > &   ) 
 

Set a vnl_vector_ref referencing the same memory block.

Deprecated:
Use SetVnlVector() instead.

template<class T, unsigned int NVectorDimension = 3>
void itk::Vector< T, NVectorDimension >::SetNthComponent (  int  c,
const ComponentType &  v
)  [inline]
 

Definition at line 219 of file itkVector.h.

template<class 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<class T, unsigned int NVectorDimension = 3>
itk::Vector< T, NVectorDimension >::Operators
 

Initial value:

= 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.) */
  bool operator==(const Self& v) const
    { return Superclass::operator==(v); }
  bool operator!=(const Self& v) const
    { return !operator==(v); }



  RealValueType GetNorm( void ) const

Definition at line 197 of file itkVector.h.

The documentation for this class was generated from the following file:
Generated at Sun Jul 9 21:43:13 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000