ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::ImageRandomNonRepeatingIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRandomNonRepeatingIteratorWithIndex.h>

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

Public Types

using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageRandomNonRepeatingIteratorWithIndex
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRandomNonRepeatingConstIteratorWithIndex< TImage >
 
- Public Types inherited from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >
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 >
 
using PriorityImageType = itk::Image< SizeValueType, Self::ImageDimension >
 
- 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

 ImageRandomNonRepeatingIteratorWithIndex ()=default
 
 ImageRandomNonRepeatingIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
 ImageRandomNonRepeatingIteratorWithIndex (ImageType *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >
 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)
 
- 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 ()
 

Protected Member Functions

 ImageRandomNonRepeatingIteratorWithIndex (const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > &it)
 

Additional Inherited Members

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

A multi-dimensional image iterator that visits image pixels within a region in a random order, without repeating.

This class was contributed by Rupert Brooks, McGill Centre for Intelligent Machines, Montreal, Canada. It is heavily based on the ImageRandomIterator class.

This iterator is a subclass of itk::ImageRandomNonRepeatingConstIteratorWithIndex that adds write-access functionality. Please see itk::ImageRandomNonRepeatingConstIteratorWithIndex for more information.

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
ImageRandomNonRepeatingConstIteratorWithIndex
ImageRandomNonRepeatingIteratorWithIndex
ImageRandomConstIteratorWithIndex
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/AddNoiseToBinaryImage/Code.cxx.

Definition at line 78 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

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

◆ ImageType

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

◆ IndexType

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

Types inherited from the Superclass

Definition at line 87 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

◆ InternalPixelType

◆ OffsetType

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

◆ PixelContainer

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

◆ PixelContainerPointer

◆ PixelType

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

◆ RegionType

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

◆ Self

Standard class type aliases.

Definition at line 83 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

◆ SizeType

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

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRandomNonRepeatingIteratorWithIndex() [1/4]

Default constructor. Needed since we provide a cast constructor.

◆ ImageRandomNonRepeatingIteratorWithIndex() [2/4]

template<typename TImage >
itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( ImageType ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

◆ ImageRandomNonRepeatingIteratorWithIndex() [3/4]

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

◆ ImageRandomNonRepeatingIteratorWithIndex() [4/4]

The construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

◆ operator=()

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

The construction from a const iterator is declared protected in order to enforce const correctness.

◆ Set()

template<typename TImage >
void itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Set ( const PixelType value) const
inline

Set the pixel value

Definition at line 115 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

◆ Value()

template<typename TImage >
PixelType& itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Value ( )
inline

Return a reference to the pixel. This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 124 of file itkImageRandomNonRepeatingIteratorWithIndex.h.


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