ITK  5.0.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
Examples:
WikiExamples/ImageProcessing/LinearInterpolateImageFunction.cxx.

Definition at line 45 of file itkContinuousIndex.h.

Public Types

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

Public Member Functions

 ContinuousIndex (const ValueType r[IndexDimension])
 
 ContinuousIndex ()=default
 
 ContinuousIndex (const ContinuousIndex &)=default
 
 ContinuousIndex (ContinuousIndex &&)=default
 
ContinuousIndexoperator= (const ContinuousIndex &)=default
 
ContinuousIndexoperator= (ContinuousIndex &&)=default
 
 ~ContinuousIndex ()=default
 
 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 ()
 
vnl_vector< TCoordRep > GetVnlVector () 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 Point &)=default
 
Pointoperator= (Point &&)=default
 
Pointoperator= (const ValueType r[NPointDimension])
 
bool operator== (const Self &pt) const
 
 Point ()=default
 
 Point (const Point &)=default
 
 Point (Point &&)=default
 
 Point (const Point< TPointValueType, NPointDimension > &r)
 
 Point (const TPointValueType r[NPointDimension])
 
 Point (const ValueType r[NPointDimension])
 
void SetToMidPoint (const Self &, const Self &)
 
RealType SquaredEuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
 
 ~Point ()=default
 
 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
 
void swap (FixedArray &other)
 
 FixedArray ()=default
 
 FixedArray (const FixedArray &)=default
 
 FixedArray (FixedArray &&)=default
 
FixedArrayoperator= (const FixedArray &)=default
 
FixedArrayoperator= (FixedArray &&)=default
 
 ~FixedArray ()=default
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &)
 
 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 constexpr unsigned int IndexDimension = VIndexDimension
 
- Static Public Attributes inherited from itk::Point< TCoordRep, VIndexDimension >
static constexpr unsigned int PointDimension
 
- Static Public Attributes inherited from itk::FixedArray< TCoordRep, NPointDimension >
static constexpr unsigned int Dimension
 
static constexpr 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>
using itk::ContinuousIndex< TCoordRep, VIndexDimension >::BaseArray = typename Superclass::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>
using itk::ContinuousIndex< TCoordRep, VIndexDimension >::ConstIterator = typename BaseArray::ConstIterator

Definition at line 66 of file itkContinuousIndex.h.

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

Definition at line 55 of file itkContinuousIndex.h.

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

Corresponding discrete index type

Definition at line 61 of file itkContinuousIndex.h.

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

Definition at line 65 of file itkContinuousIndex.h.

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

Standard class type aliases.

Definition at line 49 of file itkContinuousIndex.h.

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

Definition at line 50 of file itkContinuousIndex.h.

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
using itk::ContinuousIndex< TCoordRep, VIndexDimension >::ValueType = TCoordRep

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 ( )
default

Constructors

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

Constructors

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

Constructors

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

Constructors

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 78 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 81 of file itkContinuousIndex.h.

Member Function Documentation

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
ContinuousIndex& itk::ContinuousIndex< TCoordRep, VIndexDimension >::operator= ( const ContinuousIndex< TCoordRep, VIndexDimension > &  )
default

Constructors

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

Constructors

Member Data Documentation

template<typename TCoordRep = double, unsigned int VIndexDimension = 2>
constexpr 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: