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

Multi-dimensional image iterator which walks randomly within a region. More...

#include <itkImageRandomConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomConstIteratorWithIndex:

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

[legend]List of all members.

Public Types
typedef ImageRandomConstIteratorWithIndex	Self
typedef ImageConstIteratorWithIndex< TImage >	Superclass
typedef TImage::IndexType	IndexType
typedef TImage::RegionType	RegionType
typedef TImage	ImageType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
Public Methods
	ImageRandomConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageRandomConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
void	GoToBegin (void)
void	GoToEnd (void)
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
Self &	operator++ ()
Self &	operator-- ()
	ImageRandomConstIteratorWithIndex ()
	~ImageRandomConstIteratorWithIndex ()
void	SetNumberOfSamples (unsigned long number)
unsigned long	GetNumberOfSamples (void) const
Static Public Methods
void	ReinitializeSeed ()

---

Detailed Description

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

Multi-dimensional image iterator which walks randomly within a region.

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

ImageRandomConstIteratorWithIndex is a multi-dimensional iterator, requiring more information be specified before the iterator can be used than conventional iterators. Whereas the std::vector::iterator from the STL only needs to be passed a pointer to establish the iterator, the multi-dimensional image iterator needs a pointer, the size of the buffer, the size of the region, the start index of the buffer, and the start index of the region. To gain access to this information, ImageRandomConstIteratorWithIndex holds a reference to the image over which it is traversing.

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.

operator++ 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.

\example Common/itkImageRandomConstIteratorWithIndexTest.cxx

Definition at line 95 of file itkImageRandomConstIteratorWithIndex.h.

---

Member Typedef Documentation

template<typename TImage> typedef TImage itk::ImageRandomConstIteratorWithIndex< 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::ImageRandomIteratorWithIndex< TImage >. Definition at line 118 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::IndexType itk::ImageRandomConstIteratorWithIndex< 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::ImageRandomIteratorWithIndex< TImage >. Definition at line 106 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::PixelContainer itk::ImageRandomConstIteratorWithIndex< 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::ImageRandomIteratorWithIndex< TImage >. Definition at line 123 of file itkImageRandomConstIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >. Definition at line 124 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::RegionType itk::ImageRandomConstIteratorWithIndex< 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::ImageRandomIteratorWithIndex< TImage >. Definition at line 112 of file itkImageRandomConstIteratorWithIndex.h.

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

Standard class typedefs. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >. Definition at line 99 of file itkImageRandomConstIteratorWithIndex.h.

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

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >. Definition at line 100 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]

Default constructor. Needed since we provide a cast constructor. Definition at line 128 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 141 of file itkImageRandomConstIteratorWithIndex.h.

---

Member Function Documentation

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

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

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

Move an iterator to the beginning of the region. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

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

Move an iterator to the End of the region. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

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

Is the iterator at the beginning of the region? Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 151 of file itkImageRandomConstIteratorWithIndex.h.

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

Is the iterator at the end of the region? Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 155 of file itkImageRandomConstIteratorWithIndex.h.

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

Increment (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex , operator--

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

Decrement (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex , operator++

template<typename TImage> void itk::ImageRandomConstIteratorWithIndex< TImage >::ReinitializeSeed (    )  [static]

Reinitialize the seed of the random number generator

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

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

---

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

• itkImageRandomConstIteratorWithIndex.h

---