itk::ImageRandomIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRandomIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomIteratorWithIndex< TImage >:

Detailed Description

template<typename TImage>
class itk::ImageRandomIteratorWithIndex< TImage >

A multi-dimensional image iterator that visits a random set of pixels within an image region.

This class is a subclass of itkImageRandomConstIteratorWithIndex that adds write-access functionality. Please see itkImageRandomConstIteratorWithIndex 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.

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

Examples:

WikiExamples/Statistics/ImageToHistogramFilterGrayscale.cxx, WikiExamples/Statistics/ImageToHistogramFilterRGB.cxx, and WikiExamples/Statistics/ImageToHistogramFilterVectorImage.cxx.

Definition at line 67 of file itkImageRandomIteratorWithIndex.h.

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 = ImageRandomIteratorWithIndex
using	SizeType = typename Superclass::SizeType
using	Superclass = ImageRandomConstIteratorWithIndex< TImage >
Public Types inherited from itk::ImageRandomConstIteratorWithIndex< 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 = 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
	ImageRandomIteratorWithIndex ()=default
	ImageRandomIteratorWithIndex (ImageType *ptr, const RegionType &region)
	ImageRandomIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
void	Set (const PixelType &value) const
PixelType &	Value ()
Public Member Functions inherited from itk::ImageRandomConstIteratorWithIndex< TImage >
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 ()
Self &	operator++ ()
Self &	operator-- ()
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get () const
const IndexType &	GetIndex () const
const RegionType &	GetRegion () 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
Self &	operator= (const Self &it)
bool	operator== (const Self &it) const
bool	operator> (const Self &it) const
bool	operator>= (const Self &it) const
bool	Remaining ()
const PixelType &	Value () const
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)

Protected Member Functions
	ImageRandomIteratorWithIndex (const ImageRandomConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageRandomConstIteratorWithIndex< TImage > &it)

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 InternalPixelType *	m_Begin
IndexType	m_BeginIndex
const InternalPixelType *	m_End
IndexType	m_EndIndex
TImage::ConstWeakPointer	m_Image
OffsetValueType	m_OffsetTable [ImageDimension+1]
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor
const InternalPixelType *	m_Position
IndexType	m_PositionIndex
RegionType	m_Region
bool	m_Remaining

Member Typedef Documentation

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 84 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 79 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Types inherited from the Superclass

Definition at line 75 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 82 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 77 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 80 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 81 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 83 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 78 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::Self = ImageRandomIteratorWithIndex

Standard class type aliases.

Definition at line 71 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 76 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

using itk::ImageRandomIteratorWithIndex< TImage >::Superclass = ImageRandomConstIteratorWithIndex< TImage >

Definition at line 72 of file itkImageRandomIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageRandomIteratorWithIndex< TImage >::ImageRandomIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >

itk::ImageRandomIteratorWithIndex< TImage >::ImageRandomIteratorWithIndex	(	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::ImageRandomIteratorWithIndex< TImage >::ImageRandomIteratorWithIndex

(

const ImageIteratorWithIndex< TImage > &

it

)

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

template<typename TImage >

itk::ImageRandomIteratorWithIndex< TImage >::ImageRandomIteratorWithIndex ( const ImageRandomConstIteratorWithIndex< TImage > &  it )

protected

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

Member Function Documentation

template<typename TImage >

Self& itk::ImageRandomIteratorWithIndex< TImage >::operator= ( const ImageRandomConstIteratorWithIndex< TImage > &  it )

protected

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

template<typename TImage >

void itk::ImageRandomIteratorWithIndex< TImage >::Set ( const PixelType &  value ) const

inline

Set the pixel value

Definition at line 102 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage >

PixelType& itk::ImageRandomIteratorWithIndex< 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 108 of file itkImageRandomIteratorWithIndex.h.

---

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

• itkImageRandomIteratorWithIndex.h