#include <itkImageRandomNonRepeatingIteratorWithIndex.h>

Detailed Description

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

A multi-dimensional image iterator that visits image pixels within a region in a random order, without repeating.

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

This iterator is a subclass of itk::ImageRandomNonRepeatingConstIteratorWithIndex that adds write-access functionality. Please see itk::ImageRandomNonRepeatingConstIteratorWithIndex for more information.

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; ImageRandomNonRepeatingConstIteratorWithIndex; ImageRandomNonRepeatingIteratorWithIndex; ImageRandomConstIteratorWithIndex; 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

Add Noise To Binary Image

Definition at line 78 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

Inheritance diagram for itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >:

Public Types
using	AccessorType

using	ImageType

using	IndexType

using	InternalPixelType

using	OffsetType

using	PixelContainer

using	PixelContainerPointer

using	PixelType

using	RegionType

using	Self = ImageRandomNonRepeatingIteratorWithIndex

using	SizeType

using	Superclass = ImageRandomNonRepeatingConstIteratorWithIndex<TImage>

Public Types inherited from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >
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
	ImageRandomNonRepeatingIteratorWithIndex ()=default

	ImageRandomNonRepeatingIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)

	ImageRandomNonRepeatingIteratorWithIndex (ImageType *ptr, const RegionType &region)

void	Set (const PixelType &value) const

PixelType &	Value ()

Public Member Functions inherited from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >
void	GoToBegin ()

void	GoToEnd ()

	ImageRandomNonRepeatingConstIteratorWithIndex ()=default

	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

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

bool	IsAtBegin () const

bool	IsAtEnd () const

Self &	operator++ ()

Self &	operator-- ()

Self &	operator= (const Self &it)

void	ReinitializeSeed ()

void	ReinitializeSeed (int)

void	SetPriorityImage (const PriorityImageType *priorityImage)

	~ImageRandomNonRepeatingConstIteratorWithIndex () override

void	SetNumberOfSamples (SizeValueType number)

SizeValueType	GetNumberOfSamples () const

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

void	SetIndex (const IndexType &ind)

const PixelType &	Value () const

virtual	~ImageConstIteratorWithIndex ()=default

Protected Member Functions

	ImageRandomNonRepeatingIteratorWithIndex (const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > &it)

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

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

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

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

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 231 of file itkImageConstIteratorWithIndex.h.

◆ ImageType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::ImageType

Image type alias support

Definition at line 226 of file itkImageConstIteratorWithIndex.h.

◆ IndexType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::IndexType

Index type alias support

Definition at line 222 of file itkImageConstIteratorWithIndex.h.

◆ InternalPixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 229 of file itkImageConstIteratorWithIndex.h.

◆ OffsetType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image

Definition at line 224 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 227 of file itkImageConstIteratorWithIndex.h.

◆ PixelContainerPointer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 228 of file itkImageConstIteratorWithIndex.h.

◆ PixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelType

External Pixel Type

Definition at line 230 of file itkImageConstIteratorWithIndex.h.

◆ RegionType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::RegionType

Region type alias support

Definition at line 225 of file itkImageConstIteratorWithIndex.h.

◆ Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 83 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

◆ SizeType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::SizeType

Size type alias support

Definition at line 223 of file itkImageConstIteratorWithIndex.h.

◆ Superclass

template<typename TImage>

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

Definition at line 84 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageRandomNonRepeatingIteratorWithIndex() [1/4]

template<typename TImage>

itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

◆ ImageRandomNonRepeatingIteratorWithIndex() [2/4]

template<typename TImage>

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

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

◆ ImageRandomNonRepeatingIteratorWithIndex() [3/4]

template<typename TImage>

itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( const ImageIteratorWithIndex< TImage > & it )

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

◆ ImageRandomNonRepeatingIteratorWithIndex() [4/4]

template<typename TImage>

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

protected

The construction from a const iterator is declared protected in order to enforce const correctness.

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

Member Function Documentation

◆ operator=()

template<typename TImage>

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

protected

The construction from a const iterator is declared protected in order to enforce const correctness.

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

◆ Set()

template<typename TImage>

void itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Set ( const PixelType & value ) const

inline

Set the pixel value

Definition at line 115 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessorFunctor, and itk::ImageConstIteratorWithIndex< TImage >::m_Position.

◆ Value()

template<typename TImage>

PixelType & itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Value ( )

inline

Return a reference to the pixel. This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 124 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

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

itkImageRandomNonRepeatingIteratorWithIndex.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRandomNonRepeatingIteratorWithIndex() [1/4]

◆ ImageRandomNonRepeatingIteratorWithIndex() [2/4]

◆ ImageRandomNonRepeatingIteratorWithIndex() [3/4]

◆ ImageRandomNonRepeatingIteratorWithIndex() [4/4]

Member Function Documentation

◆ operator=()

◆ Set()

◆ Value()