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

itk::Point< TCoordRep, NPointDimension > Class Template Reference
[Geometry Representation Objects, Data Representation Objects]

#include <itkPoint.h>

Inheritance diagram for itk::Point< TCoordRep, NPointDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::Point< TCoordRep, NPointDimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TCoordRep, unsigned int NPointDimension = 3>
class itk::Point< TCoordRep, NPointDimension >

A templated class holding a geometric point in n-Dimensional space.

Point is a templated class that holds a set of coordinates (components). Point 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 NPointDimension defines the number of components in the point array.

See also:
Image

Mesh

Vector

CovariantVector

Matrix

Definition at line 45 of file itkPoint.h.

Public Types

typedef FixedArray< TCoordRep,
NPointDimension > 		BaseArray
typedef ValueType CArray [VLength]
typedef const ValueType * const_pointer
typedef const ValueType & const_reference
typedef BaseArray::ConstIterator ConstIterator
typedef TCoordRep CoordRepType
typedef BaseArray::Iterator Iterator
typedef ValueType * pointer
typedef NumericTraits< ValueType
>::RealType 		RealType
typedef ValueType & reference
typedef Point Self
typedef unsigned int SizeType
typedef FixedArray< TCoordRep,
NPointDimension > 		Superclass
typedef TCoordRep ValueType
typedef Vector< ValueType,
NPointDimension > 		VectorType

Public Member Functions

ConstIterator Begin () const
Iterator Begin ()
ConstIterator End () const
Iterator End ()
void Fill (const ValueType &)
vnl_vector< TCoordRep > Get_vnl_vector (void) const
vnl_vector_ref< TCoordRep > Get_vnl_vector (void)
const ValueType * GetDataPointer () const
ValueType * GetDataPointer ()
const_reference GetElement (unsigned short index) const
VectorType GetVectorFromOrigin () const
vnl_vector< TCoordRep > GetVnlVector (void) const
vnl_vector_ref< TCoordRep > GetVnlVector (void)
 itkStaticConstMacro (Dimension, unsigned int, VLength)
 itkStaticConstMacro (Length, unsigned int, VLength)
 itkStaticConstMacro (PointDimension, unsigned int, NPointDimension)
bool operator!= (const FixedArray &r) const
Self operator+ (const VectorType &vec) const
const Self & operator+= (const VectorType &vec)
Self operator- (const VectorType &vec) const
VectorType operator- (const Self &pnt) const
const Self & operator-= (const VectorType &vec)
bool operator== (const FixedArray &r) const
const_reference operator[] (unsigned long index) const
reference operator[] (unsigned long index)
const_reference operator[] (long index) const
reference operator[] (long index)
const_reference operator[] (unsigned int index) const
reference operator[] (unsigned int index)
const_reference operator[] (int index) const
reference operator[] (int index)
const_reference operator[] (unsigned short index) const
reference operator[] (unsigned short index)
const_reference operator[] (short index) const
reference operator[] (short index)
 Point ()
ConstReverseIterator rBegin () const
ReverseIterator rBegin ()
ConstReverseIterator rEnd () const
ReverseIterator rEnd ()
void SetElement (unsigned short index, const_reference value)
void SetToMidPoint (const Self &, const Self &)
SizeType Size () const
template<typename TCoordRepB>
RealType SquaredEuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
template<typename TCoordRepB>
void CastFrom (const Point< TCoordRepB, NPointDimension > &pa)
template<typename TCoordRepB>
RealType EuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
bool operator!= (const Self &pt) const
Point & operator= (const ValueType r[NPointDimension])
Point & operator= (const Self &r)
bool operator== (const Self &pt) const
void SetToBarycentricCombination (const Self *P, const double *weights, unsigned int N)
void SetToBarycentricCombination (const Self &A, const Self &B, const Self &C, double weightA, double weightB)
void SetToBarycentricCombination (const Self &A, const Self &B, double alpha)

Static Public Member Functions

static FixedArray Filled (const ValueType &)
static unsigned int GetPointDimension ()

Member Typedef Documentation

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef FixedArray<TCoordRep, NPointDimension> itk::Point< TCoordRep, NPointDimension >::BaseArray

The Array type from which this Vector is derived.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 63 of file itkPoint.h.

typedef ValueType itk::FixedArray< TCoordRep , VLength >::CArray[VLength] [inherited]

A type representing the C-array version of this FixedArray.

Definition at line 77 of file itkFixedArray.h.

typedef const ValueType* itk::FixedArray< TCoordRep , VLength >::const_pointer [inherited]

A const pointer to the ValueType.

Definition at line 123 of file itkFixedArray.h.

typedef const ValueType& itk::FixedArray< TCoordRep , VLength >::const_reference [inherited]

A const reference to the ValueType.

Definition at line 129 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef BaseArray::ConstIterator itk::Point< TCoordRep, NPointDimension >::ConstIterator

A const iterator through the array.

Reimplemented from itk::FixedArray< TCoordRep, NPointDimension >.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 65 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef TCoordRep itk::Point< TCoordRep, NPointDimension >::CoordRepType

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 55 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef BaseArray::Iterator itk::Point< TCoordRep, NPointDimension >::Iterator

An iterator through the array.

Reimplemented from itk::FixedArray< TCoordRep, NPointDimension >.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 64 of file itkPoint.h.

typedef ValueType* itk::FixedArray< TCoordRep , VLength >::pointer [inherited]

A pointer to the ValueType.

Definition at line 120 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef NumericTraits< ValueType >::RealType itk::Point< TCoordRep, NPointDimension >::RealType

Reimplemented in itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 57 of file itkPoint.h.

typedef ValueType& itk::FixedArray< TCoordRep , VLength >::reference [inherited]

A reference to the ValueType.

Definition at line 126 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef Point itk::Point< TCoordRep, NPointDimension >::Self

Standard class typedefs.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 49 of file itkPoint.h.

typedef unsigned int itk::FixedArray< TCoordRep , VLength >::SizeType [inherited]

Definition at line 131 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef FixedArray<TCoordRep,NPointDimension> itk::Point< TCoordRep, NPointDimension >::Superclass

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 50 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef TCoordRep itk::Point< TCoordRep, NPointDimension >::ValueType

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

Reimplemented from itk::FixedArray< TCoordRep, NPointDimension >.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, and itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 54 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
typedef Vector< ValueType, NPointDimension > itk::Point< TCoordRep, NPointDimension >::VectorType

VectorType define the difference between two Points

Reimplemented in itk::QuadEdgeMeshPoint< TCoordRep, VPointDimension, TQuadEdge >.

Definition at line 72 of file itkPoint.h.

Constructor & Destructor Documentation

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::Point (  )  [inline]

Default constructor has nothing to do.

Definition at line 75 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::Point ( const Self &  r  )  [inline]

Pass-through constructor for the Array base class.

Definition at line 78 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::Point ( const ValueType  r[PointDimension]  )  [inline]

Definition at line 79 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::Point ( const ValueType  r[PointDimension]  )  [inline]

Definition at line 79 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::Point ( const Self &  r  )  [inline]

Pass-through constructor for the Array base class.

Definition at line 78 of file itkPoint.h.

Member Function Documentation

ConstIterator itk::FixedArray< TCoordRep , VLength >::Begin ( void   )  const [inherited]

Iterator itk::FixedArray< TCoordRep , VLength >::Begin ( void   )  [inherited]

Get various iterators to the array.

template<class TCoordRep, unsigned int NPointDimension = 3>
template<typename TCoordRepB>
void itk::Point< TCoordRep, NPointDimension >::CastFrom ( const Point< TCoordRepB, NPointDimension > &  pa  )  [inline]

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

Definition at line 219 of file itkPoint.h.

ConstIterator itk::FixedArray< TCoordRep , VLength >::End ( void   )  const [inherited]

Iterator itk::FixedArray< TCoordRep , VLength >::End ( void   )  [inherited]

template<class TCoordRep, unsigned int NPointDimension = 3>
template<typename TCoordRepB>
RealType itk::Point< TCoordRep, NPointDimension >::EuclideanDistanceTo ( const Point< TCoordRepB, NPointDimension > &  pa  )  const [inline]

Compute the Euclidean Distance from this point to another point with a different representation type. Casting is done with C-Like rules

Definition at line 250 of file itkPoint.h.

void itk::FixedArray< TCoordRep , VLength >::Fill ( const ValueType &   )  [inherited]

static FixedArray itk::FixedArray< TCoordRep , VLength >::Filled ( const ValueType &   )  [static, inherited]

template<class TCoordRep, unsigned int NPointDimension = 3>
vnl_vector<TCoordRep> itk::Point< TCoordRep, NPointDimension >::Get_vnl_vector ( void   )  const

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

Deprecated:
Use GetVnlVector() instead.

template<class TCoordRep, unsigned int NPointDimension = 3>
vnl_vector_ref<TCoordRep> itk::Point< TCoordRep, NPointDimension >::Get_vnl_vector ( void   ) 

Get a vnl_vector_ref referencing the same memory block

Deprecated:
Use GetVnlVector() instead.

const ValueType* itk::FixedArray< TCoordRep , VLength >::GetDataPointer (  )  const [inline, inherited]

Definition at line 210 of file itkFixedArray.h.

ValueType* itk::FixedArray< TCoordRep , VLength >::GetDataPointer (  )  [inline, inherited]

Return a pointer to the data.

Definition at line 209 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::GetElement ( unsigned short  index  )  const [inline, inherited]

Definition at line 205 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
static unsigned int itk::Point< TCoordRep, NPointDimension >::GetPointDimension (  )  [inline, static]

Get the dimension (size) of the point.

Definition at line 68 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
VectorType itk::Point< TCoordRep, NPointDimension >::GetVectorFromOrigin (  )  const

Access an element of a point.

template<class TCoordRep, unsigned int NPointDimension = 3>
vnl_vector<TCoordRep> itk::Point< TCoordRep, NPointDimension >::GetVnlVector ( void   )  const

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

template<class TCoordRep, unsigned int NPointDimension = 3>
vnl_vector_ref<TCoordRep> itk::Point< TCoordRep, NPointDimension >::GetVnlVector ( void   ) 

Get a vnl_vector_ref referencing the same memory block

itk::FixedArray< TCoordRep , VLength >::itkStaticConstMacro ( Dimension  ,
unsigned  int,
VLength   
) [inherited]

Dimension constant

itk::FixedArray< TCoordRep , VLength >::itkStaticConstMacro ( Length  ,
unsigned  int,
VLength   
) [inherited]

Length constant

template<class TCoordRep, unsigned int NPointDimension = 3>
itk::Point< TCoordRep, NPointDimension >::itkStaticConstMacro ( PointDimension  ,
unsigned  int,
NPointDimension   
)

Dimension of the Space

bool itk::FixedArray< TCoordRep , VLength >::operator!= ( const FixedArray< TCoordRep, NPointDimension > &  r  )  const [inline, inherited]

Definition at line 181 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
bool itk::Point< TCoordRep, NPointDimension >::operator!= ( const Self &  pt  )  const [inline]

Compare two points for inequality.

Definition at line 100 of file itkPoint.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
Self itk::Point< TCoordRep, NPointDimension >::operator+ ( const VectorType &  vec  )  const

Add a vector to a point. Return a new point.

template<class TCoordRep, unsigned int NPointDimension = 3>
const Self& itk::Point< TCoordRep, NPointDimension >::operator+= ( const VectorType &  vec  ) 

Point operator+=. Adds a vector to the current point.

template<class TCoordRep, unsigned int NPointDimension = 3>
Self itk::Point< TCoordRep, NPointDimension >::operator- ( const VectorType &  vec  )  const

Subtract a vector from a point. Return a new point.

template<class TCoordRep, unsigned int NPointDimension = 3>
VectorType itk::Point< TCoordRep, NPointDimension >::operator- ( const Self &  pnt  )  const

Computes the Vector difference between two points

template<class TCoordRep, unsigned int NPointDimension = 3>
const Self& itk::Point< TCoordRep, NPointDimension >::operator-= ( const VectorType &  vec  ) 

Point operator-=. Subtracts a vector from a current point.

template<class TCoordRep, unsigned int NPointDimension = 3>
Point& itk::Point< TCoordRep, NPointDimension >::operator= ( const ValueType  r[NPointDimension]  ) 

template<class TCoordRep, unsigned int NPointDimension = 3>
Point& itk::Point< TCoordRep, NPointDimension >::operator= ( const Self &  r  ) 

Pass-through assignment operator for the Array base class.

bool itk::FixedArray< TCoordRep , VLength >::operator== ( const FixedArray< TCoordRep, NPointDimension > &  r  )  const [inherited]

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

template<class TCoordRep, unsigned int NPointDimension = 3>
bool itk::Point< TCoordRep, NPointDimension >::operator== ( const Self &  pt  )  const [inline]

Compare two points for equality.

Definition at line 89 of file itkPoint.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned long  index  )  const [inline, inherited]

Definition at line 199 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned long  index  )  [inline, inherited]

Definition at line 198 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( long  index  )  const [inline, inherited]

Definition at line 197 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( long  index  )  [inline, inherited]

Definition at line 196 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned int  index  )  const [inline, inherited]

Definition at line 195 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned int  index  )  [inline, inherited]

Definition at line 194 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( int  index  )  const [inline, inherited]

Definition at line 193 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( int  index  )  [inline, inherited]

Definition at line 192 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned short  index  )  const [inline, inherited]

Definition at line 191 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( unsigned short  index  )  [inline, inherited]

Definition at line 190 of file itkFixedArray.h.

const_reference itk::FixedArray< TCoordRep , VLength >::operator[] ( short  index  )  const [inline, inherited]

Definition at line 189 of file itkFixedArray.h.

reference itk::FixedArray< TCoordRep , VLength >::operator[] ( short  index  )  [inline, inherited]

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 188 of file itkFixedArray.h.

ConstReverseIterator itk::FixedArray< TCoordRep , VLength >::rBegin (  )  const [inherited]

ReverseIterator itk::FixedArray< TCoordRep , VLength >::rBegin (  )  [inherited]

ConstReverseIterator itk::FixedArray< TCoordRep , VLength >::rEnd (  )  const [inherited]

ReverseIterator itk::FixedArray< TCoordRep , VLength >::rEnd (  )  [inherited]

void itk::FixedArray< TCoordRep , VLength >::SetElement ( unsigned short  index,
const_reference  value 
) [inline, inherited]

Set/Get element methods are more convenient in wrapping languages

Definition at line 203 of file itkFixedArray.h.

template<class TCoordRep, unsigned int NPointDimension = 3>
void itk::Point< TCoordRep, NPointDimension >::SetToBarycentricCombination ( const Self *  P,
const double *  weights,
unsigned int  N 
)

Set the current point to a barycentric combination of an array of N points An array of (N-1) values is expected to weight the contribution of the first (N-1) points, the weight of the Nth point is computed to ensure that the N weights sum 1.

This method computes:

\[ \overrightarrow{P}= \sum_{i=1}^{N-1} w_i * \overrightarrow{P}_i + \left(1- \sum_{i=1}^{N-1} w_i\right) * \overrightarrow{P}_N \]

template<class TCoordRep, unsigned int NPointDimension = 3>
void itk::Point< TCoordRep, NPointDimension >::SetToBarycentricCombination ( const Self &  A,
const Self &  B,
const Self &  C,
double  weightA,
double  weightB 
)

Set the current point to a barycentric combination of three points Two values are expected to weight the contribution of the first two points, the weight of for the third point is computed to ensure that the three weights sum 1.

This method computes:

\[ \overrightarrow{P}= w_1 * \overrightarrow{P}_1 + w_2 * \overrightarrow{P}_2 + (1-w_1-w_2 ) * \overrightarrow{P}_3 \]

If the two weight are $ \in [0,1] $ , The resulting point will alway be placed inside the triangle formed by the three points given as arguments.

template<class TCoordRep, unsigned int NPointDimension = 3>
void itk::Point< TCoordRep, NPointDimension >::SetToBarycentricCombination ( const Self &  A,
const Self &  B,
double  alpha 
)

Set the current point to a barycentric combination of the two points given as arguments.

Parameters:
\form::154 = weight for the first point
The first point is multiplied by $ \alpha $, the second is multiplied by * $ (1-\alpha) $, and the sum is stored in the Point on which the method is invoked.

\[ \overrightarrow{P}=\alpha * \overrightarrow{A}+ (1-\alpha)*\overrightarrow{B} \]

If the value of $ \alpha \in [0,1] $, the resulting point will be placed in the line segment $ \overline{AB} $ joining $ \overrightarrow{A} $ and $ \overrightarrow{A} $

If the value of $ \alpha < 0 $ the resulting point will be placed outside the line segment $ \overline{AB} $ on the side of $ \overrightarrow{A} $.

If the value of $ \alpha > 1 $ the resulting point will be placed outside the line segment $ \overline{AB} $ on the side of $ \overrightarrow{B} $.

See also:
SetToMedian

template<class TCoordRep, unsigned int NPointDimension = 3>
void itk::Point< TCoordRep, NPointDimension >::SetToMidPoint ( const Self &  ,
const Self &   
)

Set to median point between the two points given as arguments

This method computes:

\[ \overrightarrow{P}=\frac{(\overrightarrow{A}+\overrightarrow{B})}{2} \]

using the two Points given as arguments, and store the result in the Point on which the method is invoked.

SizeType itk::FixedArray< TCoordRep , VLength >::Size ( void   )  const [inherited]

template<class TCoordRep, unsigned int NPointDimension = 3>
template<typename TCoordRepB>
RealType itk::Point< TCoordRep, NPointDimension >::SquaredEuclideanDistanceTo ( const Point< TCoordRepB, NPointDimension > &  pa  )  const [inline]

Compute the Squared Euclidean Distance from this point to another point with a different representation type. Casting is done with C-Like rules

Definition at line 233 of file itkPoint.h.

The documentation for this class was generated from the following file:
Generated at Wed Jul 30 08:43:23 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000