#include <itkImageRandomConstIteratorWithOnlyIndex.h>

Inheritance diagram for itk::ImageRandomConstIteratorWithOnlyIndex< TImage >:

Collaboration diagram for itk::ImageRandomConstIteratorWithOnlyIndex< TImage >:

Detailed Description

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

A multi-dimensional image iterator that visits a random set of locations within an image region, providing index information.

ImageRandomConstIteratorWithOnlyIndex is a multi-dimensional iterator class that is templated over image type. ImageRandomConstIteratorWithOnlyIndex is constrained to walk only within the specified region. It samples random region positions at each increment or decrement.

No access to image data is possible, and thus the class can be used with images of type ImageBase.

ImageRandomConstIteratorWithOnlyIndex 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.

The operator++ method provides a simple syntax for walking around a region of a multidimensional image. operator++ performs a jump to a random position within the specified image region. This is designed to facilitate the extraction of random indecies from the image.

This is the typical use of this iterator in a loop:

ImageRandomConstIteratorWithOnlyIndex<ImageType> it( image, image->GetRequestedRegion() );
it.SetNumberOfSamples(200);
it.GoToBegin();
while( !it.IsAtEnd() )
{
  std::cout << it.GetIndex() << std::endl;
  ++it;  // here it jumps to another random position inside the region
 }

or

ImageRandomConstIteratorWithOnlyIndex<ImageType> it( image, image->GetRequestedRegion() );
it.SetNumberOfSamples(200);
it.GoToEnd();
while( !it.IsAtBegin() )
{
  std::cout << it.GetIndex() << std::endl;
  --it;  // here it jumps to another random position inside the region
 }

Warning: Incrementing the iterator (++it) followed by a decrement (–it) or vice versa does not in general return the iterator to the same position.

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.

Index-only iterators:

See Also: ImageConstIteratorWithOnlyIndex; ConstNeighborhoodIteratorWithOnlyIndex

Pixel data-access iterators:

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

Definition at line 123 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Public Types
using	ImageType = typename Superclass::ImageType

using	IndexType = typename Superclass::IndexType

using	IndexValueType = typename Superclass::IndexValueType

using	OffsetType = typename Superclass::OffsetType

using	OffsetValueType = typename Superclass::OffsetValueType

using	RegionType = typename Superclass::RegionType

using	Self = ImageRandomConstIteratorWithOnlyIndex

using	SizeType = typename Superclass::SizeType

using	SizeValueType = typename Superclass::SizeValueType

using	Superclass = ImageConstIteratorWithOnlyIndex< TImage >

Public Types inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	IndexValueType = typename IndexType::IndexValueType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	RegionType = typename TImage::RegionType

using	Self = ImageConstIteratorWithOnlyIndex

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
SizeValueType	GetNumberOfSamples () const

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

	ImageRandomConstIteratorWithOnlyIndex (const ImageConstIteratorWithOnlyIndex< TImage > &it)

bool	IsAtBegin () const

bool	IsAtEnd () const

void	ReinitializeSeed ()

void	ReinitializeSeed (int)

void	SetNumberOfSamples (SizeValueType number)


	ImageRandomConstIteratorWithOnlyIndex ()

	~ImageRandomConstIteratorWithOnlyIndex () override=default


void	GoToBegin ()


void	GoToEnd ()


Self &	operator++ ()


Self &	operator-- ()

Public Member Functions inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithOnlyIndex ()

	ImageConstIteratorWithOnlyIndex (const Self &it)

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

void	SetIndex (const IndexType &ind)

virtual	~ImageConstIteratorWithOnlyIndex ()=default

Private Types
using	GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer

Private Member Functions
void	RandomJump ()

Private Attributes
GeneratorPointer	m_Generator

SizeValueType	m_NumberOfPixelsInRegion

SizeValueType	m_NumberOfSamplesDone

SizeValueType	m_NumberOfSamplesRequested

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

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

Protected Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
IndexType	m_BeginIndex

IndexType	m_EndIndex

TImage::ConstPointer	m_Image

OffsetValueType	m_OffsetTable [ImageDimension+1]

IndexType	m_PositionIndex

RegionType	m_Region

bool	m_Remaining

Member Typedef Documentation

template<typename TImage >

using itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer

private

Definition at line 221 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 135 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Inherit types from the superclass

Definition at line 131 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 136 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 133 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 137 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 134 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Standard class type aliases.

Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 132 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

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

Definition at line 138 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >

using itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Superclass = ImageConstIteratorWithOnlyIndex< TImage >

Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex ( )

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >

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

overridedefault

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >

itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex	(	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::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex ( const ImageConstIteratorWithOnlyIndex< TImage > & it )

inline

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

Definition at line 155 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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