itk::ImageRandomConstIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRandomConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:

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	RegionType = typename Superclass::RegionType
using	Self = ImageRandomConstIteratorWithIndex
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
using	GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer
GeneratorPointer	m_Generator
SizeValueType	m_NumberOfSamplesRequested
SizeValueType	m_NumberOfSamplesDone
SizeValueType	m_NumberOfPixelsInRegion
	ImageRandomConstIteratorWithIndex ()
	~ImageRandomConstIteratorWithIndex () override=default
	ImageRandomConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageRandomConstIteratorWithIndex (const ImageConstIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
	ImageConstIteratorWithIndex ()
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
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
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)
PixelType	Get () const
const PixelType &	Value () const
void	GoToBegin ()
void	GoToReverseBegin ()
bool	IsAtReverseEnd () const
bool	IsAtEnd () const
bool	Remaining ()
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static unsigned int	GetImageDimension ()
Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	ImageDimension = TImage::ImageDimension
Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
TImage::ConstWeakPointer	m_Image
IndexType	m_PositionIndex
IndexType	m_BeginIndex
IndexType	m_EndIndex
RegionType	m_Region
OffsetValueType	m_OffsetTable [ImageDimension+1]
const InternalPixelType *	m_Position
const InternalPixelType *	m_Begin
const InternalPixelType *	m_End
bool	m_Remaining
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor

Detailed Description

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

A multi-dimensional image iterator that visits a random set of pixels within an image region.

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

ImageRandomConstIteratorWithIndex 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 samples from the image.

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

ImageRandomConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() );
 
it.SetNumberOfSamples(200);
it.GoToBegin();
while( !it.IsAtEnd() )
{
  it.Get();
  ++it;  // here it jumps to another random position inside the region
 }

or

ImageRandomConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() );
 
it.SetNumberOfSamples(200);
it.GoToEnd();
while( !it.IsAtBegin() )
{
  it.Get();
  --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.

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

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Random Selection Of Pixels From Region

Examples

Examples/Iterators/ImageRandomConstIteratorWithIndex.cxx, SphinxExamples/src/Core/Common/RandomSelectOfPixelsFromRegion/Code.cxx, and SphinxExamples/src/IO/ImageBase/ConvertImageToAnotherType/Code.cxx.

Definition at line 116 of file itkImageRandomConstIteratorWithIndex.h.

Member Typedef Documentation

AccessorType

template<typename TImage>

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

Definition at line 133 of file itkImageRandomConstIteratorWithIndex.h.

GeneratorPointer

template<typename TImage>

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

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 230 of file itkImageRandomConstIteratorWithIndex.h.

ImageType

template<typename TImage>

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

Definition at line 128 of file itkImageRandomConstIteratorWithIndex.h.

IndexType

template<typename TImage>

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

Inherit types from the superclass

Definition at line 124 of file itkImageRandomConstIteratorWithIndex.h.

IndexValueType

template<typename TImage>

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

Definition at line 134 of file itkImageRandomConstIteratorWithIndex.h.

InternalPixelType

template<typename TImage>

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

Definition at line 131 of file itkImageRandomConstIteratorWithIndex.h.

OffsetType

template<typename TImage>

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

Definition at line 126 of file itkImageRandomConstIteratorWithIndex.h.

OffsetValueType

template<typename TImage>

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

Definition at line 135 of file itkImageRandomConstIteratorWithIndex.h.

PixelContainer

template<typename TImage>

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

Definition at line 129 of file itkImageRandomConstIteratorWithIndex.h.

PixelContainerPointer

template<typename TImage>

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

Definition at line 130 of file itkImageRandomConstIteratorWithIndex.h.

PixelType

template<typename TImage>

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

Definition at line 132 of file itkImageRandomConstIteratorWithIndex.h.

RegionType

template<typename TImage>

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

Definition at line 127 of file itkImageRandomConstIteratorWithIndex.h.

Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 120 of file itkImageRandomConstIteratorWithIndex.h.

SizeType

template<typename TImage>

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

Definition at line 125 of file itkImageRandomConstIteratorWithIndex.h.

SizeValueType

template<typename TImage>

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

Definition at line 136 of file itkImageRandomConstIteratorWithIndex.h.

Superclass

template<typename TImage>

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

Definition at line 121 of file itkImageRandomConstIteratorWithIndex.h.

Constructor & Destructor Documentation

ImageRandomConstIteratorWithIndex() [1/3]

template<typename TImage>

itk::ImageRandomConstIteratorWithIndex< TImage >::ImageRandomConstIteratorWithIndex

(

)

Default constructor. Needed since we provide a cast constructor.

~ImageRandomConstIteratorWithIndex()

template<typename TImage>

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

overridedefault

Default constructor. Needed since we provide a cast constructor.

ImageRandomConstIteratorWithIndex() [2/3]

template<typename TImage>

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

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

ImageRandomConstIteratorWithIndex() [3/3]

template<typename TImage>

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

inline

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

Definition at line 153 of file itkImageRandomConstIteratorWithIndex.h.

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

Member Function Documentation

GetNumberOfSamples()

template<typename TImage>

SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::GetNumberOfSamples

(

)

const

Default constructor. Needed since we provide a cast constructor.

GoToBegin()

template<typename TImage>

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

inline

Move an iterator to the beginning of the region.

Definition at line 160 of file itkImageRandomConstIteratorWithIndex.h.

GoToEnd()

template<typename TImage>

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

inline

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

Definition at line 169 of file itkImageRandomConstIteratorWithIndex.h.

IsAtBegin()

template<typename TImage>

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

inline

Is the iterator at the beginning of the region?

Definition at line 178 of file itkImageRandomConstIteratorWithIndex.h.

IsAtEnd()

template<typename TImage>

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

inline

Is the iterator at the end of the region?

Definition at line 185 of file itkImageRandomConstIteratorWithIndex.h.

operator++()

template<typename TImage>

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

inline

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

See also

GetIndex

operator--

Definition at line 193 of file itkImageRandomConstIteratorWithIndex.h.

operator--()

template<typename TImage>

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

inline

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

See also

GetIndex

operator++

Definition at line 204 of file itkImageRandomConstIteratorWithIndex.h.

RandomJump()

template<typename TImage>

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

private

Default constructor. Needed since we provide a cast constructor.

ReinitializeSeed() [1/2]

template<typename TImage>

void itk::ImageRandomConstIteratorWithIndex< TImage >::ReinitializeSeed

(

)

Reinitialize the seed of the random number generator

ReinitializeSeed() [2/2]

template<typename TImage>

void itk::ImageRandomConstIteratorWithIndex< TImage >::ReinitializeSeed

(

int

)

Default constructor. Needed since we provide a cast constructor.

SetNumberOfSamples()

template<typename TImage>

void itk::ImageRandomConstIteratorWithIndex< TImage >::SetNumberOfSamples

(

SizeValueType

number

)

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

Examples

SphinxExamples/src/Core/Common/RandomSelectOfPixelsFromRegion/Code.cxx, and SphinxExamples/src/IO/ImageBase/ConvertImageToAnotherType/Code.cxx.

Member Data Documentation

m_Generator

template<typename TImage>

GeneratorPointer itk::ImageRandomConstIteratorWithIndex< TImage >::m_Generator

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 231 of file itkImageRandomConstIteratorWithIndex.h.

m_NumberOfPixelsInRegion

template<typename TImage>

SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfPixelsInRegion

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 234 of file itkImageRandomConstIteratorWithIndex.h.

m_NumberOfSamplesDone

template<typename TImage>

SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfSamplesDone

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 233 of file itkImageRandomConstIteratorWithIndex.h.

m_NumberOfSamplesRequested

template<typename TImage>

SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfSamplesRequested

private

Default constructor. Needed since we provide a cast constructor.

Definition at line 232 of file itkImageRandomConstIteratorWithIndex.h.

---

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

• itkImageRandomConstIteratorWithIndex.h