ITK  6.0.0
Insight 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>

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 indices 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 https://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.

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

Public Types

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

Public Member Functions

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

Private Types

using GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer
 

Private Member Functions

void RandomJump ()
 

Private Attributes

GeneratorPointer m_Generator { Statistics::MersenneTwisterRandomVariateGenerator::New() }
 
SizeValueType m_NumberOfPixelsInRegion {}
 
SizeValueType m_NumberOfSamplesDone {}
 
SizeValueType m_NumberOfSamplesRequested {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
static constexpr unsigned int GetImageDimension ()
 
- Static Public Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
static constexpr unsigned int ImageDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage >
IndexType m_BeginIndex { { 0 } }
 
IndexType m_EndIndex { { 0 } }
 
TImage::ConstPointer m_Image {}
 
OffsetValueType m_OffsetTable [ImageDimension+1] {}
 
IndexType m_PositionIndex { { 0 } }
 
RegionType m_Region {}
 
bool m_Remaining { false }
 

Member Typedef Documentation

◆ GeneratorPointer

template<typename TImage >
using itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer
private

Definition at line 239 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ ImageType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::ImageType = TImage

Image type alias support

Definition at line 121 of file itkImageConstIteratorWithOnlyIndex.h.

◆ IndexType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 110 of file itkImageConstIteratorWithOnlyIndex.h.

◆ IndexValueType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::IndexValueType = typename IndexType::IndexValueType

Definition at line 111 of file itkImageConstIteratorWithOnlyIndex.h.

◆ OffsetType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::OffsetType = typename TImage::OffsetType

Type of the Offset taken from the image

Definition at line 124 of file itkImageConstIteratorWithOnlyIndex.h.

◆ OffsetValueType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 125 of file itkImageConstIteratorWithOnlyIndex.h.

◆ RegionType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 118 of file itkImageConstIteratorWithOnlyIndex.h.

◆ Self

Standard class type aliases.

Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ SizeType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 114 of file itkImageConstIteratorWithOnlyIndex.h.

◆ SizeValueType

template<typename TImage >
using itk::ImageConstIteratorWithOnlyIndex< TImage >::SizeValueType = typename SizeType::SizeValueType

Definition at line 115 of file itkImageConstIteratorWithOnlyIndex.h.

◆ Superclass

Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

◆ ImageRandomConstIteratorWithOnlyIndex() [1/3]

template<typename TImage >
itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex ( )
default

Default constructor. Needed since we provide a cast constructor.

◆ ~ImageRandomConstIteratorWithOnlyIndex()

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

Default constructor. Needed since we provide a cast constructor.

◆ ImageRandomConstIteratorWithOnlyIndex() [2/3]

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.

◆ ImageRandomConstIteratorWithOnlyIndex() [3/3]

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 155 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Member Function Documentation

◆ GetNumberOfSamples()

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GetNumberOfSamples ( ) const
inline

Definition at line 222 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ GoToBegin()

template<typename TImage >
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GoToBegin ( )
inline

Move an iterator to the beginning of the region.

Definition at line 162 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ GoToEnd()

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

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

Definition at line 171 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ IsAtBegin()

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

Is the iterator at the beginning of the region?

Definition at line 180 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ IsAtEnd()

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

Is the iterator at the end of the region?

Definition at line 187 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ operator++()

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 195 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ operator--()

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 206 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ RandomJump()

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

Execute a random jump.

◆ ReinitializeSeed() [1/2]

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

Reinitialize the seed of the random number generator.

◆ ReinitializeSeed() [2/2]

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

◆ SetNumberOfSamples()

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

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

Definition at line 216 of file itkImageRandomConstIteratorWithOnlyIndex.h.

Member Data Documentation

◆ m_Generator

Definition at line 240 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ m_NumberOfPixelsInRegion

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

Definition at line 243 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ m_NumberOfSamplesDone

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesDone {}
private

Definition at line 242 of file itkImageRandomConstIteratorWithOnlyIndex.h.

◆ m_NumberOfSamplesRequested

template<typename TImage >
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::m_NumberOfSamplesRequested {}
private

Definition at line 241 of file itkImageRandomConstIteratorWithOnlyIndex.h.


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