#include <itkImageRandomNonRepeatingConstIteratorWithIndex.h>

Detailed Description

template<typename TImage>
class itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >

A multi-dimensional image iterator that visits a random set of pixels within an image region. All pixels in the image will be visited before any are repeated. A priority image may be passed to the iterator which will cause it to select certain sets of pixels (those with lower priority values) before others.

This class was contributed by Rupert Brooks, McGill Centre for Intelligent Machines, Montreal, Canada. It is heavily based on the ImageRandomIterator class.

ImageRandomNonRepeatingConstIteratorWithIndex is a multi-dimensional iterator class that is templated over image type. ImageRandomNonRepeatingConstIteratorWithIndex is constrained to walk only within the specified region. When first instantiated, it creates (and stores) a random permutation of the image pixels. It then visits each pixel in the order specified by the permutation. Thus, iterator++ followed by iterator– will end up leaving the iterator pointing at the same pixel. Furthermore, iterating from beginning to end will cover each pixel in the region exactly once.

This iterator can be passed an image the same size as the region, which specifies a priority for the pixels. Within areas of this priority image that have the same value, the pixel selection will be random. Otherwise the pixel selection will be in the order of the priority image. In the extreme, this allows the order of the pixel selection to be completely specified.

ImageRandomNonRepeatingConstIteratorWithIndex assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.

MORE INFORMATION: For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.

Author: Rupert Brooks, McGill Centre for Intelligent Machines. Canada

See also: ImageConstIterator; ConditionalConstIterator; ConstNeighborhoodIterator; ConstShapedNeighborhoodIterator; ConstSliceIterator; CorrespondenceDataStructureIterator; FloodFilledFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalIterator; FloodFilledSpatialFunctionConditionalConstIterator; FloodFilledSpatialFunctionConditionalIterator; ImageConstIterator; ImageConstIteratorWithIndex; ImageIterator; ImageIteratorWithIndex; ImageLinearConstIteratorWithIndex; ImageLinearIteratorWithIndex; ImageRandomNonRepeatingConstIteratorWithIndex; ImageRandomIteratorWithIndex; ImageRegionConstIterator; ImageRegionConstIteratorWithIndex; ImageRegionExclusionConstIteratorWithIndex; ImageRegionExclusionIteratorWithIndex; ImageRegionIterator; ImageRegionIteratorWithIndex; ImageRegionReverseConstIterator; ImageRegionReverseIterator; ImageReverseConstIterator; ImageReverseIterator; ImageSliceConstIteratorWithIndex; ImageSliceIteratorWithIndex; NeighborhoodIterator; PathConstIterator; PathIterator; ShapedNeighborhoodIterator; SliceIterator; ImageConstIteratorWithIndex

ITK Sphinx Examples:

All ITK Sphinx Examples

Definition at line 214 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Inheritance diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

Public Types
using	AccessorType

using	ImageType

using	IndexType

using	IndexValueType

using	InternalPixelType

using	OffsetType

using	OffsetValueType

using	PixelContainer

using	PixelContainerPointer

using	PixelType

using	PriorityImageType = itk::Image<SizeValueType, Self::ImageDimension>

using	RegionType

using	Self = ImageRandomNonRepeatingConstIteratorWithIndex

using	SizeType

using	SizeValueType

using	Superclass = ImageConstIteratorWithIndex<TImage>

Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
using	AccessorFunctorType = typename TImage::AccessorFunctorType

using	AccessorType = typename TImage::AccessorType

using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	IndexValueType = typename IndexType::IndexValueType

using	InternalPixelType = typename TImage::InternalPixelType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelContainer = typename TImage::PixelContainer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	PixelType = typename TImage::PixelType

using	RegionType = typename TImage::RegionType

using	Self = ImageConstIteratorWithIndex

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
SizeValueType	GetNumberOfSamples () const

	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)

bool	IsAtBegin () const

bool	IsAtEnd () const

Self &	operator= (const Self &it)

void	ReinitializeSeed ()

void	ReinitializeSeed (int)

void	SetPriorityImage (const PriorityImageType *priorityImage)


	ImageRandomNonRepeatingConstIteratorWithIndex ()=default

	~ImageRandomNonRepeatingConstIteratorWithIndex () override


void	GoToBegin ()


void	GoToEnd ()


Self &	operator++ ()


Self &	operator-- ()


void	SetNumberOfSamples (SizeValueType number)

Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get () const

const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithIndex ()=default

	ImageConstIteratorWithIndex (const Self &it)

	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)

bool	IsAtEnd () const

bool	IsAtReverseEnd () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

Self &	operator= (const Self &it)

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

bool	Remaining ()

const PixelType &	Value () const

virtual	~ImageConstIteratorWithIndex ()=default

void	SetIndex (const IndexType &ind)

Static Public Attributes
static constexpr unsigned int	ImageDimension = TImage::ImageDimension

Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	ImageDimension = TImage::ImageDimension

Private Member Functions
void	UpdatePosition ()

Private Attributes
SizeValueType	m_NumberOfPixelsInRegion {}

SizeValueType	m_NumberOfSamplesDone {}

SizeValueType	m_NumberOfSamplesRequested {}

RandomPermutation *	m_Permutation {}

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	GetImageDimension ()

Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelType *	m_Begin { nullptr }

IndexType	m_BeginIndex { { 0 } }

const InternalPixelType *	m_End { nullptr }

IndexType	m_EndIndex { { 0 } }

TImage::ConstWeakPointer	m_Image {}

OffsetValueType	m_OffsetTable [ImageDimension+1] {}

AccessorType	m_PixelAccessor {}

AccessorFunctorType	m_PixelAccessorFunctor {}

const InternalPixelType *	m_Position { nullptr }

IndexType	m_PositionIndex { { 0 } }

RegionType	m_Region {}

bool	m_Remaining { false }

Member Typedef Documentation

◆ AccessorType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::AccessorType

Accessor type that converts data between internal and external representations.

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

◆ ImageType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::ImageType

Image type alias support

Definition at line 116 of file itkImageConstIteratorWithIndex.h.

◆ IndexType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::IndexType

Index type alias support

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

◆ IndexValueType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::IndexValueType

Definition at line 106 of file itkImageConstIteratorWithIndex.h.

◆ InternalPixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 125 of file itkImageConstIteratorWithIndex.h.

◆ OffsetType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

◆ OffsetValueType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::OffsetValueType

Definition at line 137 of file itkImageConstIteratorWithIndex.h.

◆ PixelContainer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainer

PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc.

Definition at line 121 of file itkImageConstIteratorWithIndex.h.

◆ PixelContainerPointer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 122 of file itkImageConstIteratorWithIndex.h.

◆ PixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelType

External Pixel Type

Definition at line 128 of file itkImageConstIteratorWithIndex.h.

◆ PriorityImageType

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PriorityImageType = itk::Image<SizeValueType, Self::ImageDimension>

Image with priorities

Definition at line 298 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ RegionType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::RegionType

Region type alias support

Definition at line 113 of file itkImageConstIteratorWithIndex.h.

◆ Self

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Self = ImageRandomNonRepeatingConstIteratorWithIndex

Standard class type aliases.

Definition at line 218 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ SizeType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::SizeType

Size type alias support

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

◆ SizeValueType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::SizeValueType

Definition at line 110 of file itkImageConstIteratorWithIndex.h.

◆ Superclass

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex<TImage>

Definition at line 219 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [1/3]

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

Referenced by itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex(), and itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::operator=().

◆ ~ImageRandomNonRepeatingConstIteratorWithIndex()

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::~ImageRandomNonRepeatingConstIteratorWithIndex ( )

inlineoverride

Default constructor. Needed since we provide a cast constructor.

Definition at line 238 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_Permutation.

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [2/3]

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex	(	const ImageType *	ptr,
		const RegionType &	region )

Constructor establishes an iterator to walk a particular image and a particular region of that image.

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [3/3]

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex ( const ImageConstIteratorWithIndex< TImage > & it )

inline

Constructor that can be used to cast from an ImageIterator to an ImageRandomNonRepeatingConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageRandomNonRepeatingConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRandomNonRepeatingConstIteratorWithIndex.

Definition at line 251 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::ImageConstIteratorWithIndex(), m_Permutation, and itk::ImageConstIteratorWithIndex< TImage >::operator=().

Member Function Documentation

◆ GetNumberOfSamples()

template<typename TImage>

SizeValueType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GetNumberOfSamples ( ) const

inline

Definition at line 343 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesRequested.

◆ GoToBegin()

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToBegin ( )

inline

Move an iterator to the beginning of the region.

Definition at line 264 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone, and UpdatePosition().

◆ GoToEnd()

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToEnd ( )

inline

Move an iterator to one position past the End of the region.

Definition at line 273 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone, m_NumberOfSamplesRequested, and UpdatePosition().

◆ IsAtBegin()

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtBegin ( ) const

inline

Is the iterator at the beginning of the region?

Definition at line 282 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone.

◆ IsAtEnd()

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd ( ) const

inline

Is the iterator at the end of the region?

Definition at line 289 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone, and m_NumberOfSamplesRequested.

◆ operator++()

template<typename TImage>

Self & itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator++ ( )

inline

Increment (prefix) the selected dimension. No bounds checking is performed.

See also: GetIndex; operator--

Definition at line 311 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone, and UpdatePosition().

◆ operator--()

template<typename TImage>

Self & itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator-- ( )

inline

Decrement (prefix) the selected dimension. No bounds checking is performed.

See also: GetIndex; operator++

Definition at line 322 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfSamplesDone, and UpdatePosition().

◆ operator=()

template<typename TImage>

Self & itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator= ( const Self & it )

operator= is provided to deep copy m_Permutation.

◆ ReinitializeSeed() [1/2]

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed ( )

Reinitialize the seed of the random number generator.

◆ ReinitializeSeed() [2/2]

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed ( int )

Reinitialize the seed of the random number generator with a specific value

◆ SetNumberOfSamples()

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetNumberOfSamples ( SizeValueType number )

inline

Set/Get number of random samples to extract from the image region.

Definition at line 332 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

References m_NumberOfPixelsInRegion, and m_NumberOfSamplesRequested.

◆ SetPriorityImage()

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetPriorityImage ( const PriorityImageType * priorityImage )

Set the priority image. The priority image controls the order of the random selection. Pixels of the same priority will be ordered randomly, but pixels of lower priority value will be selected first.