#include <itkImageRandomConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:

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

Wiki Examples:

Examples:: Examples/Iterators/ImageRandomConstIteratorWithIndex.cxx, WikiExamples/Images/ConvertPixelBuffer.cxx, and WikiExamples/Iterators/ImageRandomConstIteratorWithIndex.cxx.

Definition at line 116 of file itkImageRandomConstIteratorWithIndex.h.

Public Types
typedef Superclass::AccessorType	AccessorType

typedef Superclass::ImageType	ImageType

typedef Superclass::IndexType	IndexType

typedef Superclass::IndexValueType	IndexValueType

typedef Superclass::InternalPixelType	InternalPixelType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OffsetValueType	OffsetValueType

typedef Superclass::PixelContainer	PixelContainer

typedef Superclass::PixelContainerPointer	PixelContainerPointer

typedef Superclass::PixelType	PixelType

typedef Superclass::RegionType	RegionType

typedef ImageRandomConstIteratorWithIndex	Self

typedef Superclass::SizeType	SizeType

typedef Superclass::SizeValueType	SizeValueType

typedef ImageConstIteratorWithIndex < TImage >	Superclass

Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
typedef TImage::AccessorFunctorType	AccessorFunctorType

typedef TImage::AccessorType	AccessorType

typedef TImage	ImageType

typedef TImage::IndexType	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef TImage::InternalPixelType	InternalPixelType

typedef TImage::OffsetType	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef TImage::PixelContainer	PixelContainer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef TImage::PixelType	PixelType

typedef TImage::RegionType	RegionType

typedef ImageConstIteratorWithIndex	Self

typedef TImage::SizeType	SizeType

typedef SizeType::SizeValueType	SizeValueType

Public Member Functions
SizeValueType	GetNumberOfSamples () const

	ImageRandomConstIteratorWithIndex ()

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

	ImageRandomConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

bool	IsAtBegin (void) const

bool	IsAtEnd (void) const

void	ReinitializeSeed ()

void	ReinitializeSeed (int)

void	SetNumberOfSamples (SizeValueType number)

	~ImageRandomConstIteratorWithIndex ()


void	GoToBegin (void)


void	GoToEnd (void)


Self &	operator++ ()


Self &	operator-- ()

Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get (void) 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 (void) const

bool	IsAtReverseEnd (void) const

	itkLegacyMacro (Self Begin(void) const)

	itkLegacyMacro (Self End(void) 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 (void) const

virtual	~ImageConstIteratorWithIndex ()

void	SetIndex (const IndexType &ind)

Private Types
typedef Statistics::MersenneTwisterRandomVariateGenerator::Pointer	GeneratorPointer

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::ImageConstIteratorWithIndex< TImage >
static unsigned int	GetImageDimension ()

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

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>

typedef Superclass::AccessorType itk::ImageRandomConstIteratorWithIndex< TImage >::AccessorType

Definition at line 133 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Statistics::MersenneTwisterRandomVariateGenerator::Pointer itk::ImageRandomConstIteratorWithIndex< TImage >::GeneratorPointer

private

Definition at line 218 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::ImageType itk::ImageRandomConstIteratorWithIndex< TImage >::ImageType

Definition at line 128 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::IndexType itk::ImageRandomConstIteratorWithIndex< TImage >::IndexType

Inherit types from the superclass

Definition at line 124 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::IndexValueType itk::ImageRandomConstIteratorWithIndex< TImage >::IndexValueType

Definition at line 134 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::InternalPixelType itk::ImageRandomConstIteratorWithIndex< TImage >::InternalPixelType

Definition at line 131 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::OffsetType itk::ImageRandomConstIteratorWithIndex< TImage >::OffsetType

Definition at line 126 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::OffsetValueType itk::ImageRandomConstIteratorWithIndex< TImage >::OffsetValueType

Definition at line 135 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageRandomConstIteratorWithIndex< TImage >::PixelContainer

Definition at line 129 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainerPointer itk::ImageRandomConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 130 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelType itk::ImageRandomConstIteratorWithIndex< TImage >::PixelType

Definition at line 132 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::RegionType itk::ImageRandomConstIteratorWithIndex< TImage >::RegionType

Definition at line 127 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef ImageRandomConstIteratorWithIndex itk::ImageRandomConstIteratorWithIndex< TImage >::Self

Standard class typedefs.

Definition at line 120 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::SizeType itk::ImageRandomConstIteratorWithIndex< TImage >::SizeType

Definition at line 125 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::SizeValueType

Definition at line 136 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

typedef ImageConstIteratorWithIndex< TImage > itk::ImageRandomConstIteratorWithIndex< TImage >::Superclass

Definition at line 121 of file itkImageRandomConstIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>

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

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

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

inline

Definition at line 140 of file itkImageRandomConstIteratorWithIndex.h.

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.

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 152 of file itkImageRandomConstIteratorWithIndex.h.

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