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

#include <itkImageRandomNonRepeatingConstIteratorWithIndex.h>

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

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 https://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
Wiki Examples:
Examples:
WikiExamples/Iterators/ImageRandomNonRepeatingConstIteratorWithIndex.cxx.

Definition at line 227 of file itkImageRandomNonRepeatingConstIteratorWithIndex.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 itk::Image
< SizeValueType,
itkGetStaticConstMacro(ImageDimension) > 
PriorityImageType
 
typedef Superclass::RegionType RegionType
 
typedef
ImageRandomNonRepeatingConstIteratorWithIndex 
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
 
 ImageRandomNonRepeatingConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 
 ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
Selfoperator= (const Self &it)
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int)
 
void SetNumberOfSamples (SizeValueType number)
 
void SetPriorityImage (const PriorityImageType *priorityImage)
 
 ImageRandomNonRepeatingConstIteratorWithIndex ()
 
 ~ImageRandomNonRepeatingConstIteratorWithIndex ()
 
void GoToBegin (void)
 
void GoToEnd (void)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType Get (void) const
 
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () 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
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
bool Remaining ()
 
const PixelTypeValue (void) const
 
virtual ~ImageConstIteratorWithIndex ()
 
void SetIndex (const IndexType &ind)
 

Static Public Attributes

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

Private Member Functions

void UpdatePosition ()
 

Private Attributes

SizeValueType m_NumberOfPixelsInRegion
 
SizeValueType m_NumberOfSamplesDone
 
SizeValueType m_NumberOfSamplesRequested
 
RandomPermutationm_Permutation
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static unsigned int GetImageDimension ()
 
- Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelTypem_Begin
 
IndexType m_BeginIndex
 
const InternalPixelTypem_End
 
IndexType m_EndIndex
 
TImage::ConstWeakPointer m_Image
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 
const InternalPixelTypem_Position
 
IndexType m_PositionIndex
 
RegionType m_Region
 
bool m_Remaining
 

Member Typedef Documentation

Inherit types from the superclass

Definition at line 235 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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

Image with priorities

Definition at line 309 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Standard class typedefs.

Definition at line 231 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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

Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

Default constructor. Needed since we provide a cast constructor.

Definition at line 251 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.

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 267 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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

Member Function Documentation

template<typename TImage>
SizeValueType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GetNumberOfSamples ( ) const
template<typename TImage>
void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToBegin ( void  )
inline

Move an iterator to the beginning of the region.

Definition at line 278 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 286 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 294 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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

Is the iterator at the end of the region?

Definition at line 300 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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 320 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 330 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>
Self& itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator= ( const Self it)

operator= is provided to deep copy m_Permutation.

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

Reinitialize the seed of the random number generator

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 >::SetNumberOfSamples ( SizeValueType  number)

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

Examples:
WikiExamples/Iterators/ImageRandomNonRepeatingConstIteratorWithIndex.cxx.
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.

template<typename TImage>
void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::UpdatePosition ( )
private

Member Data Documentation

template<typename TImage>
const unsigned int itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension
static

The moving image dimension.

Definition at line 306 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>
SizeValueType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::m_NumberOfPixelsInRegion
private
template<typename TImage>
SizeValueType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::m_NumberOfSamplesDone
private
template<typename TImage>
SizeValueType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::m_NumberOfSamplesRequested
private
template<typename TImage>
RandomPermutation* itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::m_Permutation
private

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