ITK  5.3.0
Insight Toolkit
Public Types | 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 >:

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 = ImageRandomNonRepeatingConstIteratorWithIndex
 
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
 
using PriorityImageType = itk::Image< SizeValueType, Self::ImageDimension >
 
static constexpr unsigned int ImageDimension = TImage::ImageDimension
 
SizeValueType m_NumberOfSamplesRequested
 
SizeValueType m_NumberOfSamplesDone
 
SizeValueType m_NumberOfPixelsInRegion
 
RandomPermutationm_Permutation
 
 ImageRandomNonRepeatingConstIteratorWithIndex ()
 
 ~ImageRandomNonRepeatingConstIteratorWithIndex () override
 
 ImageRandomNonRepeatingConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 
 ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const Self &it)
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 
void SetPriorityImage (const PriorityImageType *priorityImage)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
void SetNumberOfSamples (SizeValueType number)
 
SizeValueType GetNumberOfSamples () const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int)
 
void UpdatePosition ()
 

Additional Inherited Members

- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
 ImageConstIteratorWithIndex ()
 
 ImageConstIteratorWithIndex (const Self &it)
 
 ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
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
 
virtual ~ImageConstIteratorWithIndex ()=default
 
void SetIndex (const IndexType &ind)
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
bool IsAtReverseEnd () const
 
bool IsAtEnd () const
 
bool Remaining ()
 
- 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 >
TImage::ConstWeakPointer m_Image
 
IndexType m_PositionIndex
 
IndexType m_BeginIndex
 
IndexType m_EndIndex
 
RegionType m_Region
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
const InternalPixelTypem_Position
 
const InternalPixelTypem_Begin
 
const InternalPixelTypem_End
 
bool m_Remaining
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

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 iterator 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
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Common/RandomSelectPixelFromRegionWithoutReplacee/Code.cxx.

Definition at line 214 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

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

◆ ImageType

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

◆ IndexType

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

Inherit types from the superclass

Definition at line 222 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ IndexValueType

◆ InternalPixelType

◆ OffsetType

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

◆ OffsetValueType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

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

◆ PriorityImageType

Image with priorities

Definition at line 298 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ RegionType

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

◆ Self

Standard class type aliases.

Definition at line 218 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ SizeType

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

◆ SizeValueType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [1/3]

Default constructor. Needed since we provide a cast constructor.

◆ ~ImageRandomNonRepeatingConstIteratorWithIndex()

Image with priorities

Definition at line 238 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [2/3]

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.

◆ ImageRandomNonRepeatingConstIteratorWithIndex() [3/3]

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

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

Member Function Documentation

◆ GetNumberOfSamples()

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

Image with priorities

◆ GoToBegin()

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

Move an iterator to the beginning of the region.

Definition at line 264 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ GoToEnd()

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

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

Definition at line 273 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ IsAtBegin()

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

Is the iterator at the beginning of the region?

Definition at line 282 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ IsAtEnd()

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

Is the iterator at the end of the region?

Definition at line 289 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ operator++()

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

◆ operator--()

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

◆ operator=()

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

operator= is provided to deep copy m_Permutation.

◆ ReinitializeSeed() [1/2]

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

Reinitialize the seed of the random number generator

◆ ReinitializeSeed() [2/2]

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

Reinitialize the seed of the random number generator with a specific value

◆ SetNumberOfSamples()

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

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

Examples
SphinxExamples/src/Core/Common/RandomSelectPixelFromRegionWithoutReplacee/Code.cxx.

◆ SetPriorityImage()

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.

◆ UpdatePosition()

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

Image with priorities

Member Data Documentation

◆ ImageDimension

template<typename TImage>
constexpr unsigned int itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension
staticconstexpr

The moving image dimension.

Definition at line 295 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ m_NumberOfPixelsInRegion

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

Image with priorities

Definition at line 352 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ m_NumberOfSamplesDone

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

Image with priorities

Definition at line 351 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ m_NumberOfSamplesRequested

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

Image with priorities

Definition at line 350 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

◆ m_Permutation

template<typename TImage>
RandomPermutation* itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::m_Permutation
private

Image with priorities

Definition at line 353 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.


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