#include <itkImageRandomNonRepeatingConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

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 interator 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

Wiki Examples:

Examples:: WikiExamples/Iterators/ImageRandomNonRepeatingConstIteratorWithIndex.cxx.

Definition at line 215 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Public Types
using	AccessorType = typename Superclass::AccessorType

using	ImageType = typename Superclass::ImageType

using	IndexType = typename Superclass::IndexType

using	IndexValueType = typename Superclass::IndexValueType

using	InternalPixelType = typename Superclass::InternalPixelType

using	OffsetType = typename Superclass::OffsetType

using	OffsetValueType = typename Superclass::OffsetValueType

using	PixelContainer = typename Superclass::PixelContainer

using	PixelContainerPointer = typename Superclass::PixelContainerPointer

using	PixelType = typename Superclass::PixelType

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

using	RegionType = typename Superclass::RegionType

using	Self = ImageRandomNonRepeatingConstIteratorWithIndex

using	SizeType = typename Superclass::SizeType

using	SizeValueType = typename Superclass::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 ImageType *ptr, const RegionType &region)

	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

bool	IsAtBegin () const

bool	IsAtEnd () const

Self &	operator= (const Self &it)

void	ReinitializeSeed ()

void	ReinitializeSeed (int)

void	SetNumberOfSamples (SizeValueType number)

void	SetPriorityImage (const PriorityImageType *priorityImage)


	ImageRandomNonRepeatingConstIteratorWithIndex ()

	~ImageRandomNonRepeatingConstIteratorWithIndex () override


void	GoToBegin ()


void	GoToEnd ()


Self &	operator++ ()


Self &	operator-- ()

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

const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithIndex ()

	ImageConstIteratorWithIndex (const Self &it)

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

bool	IsAtEnd () const

bool	IsAtReverseEnd () const

bool	operator!= (const Self &it) const

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 unsigned int	GetImageDimension ()

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

IndexType	m_BeginIndex

const InternalPixelType *	m_End

IndexType	m_EndIndex

TImage::ConstWeakPointer	m_Image

OffsetValueType	m_OffsetTable [ImageDimension+1]

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

const InternalPixelType *	m_Position

IndexType	m_PositionIndex

RegionType	m_Region

bool	m_Remaining

Member Typedef Documentation

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 232 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 227 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 223 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IndexValueType = typename Superclass::IndexValueType

Definition at line 233 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 230 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 225 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::OffsetValueType = typename Superclass::OffsetValueType

Definition at line 234 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 228 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 229 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 231 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

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

Image with priorities

Definition at line 297 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 226 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

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

Standard class type aliases.

Definition at line 219 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 224 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

using itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SizeValueType = typename Superclass::SizeValueType

Definition at line 235 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 220 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>

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

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

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

inlineoverride

Default constructor. Needed since we provide a cast constructor.

Definition at line 239 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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.

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 255 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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

Member Function Documentation

template<typename TImage>

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

template<typename TImage>

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

inline

Move an iterator to the beginning of the region.

Definition at line 266 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

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

inline

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

Definition at line 274 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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.

template<typename TImage>

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

inline

Is the iterator at the end of the region?

Definition at line 288 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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 308 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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 318 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

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

operator= is provided to deep copy m_Permutation.

template<typename TImage>

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

Reinitialize the seed of the random number generator

template<typename TImage>

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

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

template<typename TImage>

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

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

Examples:: WikiExamples/Iterators/ImageRandomNonRepeatingConstIteratorWithIndex.cxx.

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.

template<typename TImage>

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

private