ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::ContinuousIndex< TCoordRep, VIndexDimension > Class Template Reference

#include <itkContinuousIndex.h>

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

Detailed Description

template<typename 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 continuous index array.

See Also
Point
Index

Definition at line 45 of file itkContinuousIndex.h.

Public Types

typedef Superclass::BaseArray BaseArray
 
typedef BaseArray::ConstIterator ConstIterator
 
typedef TCoordRep CoordRepType
 
typedef Index< VIndexDimension > IndexType
 
typedef BaseArray::Iterator Iterator
 
typedef ContinuousIndex Self
 
typedef Point< TCoordRep,
VIndexDimension > 
Superclass
 
typedef TCoordRep ValueType
 
- Public Types inherited from itk::Point< TCoordRep, VIndexDimension >
typedef FixedArray< TCoordRep,
NPointDimension > 
BaseArray
 
typedef BaseArray::ConstIterator ConstIterator
 
typedef TCoordRep CoordRepType
 
typedef BaseArray::Iterator Iterator
 
typedef NumericTraits
< ValueType >::RealType 
RealType
 
typedef Point Self
 
typedef FixedArray< TCoordRep,
NPointDimension > 
Superclass
 
typedef TCoordRep ValueType
 
typedef Vector< ValueType,
NPointDimension > 
VectorType
 
- Public Types inherited from itk::FixedArray< TCoordRep, NPointDimension >
typedef ValueType CArray [VLength]
 
typedef const ValueTypeconst_pointer
 
typedef const ValueTypeconst_reference
 
typedef const ValueTypeConstIterator
 
typedef ValueTypeIterator
 
typedef ValueTypepointer
 
typedef ValueTypereference
 
typedef unsigned int SizeType
 
typedef TCoordRep ValueType
 

Public Member Functions

 ContinuousIndex ()
 
 ContinuousIndex (const Self &r)
 
 ContinuousIndex (const ValueType r[IndexDimension])
 
 ContinuousIndex (const IndexType &index)
 
- Public Member Functions inherited from itk::Point< TCoordRep, VIndexDimension >
RealType EuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
 
VectorType GetVectorFromOrigin () const
 
vnl_vector_ref< TCoordRep > GetVnlVector (void)
 
vnl_vector< TCoordRep > GetVnlVector (void) const
 
 itkLegacyMacro (vnl_vector_ref< TCoordRep > Get_vnl_vector(void))
 
 itkLegacyMacro (vnl_vector< TCoordRep > Get_vnl_vector(void) const)
 
bool operator!= (const Self &pt) const
 
Self operator+ (const VectorType &vec) const
 
const Selfoperator+= (const VectorType &vec)
 
VectorType operator- (const Self &pnt) const
 
Self operator- (const VectorType &vec) const
 
const Selfoperator-= (const VectorType &vec)
 
Pointoperator= (const Self &r)
 
Pointoperator= (const ValueType r[NPointDimension])
 
bool operator== (const Self &pt) const
 
 Point ()
 
void SetToMidPoint (const Self &, const Self &)
 
RealType SquaredEuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
 
 Point (const Point< TPointValueType, NPointDimension > &r)
 
 Point (const TPointValueType r[NPointDimension])
 
 Point (const ValueType r[NPointDimension])
 
 Point (const TPointValueType &v)
 
 Point (const ValueType &v)
 
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 CastFrom (const Point< TCoordRepB, NPointDimension > &pa)
 
- Public Member Functions inherited from itk::FixedArray< TCoordRep, NPointDimension >
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
void Fill (const ValueType &)
 
 FixedArray (const TScalarValue *r)
 
ValueTypeGetDataPointer ()
 
const ValueTypeGetDataPointer () const
 
bool operator!= (const FixedArray &r) const
 
FixedArrayoperator= (const ValueType r[VLength])
 
bool operator== (const FixedArray &r) const
 
ReverseIterator rBegin ()
 
ConstReverseIterator rBegin () const
 
ReverseIterator rEnd ()
 
ConstReverseIterator rEnd () const
 
SizeType Size () const
 
 FixedArray ()
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &r)
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArrayoperator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
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
 
reference operator[] (long long index)
 
const_reference operator[] (long long index) const
 
reference operator[] (unsigned long long index)
 
const_reference operator[] (unsigned long long index) const
 
void SetElement (unsigned short index, const_reference value)
 
const_reference GetElement (unsigned short index) const
 

Static Public Attributes

static const unsigned int IndexDimension = VIndexDimension
 
- Static Public Attributes inherited from itk::Point< TCoordRep, VIndexDimension >
static const unsigned int PointDimension
 
- Static Public Attributes inherited from itk::FixedArray< TCoordRep, NPointDimension >
static const unsigned int Dimension
 
static const unsigned int Length
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Point< TCoordRep, VIndexDimension >
static unsigned int GetPointDimension ()
 
- Static Public Member Functions inherited from itk::FixedArray< TCoordRep, NPointDimension >
static FixedArray Filled (const ValueType &)
 

Member Typedef Documentation

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef Superclass::BaseArray itk::ContinuousIndex< TCoordRep, VIndexDimension >::BaseArray

The Array type from which this Vector is derived.

Definition at line 64 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef BaseArray::ConstIterator itk::ContinuousIndex< TCoordRep, VIndexDimension >::ConstIterator

Definition at line 66 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef TCoordRep itk::ContinuousIndex< TCoordRep, VIndexDimension >::CoordRepType

Definition at line 55 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef Index< VIndexDimension > itk::ContinuousIndex< TCoordRep, VIndexDimension >::IndexType

Corresponding discrete index type

Definition at line 61 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef BaseArray::Iterator itk::ContinuousIndex< TCoordRep, VIndexDimension >::Iterator

Definition at line 65 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef ContinuousIndex itk::ContinuousIndex< TCoordRep, VIndexDimension >::Self

Standard class typedefs.

Definition at line 49 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
typedef Point< TCoordRep, VIndexDimension > itk::ContinuousIndex< TCoordRep, VIndexDimension >::Superclass

Definition at line 50 of file itkContinuousIndex.h.

template<typename 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.

Definition at line 54 of file itkContinuousIndex.h.

Constructor & Destructor Documentation

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( )
inline

Default constructor has nothing to do.

Definition at line 69 of file itkContinuousIndex.h.

template<typename 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 72 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( const ValueType  r[IndexDimension])
inline

Pass-through constructor to the Point base class.

Definition at line 73 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
itk::ContinuousIndex< TCoordRep, VIndexDimension >::ContinuousIndex ( const IndexType index)
inline

Construct from discrete index type

Definition at line 77 of file itkContinuousIndex.h.

Member Data Documentation

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
const unsigned int itk::ContinuousIndex< TCoordRep, VIndexDimension >::IndexDimension = VIndexDimension
static

Dimension of the Space

Definition at line 58 of file itkContinuousIndex.h.


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