ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
itk::ImageRandomConstIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRandomConstIteratorWithIndex.h>

+ Inheritance diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:
+ Collaboration diagram for itk::ImageRandomConstIteratorWithIndex< TImage >:

List of all members.

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 Member Functions

SizeValueType GetNumberOfSamples (void) 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)
Selfoperator++ ()
Selfoperator-- ()

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

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

Definition at line 116 of file itkImageRandomConstIteratorWithIndex.h.


Member Typedef Documentation

Accessor type that converts data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 133 of file itkImageRandomConstIteratorWithIndex.h.

Definition at line 218 of file itkImageRandomConstIteratorWithIndex.h.

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

Image typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 128 of file itkImageRandomConstIteratorWithIndex.h.

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

Inherit types from the superclass

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 124 of file itkImageRandomConstIteratorWithIndex.h.

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 131 of file itkImageRandomConstIteratorWithIndex.h.

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

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 126 of file itkImageRandomConstIteratorWithIndex.h.

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

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

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 132 of file itkImageRandomConstIteratorWithIndex.h.

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

Region typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 127 of file itkImageRandomConstIteratorWithIndex.h.

Standard class typedefs.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 120 of file itkImageRandomConstIteratorWithIndex.h.

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

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomIteratorWithIndex< TImage >.

Definition at line 125 of file itkImageRandomConstIteratorWithIndex.h.

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

Constructor & Destructor Documentation

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.


Member Function Documentation

template<typename TImage>
SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::GetNumberOfSamples ( void  ) const
template<typename TImage>
void itk::ImageRandomConstIteratorWithIndex< TImage >::GoToBegin ( void  ) [inline]

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 158 of file itkImageRandomConstIteratorWithIndex.h.

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

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

Definition at line 166 of file itkImageRandomConstIteratorWithIndex.h.

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

Is the iterator at the beginning of the region?

Definition at line 174 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 180 of file itkImageRandomConstIteratorWithIndex.h.

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

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

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

Reinitialize the seed of the random number generator

template<typename TImage>
void itk::ImageRandomConstIteratorWithIndex< TImage >::ReinitializeSeed ( int  )
template<typename TImage>
void itk::ImageRandomConstIteratorWithIndex< TImage >::SetNumberOfSamples ( SizeValueType  number)

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


Member Data Documentation

template<typename TImage>
GeneratorPointer itk::ImageRandomConstIteratorWithIndex< TImage >::m_Generator [private]

Definition at line 219 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfPixelsInRegion [private]

Definition at line 222 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfSamplesDone [private]

Definition at line 221 of file itkImageRandomConstIteratorWithIndex.h.

Definition at line 220 of file itkImageRandomConstIteratorWithIndex.h.


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