#include <itkContinuousIndex.h>

Detailed Description

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>
class itk::ContinuousIndex< TCoordinate, 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 TCoordinate can be any floating point type (float, double). The VIndexDimension defines the number of components in the continuous index array.

See also: Point; Index

Definition at line 46 of file itkContinuousIndex.h.

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

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

Public Types
using	BaseArray = typename Superclass::BaseArray

using	ConstIterator = typename BaseArray::ConstIterator

using	CoordinateType = TCoordinate

using	IndexType = Index<VIndexDimension>

using	Iterator = typename BaseArray::Iterator

using	Self = ContinuousIndex

using	Superclass = Point<TCoordinate, VIndexDimension>

using	ValueType = TCoordinate

Public Types inherited from itk::Point< double, 2 >
using	BaseArray

using	ConstIterator

using	CoordinateType

using	Iterator

using	RealType

using	Self

using	Superclass

using	ValueType

using	VectorType

Public Types inherited from itk::FixedArray< double, VPointDimension >
using	CArray

using	const_iterator

using	const_pointer

using	const_reference

using	const_reverse_iterator

using	ConstIterator

using	Iterator

using	iterator

using	pointer

using	reference

using	reverse_iterator

using	SizeType

using	value_type

using	ValueType

Public Member Functions
	ContinuousIndex ()=default

	ContinuousIndex (const ValueType r[IndexDimension])


	ContinuousIndex (const IndexType &index)

Public Member Functions inherited from itk::Point< double, 2 >
RealType	EuclideanDistanceTo (const Point< TCoordinateB, VPointDimension > &pa) const

RealType	EuclideanDistanceTo (const Point< TCoordinateB, VPointDimension > &pa) const

VectorType	GetVectorFromOrigin () const

VectorType	GetVectorFromOrigin () const

vnl_vector_ref< double >	GetVnlVector ()

vnl_vector_ref< double >	GetVnlVector ()

vnl_vector< double >	GetVnlVector () const

vnl_vector< double >	GetVnlVector () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

Self	operator+ (const VectorType &vec) const

Self	operator+ (const VectorType &vec) const

const Self &	operator+= (const VectorType &vec)

const Self &	operator+= (const VectorType &vec)

VectorType	operator- (const Self &pnt) const

VectorType	operator- (const Self &pnt) const

Self	operator- (const VectorType &vec) const

Self	operator- (const VectorType &vec) const

const Self &	operator-= (const VectorType &vec)

const Self &	operator-= (const VectorType &vec)

Point &	operator= (const ValueType r[VPointDimension])

Point &	operator= (const ValueType r[VPointDimension])

bool	operator== (const Self &pt) const

bool	operator== (const Self &pt) const

	Point ()=default

	Point ()=default

	Point (const Point< TPointValueType, VPointDimension > &r)

	Point (const Point< TPointValueType, VPointDimension > &r)

	Point (const std::array< ValueType, VPointDimension > &stdArray)

	Point (const std::array< ValueType, VPointDimension > &stdArray)

	Point (const TPointValueType &v)

	Point (const TPointValueType &v)

	Point (const ValueType &v)

	Point (const ValueType &v)

	Point (std::nullptr_t)=delete

	Point (std::nullptr_t)=delete

void	SetToMidPoint (const Self &, const Self &)

void	SetToMidPoint (const Self &, const Self &)

RealType	SquaredEuclideanDistanceTo (const Point< TCoordinateB, VPointDimension > &pa) const

RealType	SquaredEuclideanDistanceTo (const Point< TCoordinateB, VPointDimension > &pa) const

	Point (const TPointValueType r[VPointDimension])

	Point (const ValueType r[VPointDimension])

	Point (const TPointValueType r[VPointDimension])

	Point (const ValueType r[VPointDimension])

void	SetToBarycentricCombination (const Self &A, const Self &B, double alpha)

void	SetToBarycentricCombination (const Self &A, const Self &B, double alpha)

void	SetToBarycentricCombination (const Self &A, const Self &B, const Self &C, double weightForA, double weightForB)

void	SetToBarycentricCombination (const Self &A, const Self &B, const Self &C, double weightForA, double weightForB)

void	SetToBarycentricCombination (const Self P, const double weights, unsigned int N)

void	SetToBarycentricCombination (const Self P, const double weights, unsigned int N)

void	CastFrom (const Point< TCoordinateB, VPointDimension > &pa)

void	CastFrom (const Point< TCoordinateB, VPointDimension > &pa)

Public Member Functions inherited from itk::FixedArray< double, VPointDimension >
Iterator	Begin ()

ConstIterator	Begin () const

constexpr const_iterator	begin () const noexcept

constexpr iterator	begin () noexcept

constexpr const_iterator	cbegin () const noexcept

constexpr const_iterator	cend () const noexcept

const_reverse_iterator	crbegin () const

const_reverse_iterator	crend () const

ValueType *	data ()

const ValueType *	data () const

Iterator	End ()

ConstIterator	End () const

constexpr const_iterator	end () const noexcept

constexpr iterator	end () noexcept

void	Fill (const ValueType &)

	FixedArray ()=default

	FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)

	FixedArray (const std::array< ValueType, VLength > &stdArray)

	FixedArray (const TScalarValue *r)

ValueType *	GetDataPointer ()

const ValueType *	GetDataPointer () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (FixedArray)

FixedArray &	operator= (const FixedArray< TFixedArrayValueType, VLength > &r)

FixedArray &	operator= (const ValueType r[VLength])

bool	operator== (const FixedArray &r) const

ReverseIterator	rBegin ()

ConstReverseIterator	rBegin () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

ReverseIterator	rEnd ()

ConstReverseIterator	rEnd () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

SizeType	Size () const

constexpr SizeType	size () const

void	swap (FixedArray &other) noexcept

	FixedArray (const ValueType r[VLength])

	FixedArray (const ValueType &)

ITK_GCC_PRAGMA_PUSH ITK_GCC_SUPPRESS_Warray_bounds constexpr reference	operator[] (unsigned int index)

constexpr const_reference	operator[] (unsigned int index) const

ITK_GCC_PRAGMA_POP void	SetElement (unsigned int index, const_reference value)

const_reference	GetElement (unsigned int index) const

Static Public Attributes
static constexpr unsigned int	IndexDimension = VIndexDimension

Static Public Attributes inherited from itk::Point< double, 2 >
static constexpr unsigned int	PointDimension

static constexpr unsigned int	PointDimension

Static Public Attributes inherited from itk::FixedArray< double, VPointDimension >
static constexpr unsigned int	Dimension

static constexpr unsigned int	Length

Additional Inherited Members
Static Public Member Functions inherited from itk::Point< double, 2 >
static unsigned int	GetPointDimension ()

static unsigned int	GetPointDimension ()

Static Public Member Functions inherited from itk::FixedArray< double, VPointDimension >
static constexpr FixedArray	Filled (const ValueType &value)

Member Typedef Documentation

◆ BaseArray

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::BaseArray = typename Superclass::BaseArray

The Array type from which this Vector is derived.

Definition at line 72 of file itkContinuousIndex.h.

◆ ConstIterator

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::ConstIterator = typename BaseArray::ConstIterator

Definition at line 74 of file itkContinuousIndex.h.

◆ CoordinateType

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::CoordinateType = TCoordinate

Definition at line 59 of file itkContinuousIndex.h.

◆ IndexType

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::IndexType = Index<VIndexDimension>

Corresponding discrete index type

Definition at line 69 of file itkContinuousIndex.h.

◆ Iterator

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::Iterator = typename BaseArray::Iterator

Definition at line 73 of file itkContinuousIndex.h.

◆ Self

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::Self = ContinuousIndex

Standard class type aliases.

Definition at line 53 of file itkContinuousIndex.h.

◆ Superclass

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::Superclass = Point<TCoordinate, VIndexDimension>

Definition at line 54 of file itkContinuousIndex.h.

◆ ValueType

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

using itk::ContinuousIndex< TCoordinate, VIndexDimension >::ValueType = TCoordinate

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/3]

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

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

default

Default-constructor.

Note: The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero".

◆ ContinuousIndex() [2/3]

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

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

inline

Pass-through constructor to the Point base class.

Definition at line 81 of file itkContinuousIndex.h.

◆ ContinuousIndex() [3/3]

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

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

inline

Construct from discrete index type

Definition at line 86 of file itkContinuousIndex.h.

Member Data Documentation

◆ IndexDimension

template<typename TCoordinate = double, unsigned int VIndexDimension = 2>

unsigned int itk::ContinuousIndex< TCoordinate, VIndexDimension >::IndexDimension = VIndexDimension

staticconstexpr

Dimension of the Space

Definition at line 66 of file itkContinuousIndex.h.

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

itkContinuousIndex.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BaseArray

◆ ConstIterator

◆ CoordinateType

◆ IndexType

◆ Iterator

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ ContinuousIndex() [1/3]

◆ ContinuousIndex() [2/3]

◆ ContinuousIndex() [3/3]

Member Data Documentation

◆ IndexDimension