ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
itk::ImageRandomConstIteratorWithOnlyIndex< TImage > Class Template Reference

#include <itkImageRandomConstIteratorWithOnlyIndex.h>

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

Detailed Description

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

A multi-dimensional image iterator that visits a random set of locations within an image region, providing index information.

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

No access to image data is possible, and thus the class can be used with images of type ImageBase.

ImageRandomConstIteratorWithOnlyIndex 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 indecies from the image.

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

*
* ImageRandomConstIteratorWithOnlyIndex<ImageType> it( image, image->GetRequestedRegion() );
*
* it.SetNumberOfSamples(200);
* it.GoToBegin();
* while( !it.IsAtEnd() )
* {
* std::cout << it.GetIndex() << std::endl;
* ++it; // here it jumps to another random position inside the region
* }
*
*

or

*
* ImageRandomConstIteratorWithOnlyIndex<ImageType> it( image, image->GetRequestedRegion() );
*
* it.SetNumberOfSamples(200);
* it.GoToEnd();
* while( !it.IsAtBegin() )
* {
* std::cout << it.GetIndex() << std::endl;
* --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.

Index-only iterators:

See Also
ImageConstIteratorWithOnlyIndex
ConstNeighborhoodIteratorWithOnlyIndex

Pixel data-access iterators:

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

Definition at line 123 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Public Types

typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::OffsetValueType OffsetValueType
 
typedef Superclass::RegionType RegionType
 
typedef
ImageRandomConstIteratorWithOnlyIndex 
Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SizeValueType SizeValueType
 
typedef
ImageConstIteratorWithOnlyIndex
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TImage::OffsetType OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef TImage::RegionType RegionType
 
typedef
ImageConstIteratorWithOnlyIndex 
Self
 
typedef TImage::SizeType SizeType
 
typedef SizeType::SizeValueType SizeValueType
 

Public Member Functions

SizeValueType GetNumberOfSamples () const
 
 ImageRandomConstIteratorWithOnlyIndex ()
 
 ImageRandomConstIteratorWithOnlyIndex (const ImageType *ptr, const RegionType &region)
 
 ImageRandomConstIteratorWithOnlyIndex (const ImageConstIteratorWithOnlyIndex< TImage > &it)
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int)
 
void SetNumberOfSamples (SizeValueType number)
 
 ~ImageRandomConstIteratorWithOnlyIndex ()
 
void GoToBegin (void)
 
void GoToEnd (void)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
 ImageConstIteratorWithOnlyIndex ()
 
 ImageConstIteratorWithOnlyIndex (const Self &it)
 
 ImageConstIteratorWithOnlyIndex (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
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
bool Remaining ()
 
void SetIndex (const IndexType &ind)
 
virtual ~ImageConstIteratorWithOnlyIndex ()
 

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::ImageConstIteratorWithOnlyIndex< TImage >
static unsigned int GetImageDimension ()
 
- Static Public Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
static const unsigned int ImageDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
IndexType m_BeginIndex
 
IndexType m_EndIndex
 
TImage::ConstPointer m_Image
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
IndexType m_PositionIndex
 
RegionType m_Region
 
bool m_Remaining
 

Member Typedef Documentation

Definition at line 220 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Definition at line 135 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Inherit types from the superclass

Definition at line 131 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Definition at line 136 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Definition at line 133 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Definition at line 137 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Definition at line 134 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Standard class typedefs.

Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Definition at line 132 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Definition at line 138 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >
typedef ImageConstIteratorWithOnlyIndex< TImage > itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Superclass

Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >
itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::~ImageRandomConstIteratorWithOnlyIndex ( )
inline

Definition at line 142 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >
itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex ( 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::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex ( const ImageConstIteratorWithOnlyIndex< TImage > &  it)
inline

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

Definition at line 154 of file itkImageRandomConstIteratorWithOnlyIndex.h.

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

Member Function Documentation

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GetNumberOfSamples ( ) const
template<typename TImage >
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GoToBegin ( void  )
inline
template<typename TImage >
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GoToEnd ( void  )
inline
template<typename TImage >
bool itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::IsAtBegin ( void  ) const
inline

Is the iterator at the beginning of the region?

Definition at line 176 of file itkImageRandomConstIteratorWithOnlyIndex.h.

References itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone.

template<typename TImage >
bool itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::IsAtEnd ( void  ) const
inline
template<typename TImage >
Self& itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::operator++ ( )
inline

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

See Also
GetIndex
operator--

Definition at line 189 of file itkImageRandomConstIteratorWithOnlyIndex.h.

References itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone, and itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::RandomJump().

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

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

See Also
GetIndex
operator++

Definition at line 199 of file itkImageRandomConstIteratorWithOnlyIndex.h.

References itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone, and itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::RandomJump().

template<typename TImage >
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::RandomJump ( )
private
template<typename TImage >
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed ( )

Reinitialize the seed of the random number generator

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

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

Member Data Documentation

template<typename TImage >
GeneratorPointer itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_Generator
private

Definition at line 221 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfPixelsInRegion
private

Definition at line 224 of file itkImageRandomConstIteratorWithOnlyIndex.h.

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone
private
template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesRequested
private

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