itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]

#include <itkImageRandomNonRepeatingConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

[legend]Collaboration diagram for itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >:

[legend]List of all members.

---

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 interator 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 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

ImageLinearConstIteratorWithIndex

ImageLinearIteratorWithIndex

ImageRandomNonRepeatingConstIteratorWithIndex

ImageRandomIteratorWithIndex

ImageRegionConstIterator

ImageRegionConstIteratorWithIndex

ImageRegionExclusionConstIteratorWithIndex

ImageRegionExclusionIteratorWithIndex

ImageRegionIterator

ImageRegionIteratorWithIndex

ImageRegionReverseConstIterator

ImageRegionReverseIterator

ImageReverseConstIterator

ImageReverseIterator

ImageSliceConstIteratorWithIndex

ImageSliceIteratorWithIndex

NeighborhoodIterator

PathConstIterator

PathIterator

ShapedNeighborhoodIterator

SliceIterator

ImageConstIteratorWithIndex

Definition at line 196 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

Public Types
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef itk::Image< unsigned long, itkGetStaticConstMacro(ImageDimension) >	PriorityImageType
typedef TImage::RegionType	RegionType
typedef ImageRandomNonRepeatingConstIteratorWithIndex	Self
typedef TImage::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef ImageConstIteratorWithIndex< TImage >	Superclass
Public Member Functions
Self	Begin (void) const
Self	End (void) const
PixelType	Get (void) const
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
void	GoToReverseBegin (void)
	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
	ImageRandomNonRepeatingConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
bool	IsAtReverseEnd (void) const
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int,::itk::GetImageDimension< TImage >::ImageDimension)
void	ReinitializeSeed (int)
void	ReinitializeSeed ()
bool	Remaining ()
void	SetPriorityImage (const PriorityImageType *priorityImage)
const PixelType &	Value (void) const
unsigned long	GetNumberOfSamples (void) const
void	SetNumberOfSamples (unsigned long number)
void	GoToBegin (void)
void	GoToEnd (void)
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	SetIndex (const IndexType &ind)
Static Public Member Functions
static unsigned int	GetImageDimension ()
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

---

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 TImage::AccessorType itk::ImageConstIteratorWithIndex< TImage >::AccessorType [inherited]

Accessor type that convert data between internal and external representations.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 131 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage itk::ImageRandomNonRepeatingConstIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 219 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::IndexType itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IndexType

Index 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::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 207 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef IndexType::IndexValueType itk::ImageConstIteratorWithIndex< TImage >::IndexValueType [inherited]

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::InternalPixelType itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType [inherited]

Internal Pixel Type

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 124 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::OffsetType itk::ImageConstIteratorWithIndex< TImage >::OffsetType [inherited]

Type of the Offset taken from the image

Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 135 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef OffsetType::OffsetValueType itk::ImageConstIteratorWithIndex< TImage >::OffsetValueType [inherited]

Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::PixelContainer itk::ImageRandomNonRepeatingConstIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 224 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef PixelContainer::Pointer itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::PixelContainerPointer

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 225 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::PixelType itk::ImageConstIteratorWithIndex< TImage >::PixelType [inherited]

External Pixel Type

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 127 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Image with priorities

Definition at line 285 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::RegionType itk::ImageRandomNonRepeatingConstIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 213 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef ImageRandomNonRepeatingConstIteratorWithIndex itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 200 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::SizeType itk::ImageConstIteratorWithIndex< TImage >::SizeType [inherited]

Size typedef support.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionConstIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 108 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef SizeType::SizeValueType itk::ImageConstIteratorWithIndex< TImage >::SizeValueType [inherited]

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Reimplemented in itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >.

Definition at line 201 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

---

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::~ImageRandomNonRepeatingConstIteratorWithIndex

(

)

[inline]

Default constructor. Needed since we provide a cast constructor.

Definition at line 229 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

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.

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex

(

const ImageConstIteratorWithIndex< TImage > &

it

)

[inline]

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

References NULL.

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::~ImageRandomNonRepeatingConstIteratorWithIndex

(

)

[inline]

Default constructor. Needed since we provide a cast constructor.

Definition at line 229 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

---

Member Function Documentation

template<typename TImage>

Self itk::ImageConstIteratorWithIndex< TImage >::Begin

(

void

)

const [inherited]

Move an iterator to the beginning of the region.

Deprecated:

Use GoToBegin() instead

template<typename TImage>

Self itk::ImageConstIteratorWithIndex< TImage >::End

(

void

)

const [inherited]

Move an iterator to the End of the region.

Deprecated:

Use GoToReverseBegin() instead

template<typename TImage>

PixelType itk::ImageConstIteratorWithIndex< TImage >::Get

(

void

)

const [inline, inherited]

Get the pixel value

Definition at line 241 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

(

)

[inline, static, inherited]

Get the dimension (size) of the index.

Definition at line 156 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex

(

void

)

const [inline, inherited]

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

See also:

SetIndex

Definition at line 225 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

unsigned long itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GetNumberOfSamples

(

void

)

const

template<typename TImage>

const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion

(

)

const [inline, inherited]

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 230 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToBegin

(

void

)

[inline]

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 249 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::GoToEnd

(

void

)

[inline]

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

Definition at line 257 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin

(

void

)

[inherited]

Move an iterator to the End of the region.

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtBegin

(

void

)

const [inline]

Is the iterator at the beginning of the region?

Definition at line 265 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::IsAtEnd

(

void

)

const [inline]

Is the iterator at the end of the region?

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 271 of file itkImageRandomNonRepeatingConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd

(

void

)

const [inline, inherited]

Is the iterator at the beginning of the region?

Definition at line 265 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

itk::ImageConstIteratorWithIndex< TImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TImage::ImageDimension
	)			[inherited]

Dimension of the image the iterator walks. This constant is needed so functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

template<typename TImage>

itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		::itk::GetImageDimension< TImage >::ImageDimension
	)

The moving image dimension.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator!=

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 162 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

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

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

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator<

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 193 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator<=

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 182 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator==

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 172 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator>

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 215 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::operator>=

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 204 of file itkImageConstIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed

(

int

)

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

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ReinitializeSeed

(

)

Reinitialize the seed of the random number generator

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::Remaining

(

)

[inline, inherited]

Are there data remainning in the region ?

Definition at line 277 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::SetIndex

(

const IndexType &

ind

)

[inline, inherited]

Set the index. No bounds checking is performed.

See also:

GetIndex

Definition at line 235 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::SetNumberOfSamples

(

unsigned long

number

)

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

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.

template<typename TImage>

const PixelType& itk::ImageConstIteratorWithIndex< TImage >::Value

(

void

)

const [inline, inherited]

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

Definition at line 247 of file itkImageConstIteratorWithIndex.h.

---

Member Data Documentation

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin [protected, inherited]

Definition at line 296 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex [protected, inherited]

Definition at line 286 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End [protected, inherited]

Definition at line 297 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_EndIndex [protected, inherited]

Definition at line 287 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

TImage::ConstWeakPointer itk::ImageConstIteratorWithIndex< TImage >::m_Image [protected, inherited]

Definition at line 283 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

unsigned long itk::ImageConstIteratorWithIndex< TImage >::m_OffsetTable[ImageDimension+1] [protected, inherited]

Definition at line 293 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

AccessorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor [protected, inherited]

Definition at line 301 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessorFunctor [protected, inherited]

Definition at line 302 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Position [protected, inherited]

Definition at line 295 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::ImageConstIteratorWithIndex< TImage >::operator!=(), itk::ImageConstIteratorWithIndex< TImage >::operator<(), itk::ImageConstIteratorWithIndex< TImage >::operator<=(), itk::ImageConstIteratorWithIndex< TImage >::operator==(), itk::ImageConstIteratorWithIndex< TImage >::operator>(), and itk::ImageConstIteratorWithIndex< TImage >::operator>=().

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_PositionIndex [protected, inherited]

Definition at line 285 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

RegionType itk::ImageConstIteratorWithIndex< TImage >::m_Region [protected, inherited]

Definition at line 291 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::m_Remaining [protected, inherited]

Definition at line 299 of file itkImageConstIteratorWithIndex.h.

---

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

• itkImageRandomNonRepeatingConstIteratorWithIndex.h

---