itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]

A multi-dimensional image iterator that visits a random set of pixels within an image region. All pixels in the image will be visited before any are repeated. A priority image may be passed to the interator which will cause it to select certain sets of pixels (those with lower priority values) before others. More...

#include <itkImageRandomNonRepeatingConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

[legend]Collaboration diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

[legend]List of all members.

Public Types
typedef ImageRandomNonRepeatingConstIteratorWithIndex	Self
typedef ImageConstIteratorWithIndex< TImage >	Superclass
typedef TImage::IndexType	IndexType
typedef TImage::RegionType	RegionType
typedef TImage	ImageType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef itk::Image< unsigned long, itkGetStaticConstMacro(ImageDimension)	PriorityImageType )
Public Member Functions
	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
	itkStaticConstMacro (ImageDimension, unsigned int,::itk::GetImageDimension< TImage >::ImageDimension)
void	SetPriorityImage (const PriorityImageType *priorityImage)
void	ReinitializeSeed ()
void	ReinitializeSeed (int)
	ImageRandomNonRepeatingConstIteratorWithIndex ()
	~ImageRandomNonRepeatingConstIteratorWithIndex ()
void	GoToBegin (void)
void	GoToEnd (void)
Self &	operator++ ()
Self &	operator-- ()
void	SetNumberOfSamples (unsigned long number)
unsigned long	GetNumberOfSamples (void) const

---

Detailed Description

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

A multi-dimensional image iterator that visits a random set of pixels within an image region. All pixels in the image will be visited before any are repeated. A priority image may be passed to the interator which will cause it to select certain sets of pixels (those with lower priority values) before others.

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

ImageRandomNonRepeatingConstIteratorWithIndex is a multi-dimensional iterator class that is templated over image type. ImageRandomNonRepeatingConstIteratorWithIndex is constrained to walk only within the specified region. When first instantiated, it creates (and stores) a random permutation of the image pixels. It then visits each pixel in the order specified by the permutation. Thus, iterator++ followed by iterator-- will end up leaving the iterator pointing at the same pixel. Furthermore, iterating from beginning to end will cover each pixel in the region exactly once.

This iterator can be passed an image the same size as the region, which specifies a priority for the pixels. Within areas of this priority image that have the same value, the pixel selection will be random. Otherwise the pixel selection will be in the order of the priority image. In the extreme, this allows the order of the pixel selection to be completely specified.

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

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 http://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

ImageLinearConstIteratorWithIndex

ImageLinearIteratorWithIndex

ImageRandomNonRepeatingConstIteratorWithIndex

ImageRandomIteratorWithIndex

ImageRegionConstIterator

ImageRegionConstIteratorWithIndex

ImageRegionExclusionConstIteratorWithIndex

ImageRegionExclusionIteratorWithIndex

ImageRegionIterator

ImageRegionIteratorWithIndex

ImageRegionReverseConstIterator

ImageRegionReverseIterator

ImageReverseConstIterator

ImageReverseIterator

ImageSliceConstIteratorWithIndex

ImageSliceIteratorWithIndex

NeighborhoodIterator

PathConstIterator

PathIterator

ShapedNeighborhoodIterator

SliceIterator

ImageConstIteratorWithIndex

Definition at line 196 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

---

Member Typedef Documentation

template<typename TImage> typedef TImage itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageType

Image typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 219 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::IndexType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IndexType

Index typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 207 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::PixelContainer itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelContainer

PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 224 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> typedef PixelContainer::Pointer itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelContainerPointer

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 225 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> typedef itk::Image< unsigned long, itkGetStaticConstMacro(ImageDimension ) itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PriorityImageType)

Image with priorities Definition at line 285 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h. Referenced by itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd().

template<typename TImage> typedef TImage::RegionType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::RegionType

Region typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Region back to itk::ImageRegion so that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 213 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> typedef ImageRandomNonRepeatingConstIteratorWithIndex itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Self

Standard class typedefs. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 200 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h. Referenced by itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd().

template<typename TImage> typedef ImageConstIteratorWithIndex<TImage> itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Superclass

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >. Definition at line 201 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

---

Constructor & Destructor Documentation

template<typename TImage> itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex (   )

Default constructor. Needed since we provide a cast constructor.

template<typename TImage> itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::~ImageRandomNonRepeatingConstIteratorWithIndex (   )  [inline]

Default constructor. Needed since we provide a cast constructor. Definition at line 229 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex (  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::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex (  const ImageConstIteratorWithIndex< TImage > &  it  )  [inline]

Constructor that can be used to cast from an ImageIterator to an ImageRandomNonRepeatingConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageRandomNonRepeatingConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRandomNonRepeatingConstIteratorWithIndex. Definition at line 242 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h. References NULL.

---

Member Function Documentation

template<typename TImage> unsigned long itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GetNumberOfSamples (  void   )  const

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

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToBegin (  void   )  [inline]

Move an iterator to the beginning of the region. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 249 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToEnd (  void   )  [inline]

Move an iterator to one position past the End of the region. Definition at line 257 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtBegin (  void   )  const [inline]

Is the iterator at the beginning of the region? Definition at line 265 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd (  void   )  const [inline]

Is the iterator at the end of the region? Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 271 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h. References itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PriorityImageType, and itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Self.

template<typename TImage> itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, ::itk::GetImageDimension< TImage >::ImageDimension  )

The moving image dimension.

template<typename TImage> Self& itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator++ (   )  [inline]

Increment (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex operator-- Definition at line 296 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> Self& itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator-- (   )  [inline]

Decrement (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex operator++ Definition at line 306 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed (  int   )

Reinitialize the seed of the random number generator with a specific value

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed (   )

Reinitialize the seed of the random number generator

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetNumberOfSamples (  unsigned long  number  )

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

template<typename TImage> void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetPriorityImage (  const PriorityImageType *  priorityImage  )

Set the priority image. The priority image controls the order of the random selection. Pixels of the same priority will be ordered randomly, but pixels of lower priority value will be selected first.

---

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

• itkImageRandomNonRepeatingConstIteratorWithIndex.h

---