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

#include <itkImageRandomConstIteratorWithIndex.h>

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

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 https://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:
Examples:
Examples/Iterators/ImageRandomConstIteratorWithIndex.cxx, WikiExamples/Images/ConvertPixelBuffer.cxx, and WikiExamples/Iterators/ImageRandomConstIteratorWithIndex.cxx.

Definition at line 116 of file itkImageRandomConstIteratorWithIndex.h.

Public Types

using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using OffsetValueType = typename Superclass::OffsetValueType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageRandomConstIteratorWithIndex
 
using SizeType = typename Superclass::SizeType
 
using SizeValueType = typename Superclass::SizeValueType
 
using Superclass = ImageConstIteratorWithIndex< TImage >
 
- Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
using AccessorFunctorType = typename TImage::AccessorFunctorType
 
using AccessorType = typename TImage::AccessorType
 
using ImageType = TImage
 
using IndexType = typename TImage::IndexType
 
using IndexValueType = typename IndexType::IndexValueType
 
using InternalPixelType = typename TImage::InternalPixelType
 
using OffsetType = typename TImage::OffsetType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelContainer = typename TImage::PixelContainer
 
using PixelContainerPointer = typename PixelContainer::Pointer
 
using PixelType = typename TImage::PixelType
 
using RegionType = typename TImage::RegionType
 
using Self = ImageConstIteratorWithIndex
 
using SizeType = typename TImage::SizeType
 
using SizeValueType = typename SizeType::SizeValueType
 

Public Member Functions

SizeValueType GetNumberOfSamples () const
 
 ImageRandomConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 
 ImageRandomConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int)
 
void SetNumberOfSamples (SizeValueType number)
 
 ImageRandomConstIteratorWithIndex ()
 
 ~ImageRandomConstIteratorWithIndex () override=default
 
void GoToBegin ()
 
void GoToEnd ()
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType Get () 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 () const
 
bool IsAtReverseEnd () 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 () const
 
virtual ~ImageConstIteratorWithIndex ()=default
 
void SetIndex (const IndexType &ind)
 

Private Types

using GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer
 

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::ImageConstIteratorWithIndex< TImage >
static unsigned int GetImageDimension ()
 
- Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int ImageDimension = TImage::ImageDimension
 
- 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

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 133 of file itkImageRandomConstIteratorWithIndex.h.

Definition at line 219 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 128 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 124 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::IndexValueType = typename Superclass::IndexValueType

Definition at line 134 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 131 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 126 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::OffsetValueType = typename Superclass::OffsetValueType

Definition at line 135 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 129 of file itkImageRandomConstIteratorWithIndex.h.

Definition at line 130 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 132 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 127 of file itkImageRandomConstIteratorWithIndex.h.

Standard class type aliases.

Definition at line 120 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 125 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::SizeValueType = typename Superclass::SizeValueType

Definition at line 136 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
using itk::ImageRandomConstIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex< TImage >

Definition at line 121 of file itkImageRandomConstIteratorWithIndex.h.

Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ImageRandomConstIteratorWithIndex< TImage >::~ImageRandomConstIteratorWithIndex ( )
overridedefault

Default constructor. Needed since we provide a cast constructor.

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

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

Member Function Documentation

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

Move an iterator to the beginning of the region.

Definition at line 159 of file itkImageRandomConstIteratorWithIndex.h.

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

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

Definition at line 167 of file itkImageRandomConstIteratorWithIndex.h.

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

Is the iterator at the beginning of the region?

Definition at line 175 of file itkImageRandomConstIteratorWithIndex.h.

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

Is the iterator at the end of the region?

Definition at line 181 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 188 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 198 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)

Member Data Documentation

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

Definition at line 220 of file itkImageRandomConstIteratorWithIndex.h.

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

Definition at line 223 of file itkImageRandomConstIteratorWithIndex.h.

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

Definition at line 222 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>
SizeValueType itk::ImageRandomConstIteratorWithIndex< TImage >::m_NumberOfSamplesRequested
private

Definition at line 221 of file itkImageRandomConstIteratorWithIndex.h.


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