ITK  5.2.0
Insight Toolkit
Public Types | 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 >:

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 >
using CArray = ValueType[VLength]
 
using const_iterator = const ValueType *
 
using const_pointer = const ValueType *
 
using const_reference = const ValueType &
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using ConstIterator = const ValueType *
 
using Iterator = ValueType *
 
using iterator = ValueType *
 
using pointer = ValueType *
 
using reference = ValueType &
 
using reverse_iterator = std::reverse_iterator< iterator >
 
using SizeType = unsigned int
 
using ValueType = TCoordRep
 

Public Member Functions

 ContinuousIndex ()=default
 
 ContinuousIndex (const ContinuousIndex &)=default
 
 ContinuousIndex (ContinuousIndex &&)=default
 
ContinuousIndexoperator= (const ContinuousIndex &)=default
 
ContinuousIndexoperator= (ContinuousIndex &&)=default
 
 ~ContinuousIndex ()=default
 
 ContinuousIndex (const ValueType r[IndexDimension])
 
 ContinuousIndex (const IndexType &index)
 
- Public Member Functions inherited from itk::Point< TCoordRep, VIndexDimension >
Pointoperator= (const Point &)=default
 
Pointoperator= (Point &&)=default
 
 Point ()=default
 
 Point (const Point &)=default
 
 Point (const Point< TPointValueType, NPointDimension > &r)
 
 Point (const TPointValueType r[NPointDimension])
 
 Point (const ValueType r[NPointDimension])
 
 Point (Point &&)=default
 
 ~Point ()=default
 
 Point (const TPointValueType &v)
 
 Point (const ValueType &v)
 
 Point (const std::array< ValueType, NPointDimension > &stdArray)
 
Pointoperator= (const ValueType r[NPointDimension])
 
bool operator== (const Self &pt) const
 
bool operator!= (const Self &pt) const
 
const Selfoperator+= (const VectorType &vec)
 
const Selfoperator-= (const VectorType &vec)
 
VectorType operator- (const Self &pnt) const
 
Self operator- (const VectorType &vec) const
 
Self operator+ (const VectorType &vec) const
 
VectorType GetVectorFromOrigin () const
 
vnl_vector_ref< TCoordRep > GetVnlVector ()
 
vnl_vector< TCoordRep > GetVnlVector () const
 
void SetToMidPoint (const Self &, const Self &)
 
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)
 
RealType SquaredEuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
 
RealType EuclideanDistanceTo (const Point< TCoordRepB, NPointDimension > &pa) const
 
- Public Member Functions inherited from itk::FixedArray< TCoordRep, NPointDimension >
 FixedArray ()=default
 
 FixedArray (const FixedArray &)=default
 
 FixedArray (FixedArray &&)=default
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &)
 
 FixedArray (const std::array< ValueType, VLength > &stdArray)
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
 FixedArray (const TScalarValue *r)
 
FixedArrayoperator= (const FixedArray &)=default
 
FixedArrayoperator= (FixedArray &&)=default
 
FixedArrayoperator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArrayoperator= (const ValueType r[VLength])
 
 ~FixedArray ()=default
 
bool operator== (const FixedArray &r) 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
 
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 int index, const_reference value)
 
const_reference GetElement (unsigned int index) const
 
ValueTypeGetDataPointer ()
 
const ValueTypeGetDataPointer () const
 
ValueTypedata ()
 
const ValueTypedata () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
 itkLegacyMacro (ReverseIterator rBegin())
 
 itkLegacyMacro (ConstReverseIterator rBegin() const)
 
 itkLegacyMacro (ReverseIterator rEnd())
 
 itkLegacyMacro (ConstReverseIterator rEnd() const)
 
const_iterator cbegin () const noexcept
 
iterator begin () noexcept
 
const_iterator begin () const noexcept
 
const_iterator cend () const noexcept
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator crbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
const_reverse_iterator crend () const
 
SizeType Size () const
 
SizeType size () const
 
void Fill (const ValueType &)
 
void swap (FixedArray &other)
 

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 &)
 

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 floating point type (float, double). The VIndexDimension defines the number of components in the continuous index array.

See also
Point
Index
Examples
SphinxExamples/src/Core/ImageFunction/LinearlyInterpolatePositionInImage/Code.cxx.

Definition at line 46 of file itkContinuousIndex.h.

Member Typedef Documentation

◆ BaseArray

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

◆ ConstIterator

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

Definition at line 70 of file itkContinuousIndex.h.

◆ CoordRepType

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

Definition at line 59 of file itkContinuousIndex.h.

◆ IndexType

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

Corresponding discrete index type

Definition at line 65 of file itkContinuousIndex.h.

◆ Iterator

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

Definition at line 69 of file itkContinuousIndex.h.

◆ Self

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

Standard class type aliases.

Definition at line 53 of file itkContinuousIndex.h.

◆ Superclass

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

Definition at line 54 of file itkContinuousIndex.h.

◆ ValueType

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

Constructor & Destructor Documentation

◆ ContinuousIndex() [1/5]

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

Constructors

◆ ContinuousIndex() [2/5]

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

Constructors

◆ ContinuousIndex() [3/5]

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

Constructors

◆ ~ContinuousIndex()

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

Constructors

◆ ContinuousIndex() [4/5]

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

◆ ContinuousIndex() [5/5]

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

Member Function Documentation

◆ operator=() [1/2]

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

Constructors

◆ operator=() [2/2]

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

Constructors

Member Data Documentation

◆ IndexDimension

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

Dimension of the Space

Definition at line 62 of file itkContinuousIndex.h.


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