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

#include <itkImageRandomNonRepeatingIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >:

List of all members.

Public Types
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef itk::Image< unsigned long, itkGetStaticConstMacro(ImageDimension) >	PriorityImageType
typedef Superclass::RegionType	RegionType
typedef ImageRandomNonRepeatingIteratorWithIndex	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef ImageRandomNonRepeatingConstIteratorWithIndex < TImage >	Superclass

Public Member Functions
	ImageRandomNonRepeatingIteratorWithIndex ()
	ImageRandomNonRepeatingIteratorWithIndex (ImageType *ptr, const RegionType &region)
	ImageRandomNonRepeatingIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
Self	Begin (void) const
Self	End (void) const
PixelType	Get (void) const
const IndexType &	GetIndex () const
unsigned long	GetNumberOfSamples (void) const
const RegionType &	GetRegion () const
void	GoToBegin (void)
void	GoToEnd (void)
void	GoToReverseBegin (void)
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
bool	IsAtReverseEnd (void) const
bool	operator!= (const Self &it) const
Self &	operator++ ()
Self &	operator-- ()
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
void	ReinitializeSeed ()
void	ReinitializeSeed (int)
bool	Remaining ()
void	Set (const PixelType &value) const
void	SetIndex (const IndexType &ind)
void	SetNumberOfSamples (unsigned long number)
void	SetPriorityImage (const PriorityImageType *priorityImage)
PixelType &	Value (void)
const PixelType &	Value (void) const

Static Public Member Functions
static unsigned int	GetImageDimension ()

Static Public Attributes
static const unsigned int	ImageDimension = ::itk::GetImageDimension< TImage >::ImageDimension

Protected Member Functions
	ImageRandomNonRepeatingIteratorWithIndex (const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > &it)

Protected Attributes
const InternalPixelType *	m_Begin
IndexType	m_BeginIndex
const InternalPixelType *	m_End
IndexType	m_EndIndex
TImage::ConstWeakPointer	m_Image
unsigned long	m_OffsetTable [ImageDimension+1]
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor
const InternalPixelType *	m_Position
IndexType	m_PositionIndex
RegionType	m_Region
bool	m_Remaining

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 http://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

Definition at line 75 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

Member Typedef Documentation

template<typename TImage>

typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType

inherited

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::AccessorType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 95 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::ImageType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageType

Image typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index.

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 90 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::IndexType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::IndexType

Types inherited from the Superclass

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 83 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::IndexValueType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::IndexValueType

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 84 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::InternalPixelType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 93 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::OffsetType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 87 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::OffsetValueType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::OffsetValueType

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 88 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::PixelContainer

PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 91 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::PixelContainerPointer itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::PixelContainerPointer

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 92 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::PixelType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::PixelType

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 94 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage>

typedef itk::Image< unsigned long, itkGetStaticConstMacro(ImageDimension ) > itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PriorityImageType

inherited

Image with priorities

Definition at line 296 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::RegionType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::RegionType

Region typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Region back to itk::ImageRegion so that is it not confused with ImageIterator::Index.

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 89 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef ImageRandomNonRepeatingIteratorWithIndex itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 79 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::SizeType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::SizeType

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 85 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef Superclass::SizeValueType itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::SizeValueType

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 86 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage >

typedef ImageRandomNonRepeatingConstIteratorWithIndex<TImage> itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Superclass

Reimplemented from itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 80 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( )

Default constructor. Needed since we provide a cast constructor.

Definition at line 27 of file itkImageRandomNonRepeatingIteratorWithIndex.txx.

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.

Definition at line 35 of file itkImageRandomNonRepeatingIteratorWithIndex.txx.

template<typename TImage >

itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( const ImageIteratorWithIndex< TImage > & it )

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.

Definition at line 42 of file itkImageRandomNonRepeatingIteratorWithIndex.txx.

template<typename TImage >

itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::ImageRandomNonRepeatingIteratorWithIndex ( const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > & it )

protected

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

Definition at line 49 of file itkImageRandomNonRepeatingIteratorWithIndex.txx.

Member Function Documentation

template<class TImage >

ImageConstIteratorWithIndex< TImage > itk::ImageConstIteratorWithIndex< TImage >::Begin ( void ) const

inherited

Move an iterator to the beginning of the region.

Deprecated:: Use GoToBegin() instead

Definition at line 163 of file itkImageConstIteratorWithIndex.txx.

References itk::ImageConstIteratorWithIndex< TImage >::GoToBegin().

Referenced by otb::VectorImageToImageListFilter< TVectorImageType, TImageList >::GenerateData(), itk::ImageToParametricSpaceFilter< TInputImage, TOutputMesh >::GenerateData(), itk::HoughTransform2DCirclesImageFilter< TInputPixelType, TOutputPixelType >::GenerateData(), otb::HoughTransform2DLinesImageFilter< TInputPixelType, TOutputPixelType >::GenerateData(), and itk::HoughTransform2DLinesImageFilter< TInputPixelType, TOutputPixelType >::GenerateData().

template<class TImage >

ImageConstIteratorWithIndex< TImage > itk::ImageConstIteratorWithIndex< TImage >::End ( void ) const

inherited

Move an iterator to the End of the region.

Deprecated:: Use GoToReverseBegin() instead

Definition at line 202 of file itkImageConstIteratorWithIndex.txx.

References itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin().

template<typename TImage>

PixelType itk::ImageConstIteratorWithIndex< TImage >::Get ( void ) const

inlineinherited

Get the pixel value

Definition at line 236 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

static unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension ( )

inlinestaticinherited

Get the dimension (size) of the index.

Definition at line 156 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ThreadedGenerateData().

template<typename TImage>

const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex ( void ) const

inlineinherited

Get the index. This provides a read only reference to the index.

See also:: SetIndex

Definition at line 219 of file itkImageConstIteratorWithIndex.h.

template<class TImage >

unsigned long itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GetNumberOfSamples ( void ) const

inherited

Set the number of samples to extract from the region

Definition at line 64 of file itkImageRandomNonRepeatingConstIteratorWithIndex.txx.

template<typename TImage>

const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion ( void ) const

inlineinherited

Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 224 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToBegin ( void )

inlineinherited

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 265 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToEnd ( void )

inlineinherited

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

Definition at line 272 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<class TImage >

void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin ( void )

inherited

Move an iterator to the End of the region.

Definition at line 216 of file itkImageConstIteratorWithIndex.txx.

Referenced by itk::ImageConstIteratorWithIndex< TImage >::End().

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtBegin ( void ) const

inlineinherited

Is the iterator at the beginning of the region?

Definition at line 279 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd ( void ) const

inlineinherited

Is the iterator at the end of the region?

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 285 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd ( void ) const

inlineinherited

Is the iterator at the beginning of the region?

Definition at line 260 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator!= ( const Self & it ) const

inlineinherited

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 162 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

Self& itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator++ ( )

inlineinherited

Increment (prefix) the selected dimension. No bounds checking is performed.

See also:: GetIndex; operator–

Definition at line 307 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

Self& itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::operator-- ( )

inlineinherited

Decrement (prefix) the selected dimension. No bounds checking is performed.

See also:: GetIndex; operator++

Definition at line 316 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator< ( const Self & it ) const

inlineinherited

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 190 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator<= ( const Self & it ) const

inlineinherited

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 180 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >

ImageRandomNonRepeatingIteratorWithIndex< TImage > & itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::operator= ( const ImageRandomNonRepeatingConstIteratorWithIndex< TImage > & it )

protected

Definition at line 58 of file itkImageRandomNonRepeatingIteratorWithIndex.txx.

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

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator== ( const Self & it ) const

inlineinherited

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 171 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator> ( const Self & it ) const

inlineinherited

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 210 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator>= ( const Self & it ) const

inlineinherited

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 200 of file itkImageConstIteratorWithIndex.h.

template<class TImage >

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

inherited

Reinitialize the seed of the random number generator

Definition at line 73 of file itkImageRandomNonRepeatingConstIteratorWithIndex.txx.

template<class TImage >

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed ( int seed )

inherited

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

Definition at line 82 of file itkImageRandomNonRepeatingConstIteratorWithIndex.txx.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::Remaining ( )

inlineinherited

Are there data remainning in the region ?

Definition at line 272 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >

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

inline

Set the pixel value

Definition at line 114 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::SetIndex ( const IndexType & ind )

inlineinherited

Set the index. No bounds checking is performed.

See also:: GetIndex

Definition at line 229 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::InterpolateImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), otb::ContinuousMinimumMaximumImageCalculator< TInputImage >::Compute(), otb::ContinuousMinimumMaximumImageCalculator< TInputImage >::ComputeMaximum(), and otb::ContinuousMinimumMaximumImageCalculator< TInputImage >::ComputeMinimum().

template<class TImage >

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetNumberOfSamples ( unsigned long number )

inherited

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

Set the number of samples to extract from the region

Definition at line 54 of file itkImageRandomNonRepeatingConstIteratorWithIndex.txx.

template<class TImage >

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetPriorityImage ( const PriorityImageType * priorityImage )

inherited

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.

update the position

Definition at line 92 of file itkImageRandomNonRepeatingConstIteratorWithIndex.txx.

References itk::Image< TPixel, VImageDimension >::GetPixel().

template<typename TImage >

PixelType& itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >::Value ( void )

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 120 of file itkImageRandomNonRepeatingIteratorWithIndex.h.

template<typename TImage>

const PixelType& itk::ImageConstIteratorWithIndex< TImage >::Value ( void ) const

inlineinherited

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