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

#include <itkContinuousIndex.h>

Inheritance diagram for itk::ContinuousIndex< TCoordRep, VIndexDimension >:

Collaboration diagram for itk::ContinuousIndex< TCoordRep, VIndexDimension >:

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

Public Member Functions
	ContinuousIndex ()
	ContinuousIndex (const Self &r)
	ContinuousIndex (const ValueType r[IndexDimension])
	ContinuousIndex (const IndexType &index)
Iterator	Begin ()
ConstIterator	Begin () const
void	CastFrom (const Point< TCoordRepB, NPointDimension > &pa)
Iterator	End ()
ConstIterator	End () const
RealType	EuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
void	Fill (const ValueType &)
vnl_vector_ref< TCoordRep >	Get_vnl_vector (void)
vnl_vector< TCoordRep >	Get_vnl_vector (void) const
ValueType *	GetDataPointer ()
const ValueType *	GetDataPointer () const
const_reference	GetElement (unsigned short index) const
VectorType	GetVectorFromOrigin () const
vnl_vector_ref< TCoordRep >	GetVnlVector (void)
vnl_vector< TCoordRep >	GetVnlVector (void) const
bool	operator!= (const Self &pt) const
bool	operator!= (const FixedArray &r) const
Self	operator+ (const VectorType &vec) const
const Self &	operator+= (const VectorType &vec)
VectorType	operator- (const Self &pnt) const
Self	operator- (const VectorType &vec) const
const Self &	operator-= (const VectorType &vec)
bool	operator== (const Self &pt) const
bool	operator== (const FixedArray &r) const
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
ReverseIterator	rBegin ()
ConstReverseIterator	rBegin () const
ReverseIterator	rEnd ()
ConstReverseIterator	rEnd () const
void	SetElement (unsigned short index, const_reference value)
void	SetToBarycentricCombination (const Self &A, const Self &B, double alpha)
void	SetToBarycentricCombination (const Self &A, const Self &B, const Self &C, double weightA, double weightB)
void	SetToBarycentricCombination (const Self P, const double weights, unsigned int N)
void	SetToMidPoint (const Self &, const Self &)
SizeType	Size () const
RealType	SquaredEuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const

Static Public Member Functions
static FixedArray	Filled (const ValueType &)
static unsigned int	GetPointDimension ()

Static Public Attributes
static const unsigned int	Dimension
static const unsigned int	IndexDimension = VIndexDimension
static const unsigned int	Length
static const unsigned int	PointDimension

Detailed Description

template<class TCoordRep = double, unsigned int VIndexDimension = 2>
class itk::ContinuousIndex< TCoordRep, VIndexDimension >

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

ContinuousIndex is a templated class that holds a set of coordinates (components). The template parameter TCoordRep can be any data type that behaves like a primitive (or atomic) data type (int, short, float, complex). The VIndexDimension defines the number of components in the continous index array.

See also:: Point; Index

Definition at line 44 of file itkContinuousIndex.h.

Member Typedef Documentation

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef Superclass::BaseArray itk::ContinuousIndex< TCoordRep, VIndexDimension >::BaseArray

The Array type from which this Vector is derived.

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 63 of file itkContinuousIndex.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 129 of file itkFixedArray.h.

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

inherited

A const reference to the ValueType.

Definition at line 135 of file itkFixedArray.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef BaseArray::ConstIterator itk::ContinuousIndex< TCoordRep, VIndexDimension >::ConstIterator

A const iterator through the array.

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 65 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef TCoordRep itk::ContinuousIndex< TCoordRep, VIndexDimension >::CoordRepType

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 54 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef Index<VIndexDimension> itk::ContinuousIndex< TCoordRep, VIndexDimension >::IndexType

Corresponding discrete index type

Definition at line 60 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef BaseArray::Iterator itk::ContinuousIndex< TCoordRep, VIndexDimension >::Iterator

An iterator through the array.

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 64 of file itkContinuousIndex.h.

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

inherited

A pointer to the ValueType.

Definition at line 126 of file itkFixedArray.h.

typedef NumericTraits< ValueType >::RealType itk::Point< TCoordRep, NPointDimension >::RealType

inherited

Definition at line 57 of file itkPoint.h.

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

inherited

A reference to the ValueType.

Definition at line 132 of file itkFixedArray.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef ContinuousIndex itk::ContinuousIndex< TCoordRep, VIndexDimension >::Self

Standard class typedefs.

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 48 of file itkContinuousIndex.h.

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

inherited

Definition at line 137 of file itkFixedArray.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef Point<TCoordRep,VIndexDimension> itk::ContinuousIndex< TCoordRep, VIndexDimension >::Superclass

Reimplemented from itk::Point< TCoordRep, VIndexDimension >.

Definition at line 49 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

typedef TCoordRep itk::ContinuousIndex< TCoordRep, VIndexDimension >::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::Point< TCoordRep, VIndexDimension >.

Definition at line 53 of file itkContinuousIndex.h.

typedef Vector< ValueType, NPointDimension > itk::Point< TCoordRep, NPointDimension >::VectorType

inherited

VectorType define the difference between two Points

Definition at line 72 of file itkPoint.h.

Constructor & Destructor Documentation

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( )

inline

Default constructor has nothing to do.

Definition at line 68 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( const Self & r )

inline

Pass-through constructor to the Point base class.

Definition at line 71 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( const ValueType r[IndexDimension] )

inline

Definition at line 72 of file itkContinuousIndex.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( const IndexType & index )

inline

Construct from discrete index type

Definition at line 75 of file itkContinuousIndex.h.

Member Function Documentation

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

inherited

Get various iterators to the array.

Get an Iterator for the beginning of the FixedArray.

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

inherited

Get a ConstIterator for the beginning of the FixedArray.

void itk::Point< TCoordRep, NPointDimension >::CastFrom ( const Point< TCoordRepB, NPointDimension > & pa )

inlineinherited

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

Definition at line 215 of file itkPoint.h.

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

inherited

Get an Iterator for the end of the FixedArray.

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

inherited

Get a ConstIterator for the end of the FixedArray.

RealType itk::Point< TCoordRep, NPointDimension >::EuclideanDistanceTo ( const Point< TCoordRepB, NPointDimension > & pa ) const

inlineinherited

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 244 of file itkPoint.h.

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

inherited

Fill all elements of the array with the given value.

Referenced by itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >::EvaluateDeformationAtPhysicalPoint(), itk::ChangeInformationImageFilter< TInputImage >::GenerateOutputInformation(), otb::Functor::ShapeAttributesLabelObjectFunctor< TLabelObject, TLabelImage >::operator()(), and itk::ShapeLabelMapFilter< TImage, TLabelImage >::ThreadedProcessLabelObject().

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

staticinherited

Return an FixedArray with all elements assigned to the given value.

vnl_vector_ref<TCoordRep> itk::Point< TCoordRep, NPointDimension >::Get_vnl_vector ( void )

inherited

Get a vnl_vector_ref referencing the same memory block

Deprecated:: Use GetVnlVector() instead.

Return a vnl_vector_ref

vnl_vector<TCoordRep> itk::Point< TCoordRep, NPointDimension >::Get_vnl_vector ( void ) const

inherited

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

Deprecated:: Use GetVnlVector() instead.

Return a vnl_vector const

ValueType* itk::FixedArray< TCoordRep , VLength >::GetDataPointer ( )

inlineinherited

Return a pointer to the data.

Definition at line 216 of file itkFixedArray.h.

const ValueType* itk::FixedArray< TCoordRep , VLength >::GetDataPointer ( ) const

inlineinherited

Definition at line 217 of file itkFixedArray.h.

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

inlineinherited

Definition at line 213 of file itkFixedArray.h.

static unsigned int itk::Point< TCoordRep, NPointDimension >::GetPointDimension ( )

inlinestaticinherited

Get the dimension (size) of the point.

Definition at line 68 of file itkPoint.h.

VectorType itk::Point< TCoordRep, NPointDimension >::GetVectorFromOrigin ( ) const

inherited

Access an element of a point.

vnl_vector_ref<TCoordRep> itk::Point< TCoordRep, NPointDimension >::GetVnlVector ( void )

inherited

Get a vnl_vector_ref referencing the same memory block

vnl_vector<TCoordRep> itk::Point< TCoordRep, NPointDimension >::GetVnlVector ( void ) const

inherited

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

Return a vnl_vector const

bool itk::Point< TCoordRep, NPointDimension >::operator!= ( const Self & pt ) const

inlineinherited

Compare two points for inequality.

Definition at line 98 of file itkPoint.h.

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

inlineinherited

Definition at line 191 of file itkFixedArray.h.

Self itk::Point< TCoordRep, NPointDimension >::operator+ ( const VectorType & vec ) const

inherited

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

const Self& itk::Point< TCoordRep, NPointDimension >::operator+= ( const VectorType & vec )

inherited

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

In place increment by a vector

VectorType itk::Point< TCoordRep, NPointDimension >::operator- ( const Self & pnt ) const

inherited

Computes the Vector difference between two points

Self itk::Point< TCoordRep, NPointDimension >::operator- ( const VectorType & vec ) const

inherited

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

const Self& itk::Point< TCoordRep, NPointDimension >::operator-= ( const VectorType & vec )

inherited

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

In place subtract a vector

bool itk::Point< TCoordRep, NPointDimension >::operator== ( const Self & pt ) const

inlineinherited

Compare two points for equality.

Definition at line 88 of file itkPoint.h.

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.

Operator != compares different types of arrays.

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

inlineinherited

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 197 of file itkFixedArray.h.

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

inlineinherited

Definition at line 198 of file itkFixedArray.h.

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

inlineinherited

Definition at line 199 of file itkFixedArray.h.

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

inlineinherited

Definition at line 200 of file itkFixedArray.h.

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

inlineinherited

Definition at line 201 of file itkFixedArray.h.

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

inlineinherited

Definition at line 202 of file itkFixedArray.h.

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

inlineinherited

Definition at line 203 of file itkFixedArray.h.

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

inlineinherited

Definition at line 204 of file itkFixedArray.h.

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

inlineinherited

Definition at line 205 of file itkFixedArray.h.

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

inlineinherited

Definition at line 206 of file itkFixedArray.h.

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

inlineinherited

Definition at line 207 of file itkFixedArray.h.

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

inlineinherited

Definition at line 208 of file itkFixedArray.h.

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

inherited

Get a begin ReverseIterator.

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

inherited

Get a begin ConstReverseIterator.

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

inherited

Get an end ReverseIterator.

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

inherited

Get an end ConstReverseIterator.

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

inlineinherited

Set/Get element methods are more convenient in wrapping languages

Definition at line 211 of file itkFixedArray.h.

void itk::Point< TCoordRep, NPointDimension >::SetToBarycentricCombination	(	const Self &	A,
		const Self &	B,
		double	alpha
	)

inherited

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

\param A First point
\param B Second point
\param alpha Weight for the first point

The first point is multiplied by \form#650, the second is multiplied 
by * \form#673, 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 \form#675, the resulting point will be placed
in the line segment \form#676 joining \form#677 
and \form#677

If the value of \form#678 the resulting point will be placed outside 
the line segment \form#676 on the side of \form#677.

If the value of \form#679 the resulting point will be placed outside 
the line segment \form#676 on the side of \form#680.

\sa SetToMedian

Set the point to the barycentric combination of two points

void itk::Point< TCoordRep, NPointDimension >::SetToBarycentricCombination	(	const Self &	A,
		const Self &	B,
		const Self &	C,
		double	weightA,
		double	weightB
	)

inherited

 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 \form#682 , The resulting point will alway be placed 
inside the triangle formed by the three points given as arguments.

Set the point to the barycentric combination of three points

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

inherited

 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$

Set the point to the barycentric combination of N points

void itk::Point< TCoordRep, NPointDimension >::SetToMidPoint	(	const Self &	,
		const Self &
	)

inherited

 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.

Set the point to the median point of the two arguments

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

inherited

Get the size of the FixedArray.

RealType itk::Point< TCoordRep, NPointDimension >::SquaredEuclideanDistanceTo ( const Point< TCoordRepB, NPointDimension > & pa ) const

inlineinherited

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 228 of file itkPoint.h.

Member Data Documentation

const unsigned int itk::FixedArray< TCoordRep , VLength >::Dimension

staticinherited

Dimension constant

Definition at line 71 of file itkFixedArray.h.

template<class TCoordRep = double, unsigned int VIndexDimension = 2>

const unsigned int itk::ContinuousIndex< TCoordRep, VIndexDimension >::IndexDimension = VIndexDimension

static

Dimension of the Space

Definition at line 57 of file itkContinuousIndex.h.

const unsigned int itk::FixedArray< TCoordRep , VLength >::Length

staticinherited

Length constant

Definition at line 68 of file itkFixedArray.h.

const unsigned int itk::Point< TCoordRep, NPointDimension >::PointDimension

staticinherited

Dimension of the Space

Definition at line 60 of file itkPoint.h.

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

itkContinuousIndex.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

template<class TCoordRep = double, unsigned int VIndexDimension = 2> class itk::ContinuousIndex< TCoordRep, VIndexDimension >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TCoordRep = double, unsigned int VIndexDimension = 2>
class itk::ContinuousIndex< TCoordRep, VIndexDimension >