#include <itkOffset.h>

Inheritance diagram for itk::Offset< VDimension >:

Detailed Description

template<unsigned int VDimension = 2>
struct itk::Offset< VDimension >

Represent a n-dimensional offset between two n-dimensional indexes of n-dimensional image.

Offset is a templated class to represent a multi-dimensional offset, i.e. (i,j,k,...). Offset is templated over the dimension of the space. ITK assumes the first element of a size (bounds) is the fastest moving index.

For efficiency, Offset does not define a default constructor, a copy constructor, or an operator=. We rely on the compiler to provide efficient bitwise copies.

Offset is an "aggregate" class. Its data is public (m_InternalArray) allowing for fast and convenient instantiations/assignments.

The following syntax for assigning an aggregate type like this is allowed/suggested:

Offset<3> var{{ 256, 256, 20 }}; // Also prevent narrowing conversions Offset<3> var = {{ 256, 256, 20 }};

The doubled braces {{ and }} are required to prevent `gcc -Wall' (and perhaps other compilers) from complaining about a partly bracketed initializer.

As an aggregate type that is intended to provide highest performance characteristics, this class is not appropriate to inherit from, so setting this struct as final.

See Also: Index

Wiki Examples:

Examples:: SphinxExamples/src/Core/Common/AddOffsetToIndex/Code.cxx, and WikiExamples/SimpleOperations/Offset.cxx.

Definition at line 67 of file itkOffset.h.

Public Types
using	const_iterator = const value_type *

using	const_reference = const value_type &

using	const_reverse_iterator = std::reverse_iterator< const_iterator >

using	difference_type = std::ptrdiff_t

using	iterator = value_type *

using	OffsetType = Offset< VDimension >

using	OffsetValueType = ::itk::OffsetValueType

using	reference = value_type &

using	reverse_iterator = std::reverse_iterator< iterator >

using	Self = Offset

using	size_type = unsigned int

using	value_type = ::itk::OffsetValueType

Public Member Functions
void	assign (const value_type &newValue)

reference	at (size_type pos)

const_reference	at (size_type pos) const

reference	back ()

const_reference	back () const

iterator	begin ()

const_iterator	begin () const

OffsetValueType *	data ()

const OffsetValueType *	data () const

constexpr bool	empty () const

iterator	end ()

const_iterator	end () const

void	Fill (OffsetValueType value)

reference	front ()

const_reference	front () const

OffsetValueType	GetElement (unsigned long element) const

const OffsetValueType *	GetOffset () const

constexpr size_type	max_size () const

const Self	operator+ (const Self &vec) const

const Self	operator+ (const Size< VDimension > &sz) const

const Self	operator- (const Self &vec)

reference	operator[] (size_type pos)

const_reference	operator[] (size_type pos) const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

void	SetElement (unsigned long element, OffsetValueType val)

void	SetOffset (const OffsetValueType val[VDimension])

constexpr size_type	size () const

void	swap (Offset &other)


const Self &	operator+= (const Size< VDimension > &sz)


const Self &	operator-= (const Size< VDimension > &sz)


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


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


template<typename TCoordRep >
void	CopyWithRound (const FixedArray< TCoordRep, VDimension > &point)


template<typename TCoordRep >
void	CopyWithCast (const FixedArray< TCoordRep, VDimension > &point)

Static Public Member Functions
static Self	GetBasisOffset (unsigned int dim)

static constexpr unsigned int	GetOffsetDimension ()

Public Attributes

OffsetValueType	m_InternalArray [VDimension]

Static Public Attributes
static constexpr unsigned int	Dimension = VDimension

Private Member Functions
void	ExceptionThrowingBoundsCheck (size_type pos) const

Member Typedef Documentation

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::const_iterator = const value_type *

Definition at line 274 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::const_reference = const value_type &

Definition at line 272 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 278 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::difference_type = std::ptrdiff_t

Definition at line 276 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::iterator = value_type *

Definition at line 273 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::OffsetType = Offset<VDimension>

Compatible Offset and value type alias.

Definition at line 77 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::OffsetValueType = ::itk::OffsetValueType

Definition at line 78 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::reference = value_type &

Definition at line 271 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 277 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::Self = Offset

Standard class type aliases.

Definition at line 74 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::size_type = unsigned int

Definition at line 275 of file itkOffset.h.

template<unsigned int VDimension = 2>

using itk::Offset< VDimension >::value_type = ::itk::OffsetValueType

Mirror the std::array type aliases and member function so that the Offset class can be treated as a container class in a way that is similar to the std::array.

Definition at line 270 of file itkOffset.h.

Member Function Documentation

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::assign ( const value_type & newValue )

inline

Mirror behavior of the std::array manipulations See std::array for documentation on these methods

Definition at line 284 of file itkOffset.h.

template<unsigned int VDimension = 2>

reference itk::Offset< VDimension >::at ( size_type pos )

inline

Definition at line 359 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reference itk::Offset< VDimension >::at ( size_type pos ) const

inline

Definition at line 364 of file itkOffset.h.

template<unsigned int VDimension = 2>

reference itk::Offset< VDimension >::back ( )

inline

Definition at line 379 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reference itk::Offset< VDimension >::back ( ) const

inline

Definition at line 384 of file itkOffset.h.

template<unsigned int VDimension = 2>

iterator itk::Offset< VDimension >::begin ( )

inline

Definition at line 294 of file itkOffset.h.

Referenced by itk::Experimental::RectangularImageNeighborhoodShape< VImageDimension >::FillOffsets(), itk::Experimental::ConnectedImageNeighborhoodShape< VImageDimension >::FillOffsets(), itk::operator==(), itk::Offset< ImageDimension >::swap(), and itk::swap().

template<unsigned int VDimension = 2>

const_iterator itk::Offset< VDimension >::begin ( ) const

inline

Definition at line 299 of file itkOffset.h.

template<unsigned int VDimension = 2>

template<typename TCoordRep >

void itk::Offset< VDimension >::CopyWithCast ( const FixedArray< TCoordRep, VDimension > & point )

inline

Copy values from a FixedArray by casting each one of the components

Definition at line 249 of file itkOffset.h.

template<unsigned int VDimension = 2>

template<typename TCoordRep >

void itk::Offset< VDimension >::CopyWithRound ( const FixedArray< TCoordRep, VDimension > & point )

inline

Copy values from a FixedArray by rounding each one of the components

Definition at line 238 of file itkOffset.h.

template<unsigned int VDimension = 2>

OffsetValueType* itk::Offset< VDimension >::data ( )

inline

Definition at line 389 of file itkOffset.h.

template<unsigned int VDimension = 2>

const OffsetValueType* itk::Offset< VDimension >::data ( ) const

inline

Definition at line 394 of file itkOffset.h.

template<unsigned int VDimension = 2>

constexpr bool itk::Offset< VDimension >::empty ( ) const

inline

Definition at line 344 of file itkOffset.h.

template<unsigned int VDimension = 2>

iterator itk::Offset< VDimension >::end ( )

inline

Definition at line 304 of file itkOffset.h.

Referenced by itk::Experimental::ConnectedImageNeighborhoodShape< VImageDimension >::FillOffsets(), itk::operator==(), and itk::swap().

template<unsigned int VDimension = 2>

const_iterator itk::Offset< VDimension >::end ( ) const

inline

Definition at line 309 of file itkOffset.h.

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::ExceptionThrowingBoundsCheck ( size_type pos ) const

inlineprivate

Definition at line 400 of file itkOffset.h.

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::Fill ( OffsetValueType value )

inline

Set one value for the offset in all dimensions. Useful for initializing an offset to zero.

Definition at line 213 of file itkOffset.h.

template<unsigned int VDimension = 2>

reference itk::Offset< VDimension >::front ( )

inline

Definition at line 369 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reference itk::Offset< VDimension >::front ( ) const

inline

Definition at line 374 of file itkOffset.h.

template<unsigned int VDimension>

Offset< VDimension > itk::Offset< VDimension >::GetBasisOffset ( unsigned int dim )

static

Return a basis vector of the form [0, ..., 0, 1, 0, ... 0] where the "1" is positioned in the location specified by the parameter "dim". Valid values of "dim" are 0, ..., VDimension-1.

Definition at line 413 of file itkOffset.h.

References itk::Offset< VDimension >::m_InternalArray.

template<unsigned int VDimension = 2>

OffsetValueType itk::Offset< VDimension >::GetElement ( unsigned long element ) const

inline

Gets the value of one of the elements. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.

Warning: No bound checking is performed

See Also: GetIndex(); SetElement()

Definition at line 206 of file itkOffset.h.

template<unsigned int VDimension = 2>

const OffsetValueType* itk::Offset< VDimension >::GetOffset ( ) const

inline

Get the offset. This provides a read only pointer to the offset.

See Also: SetOffset()

Definition at line 173 of file itkOffset.h.

template<unsigned int VDimension = 2>

static constexpr unsigned int itk::Offset< VDimension >::GetOffsetDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 84 of file itkOffset.h.

template<unsigned int VDimension = 2>

constexpr size_type itk::Offset< VDimension >::max_size ( ) const

inline

Definition at line 339 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self itk::Offset< VDimension >::operator+ ( const Self & vec ) const

inline

Add two offsets.

Definition at line 91 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self itk::Offset< VDimension >::operator+ ( const Size< VDimension > & sz ) const

inline

Add a size to an offset.

Definition at line 103 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self& itk::Offset< VDimension >::operator+= ( const Size< VDimension > & sz )

inline

Increment index by a size.

Definition at line 115 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self& itk::Offset< VDimension >::operator+= ( const Self & vec )

inline

Increment offset by an offset.

Definition at line 149 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self itk::Offset< VDimension >::operator- ( const Self & vec )

inline

Subtract two offsets.

Definition at line 137 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self& itk::Offset< VDimension >::operator-= ( const Size< VDimension > & sz )

inline

Decrement index by a size.

Definition at line 126 of file itkOffset.h.

template<unsigned int VDimension = 2>

const Self& itk::Offset< VDimension >::operator-= ( const Self & vec )

inline

Decrement offset by an offset.

Definition at line 160 of file itkOffset.h.

template<unsigned int VDimension = 2>

reference itk::Offset< VDimension >::operator[] ( size_type pos )

inline

Definition at line 349 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reference itk::Offset< VDimension >::operator[] ( size_type pos ) const

inline

Definition at line 354 of file itkOffset.h.

template<unsigned int VDimension = 2>

reverse_iterator itk::Offset< VDimension >::rbegin ( )

inline

Definition at line 314 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reverse_iterator itk::Offset< VDimension >::rbegin ( ) const

inline

Definition at line 319 of file itkOffset.h.

template<unsigned int VDimension = 2>

reverse_iterator itk::Offset< VDimension >::rend ( )

inline

Definition at line 324 of file itkOffset.h.

template<unsigned int VDimension = 2>

const_reverse_iterator itk::Offset< VDimension >::rend ( ) const

inline

Definition at line 329 of file itkOffset.h.

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::SetElement	(	unsigned long	element,
		OffsetValueType	val
	)

inline

Sets the value of one of the elements. This method is mainly intended to facilitate the access to elements from Tcl and Python where C++ notation is not very convenient.

Warning: No bound checking is performed.

See Also: SetIndex(); GetElement()

Definition at line 195 of file itkOffset.h.

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::SetOffset ( const OffsetValueType val[VDimension] )

inline

Set the index. Try to prototype this function so that val has to point to a block of memory that is the appropriate size.

See Also: GetOffset()

Definition at line 182 of file itkOffset.h.

template<unsigned int VDimension = 2>

constexpr size_type itk::Offset< VDimension >::size ( ) const

inline

Definition at line 334 of file itkOffset.h.

template<unsigned int VDimension = 2>

void itk::Offset< VDimension >::swap ( Offset< VDimension > & other )

inline

Definition at line 289 of file itkOffset.h.

Member Data Documentation

template<unsigned int VDimension = 2>

constexpr unsigned int itk::Offset< VDimension >::Dimension = VDimension

static

Dimension constant

Definition at line 81 of file itkOffset.h.

template<unsigned int VDimension = 2>

OffsetValueType itk::Offset< VDimension >::m_InternalArray[VDimension]

Offset is an "aggregate" class. Its data is public (m_InternalArray) allowing for fast and convenient instantiations/assignments. ( See main class documentation for an example of initialization)

Definition at line 232 of file itkOffset.h.

Referenced by itk::Offset< VDimension >::GetBasisOffset(), itk::Offset< ImageDimension >::operator+(), itk::Offset< ImageDimension >::operator+=(), itk::Offset< ImageDimension >::operator-(), itk::Index< Self::ImageDimension >::operator-(), and itk::Offset< ImageDimension >::operator-=().

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

itkOffset.h

Detailed Description

template<unsigned int VDimension = 2> struct itk::Offset< VDimension >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

template<unsigned int VDimension = 2>
struct itk::Offset< VDimension >