itk::ImageRandomConstIteratorWithOnlyIndex< TImage > Class Template Reference

#include <itkImageRandomConstIteratorWithOnlyIndex.h>

Inheritance diagram for itk::ImageRandomConstIteratorWithOnlyIndex< TImage >:

Collaboration diagram for itk::ImageRandomConstIteratorWithOnlyIndex< TImage >:

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
using	GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer
GeneratorPointer	m_Generator
SizeValueType	m_NumberOfSamplesRequested
SizeValueType	m_NumberOfSamplesDone
SizeValueType	m_NumberOfPixelsInRegion
	ImageRandomConstIteratorWithOnlyIndex ()
	~ImageRandomConstIteratorWithOnlyIndex () override=default
	ImageRandomConstIteratorWithOnlyIndex (const ImageType *ptr, const RegionType &region)
	ImageRandomConstIteratorWithOnlyIndex (const ImageConstIteratorWithOnlyIndex< TImage > &it)
void	GoToBegin ()
void	GoToEnd ()
bool	IsAtBegin () const
bool	IsAtEnd () const
Self &	operator++ ()
Self &	operator-- ()
void	SetNumberOfSamples (SizeValueType number)
SizeValueType	GetNumberOfSamples () const
void	ReinitializeSeed ()
void	ReinitializeSeed (int)
void	RandomJump ()

Additional Inherited Members
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
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

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

Member Typedef Documentation

GeneratorPointer

template<typename TImage >

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

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 232 of file itkImageRandomConstIteratorWithOnlyIndex.h.

ImageType

template<typename TImage >

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

Definition at line 135 of file itkImageRandomConstIteratorWithOnlyIndex.h.

IndexType

template<typename TImage >

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

Inherit types from the superclass

Definition at line 131 of file itkImageRandomConstIteratorWithOnlyIndex.h.

IndexValueType

template<typename TImage >

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

Definition at line 136 of file itkImageRandomConstIteratorWithOnlyIndex.h.

OffsetType

template<typename TImage >

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

Definition at line 133 of file itkImageRandomConstIteratorWithOnlyIndex.h.

OffsetValueType

template<typename TImage >

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

Definition at line 137 of file itkImageRandomConstIteratorWithOnlyIndex.h.

RegionType

template<typename TImage >

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

Definition at line 134 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Self

template<typename TImage >

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

Standard class type aliases.

Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.

SizeType

template<typename TImage >

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

Definition at line 132 of file itkImageRandomConstIteratorWithOnlyIndex.h.

SizeValueType

template<typename TImage >

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

Definition at line 138 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Superclass

template<typename TImage >

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

Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

ImageRandomConstIteratorWithOnlyIndex() [1/3]

template<typename TImage >

itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex

(

)

Default constructor. Needed since we provide a cast constructor.

~ImageRandomConstIteratorWithOnlyIndex()

template<typename TImage >

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

overridedefault

Default constructor. Needed since we provide a cast constructor.

ImageRandomConstIteratorWithOnlyIndex() [2/3]

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.

ImageRandomConstIteratorWithOnlyIndex() [3/3]

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

Member Function Documentation

GetNumberOfSamples()

template<typename TImage >

SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GetNumberOfSamples

(

)

const

Default constructor. Needed since we provide a cast constructor.

GoToBegin()

template<typename TImage >

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

inline

Move an iterator to the beginning of the region.

Definition at line 162 of file itkImageRandomConstIteratorWithOnlyIndex.h.

GoToEnd()

template<typename TImage >

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

inline

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

Definition at line 171 of file itkImageRandomConstIteratorWithOnlyIndex.h.

IsAtBegin()

template<typename TImage >

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

inline

Is the iterator at the beginning of the region?

Definition at line 180 of file itkImageRandomConstIteratorWithOnlyIndex.h.

IsAtEnd()

template<typename TImage >

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

inline

Is the iterator at the end of the region?

Definition at line 187 of file itkImageRandomConstIteratorWithOnlyIndex.h.

operator++()

template<typename TImage >

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

inline

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

See also

GetIndex

operator--

Definition at line 195 of file itkImageRandomConstIteratorWithOnlyIndex.h.

operator--()

template<typename TImage >

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

inline

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

See also

GetIndex

operator++

Definition at line 206 of file itkImageRandomConstIteratorWithOnlyIndex.h.

RandomJump()

template<typename TImage >

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

private

Default constructor. Needed since we provide a cast constructor.

ReinitializeSeed() [1/2]

template<typename TImage >

void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed

(

)

Reinitialize the seed of the random number generator

ReinitializeSeed() [2/2]

template<typename TImage >

void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed

(

int

)

Default constructor. Needed since we provide a cast constructor.

SetNumberOfSamples()

template<typename TImage >

void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::SetNumberOfSamples

(

SizeValueType

number

)

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

Member Data Documentation

m_Generator

template<typename TImage >

GeneratorPointer itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_Generator

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 233 of file itkImageRandomConstIteratorWithOnlyIndex.h.

m_NumberOfPixelsInRegion

template<typename TImage >

SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfPixelsInRegion

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 236 of file itkImageRandomConstIteratorWithOnlyIndex.h.

m_NumberOfSamplesDone

template<typename TImage >

SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 235 of file itkImageRandomConstIteratorWithOnlyIndex.h.

m_NumberOfSamplesRequested

template<typename TImage >

SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesRequested

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 234 of file itkImageRandomConstIteratorWithOnlyIndex.h.

---

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

• itkImageRandomConstIteratorWithOnlyIndex.h