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

#include <itkImageRandomIteratorWithIndex.h>

Inheritance diagram for itk::ImageRandomIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRandomIteratorWithIndex< TImage >:

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 Superclass::RegionType	RegionType
typedef ImageRandomIteratorWithIndex	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef ImageRandomConstIteratorWithIndex < TImage >	Superclass

Public Member Functions
	ImageRandomIteratorWithIndex ()
	ImageRandomIteratorWithIndex (ImageType *ptr, const RegionType &region)
	ImageRandomIteratorWithIndex (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)
PixelType &	Value (void)
const PixelType &	Value (void) const

Static Public Member Functions
static unsigned int	GetImageDimension ()

Static Public Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension

Protected Member Functions
	ImageRandomIteratorWithIndex (const ImageRandomConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageRandomConstIteratorWithIndex< 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::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 http://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

Definition at line 64 of file itkImageRandomIteratorWithIndex.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::ImageRandomIteratorWithIndex< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 84 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::ImageType itk::ImageRandomIteratorWithIndex< 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::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 79 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Types inherited from the Superclass

Reimplemented from itk::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 72 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 73 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 82 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 76 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 77 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageRandomIteratorWithIndex< 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::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 80 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Reimplemented from itk::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 81 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 83 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::RegionType itk::ImageRandomIteratorWithIndex< 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::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 78 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

typedef ImageRandomIteratorWithIndex itk::ImageRandomIteratorWithIndex< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 68 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 74 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 75 of file itkImageRandomIteratorWithIndex.h.

template<typename TImage>

typedef ImageRandomConstIteratorWithIndex<TImage> itk::ImageRandomIteratorWithIndex< TImage >::Superclass

Reimplemented from itk::ImageRandomConstIteratorWithIndex< TImage >.

Definition at line 69 of file itkImageRandomIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage >

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

Default constructor. Needed since we provide a cast constructor.

Definition at line 28 of file itkImageRandomIteratorWithIndex.txx.

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.

Definition at line 38 of file itkImageRandomIteratorWithIndex.txx.

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.

Definition at line 48 of file itkImageRandomIteratorWithIndex.txx.

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.

Definition at line 56 of file itkImageRandomIteratorWithIndex.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::ImageRandomConstIteratorWithIndex< TImage >::GetNumberOfSamples ( void ) const

inherited

Set the number of samples to extract from the region

Definition at line 63 of file itkImageRandomConstIteratorWithIndex.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::ImageRandomConstIteratorWithIndex< TImage >::GoToBegin ( void )

inlineinherited

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 162 of file itkImageRandomConstIteratorWithIndex.h.

Referenced by itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate().

template<typename TImage>

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

inlineinherited

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

Definition at line 169 of file itkImageRandomConstIteratorWithIndex.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::ImageRandomConstIteratorWithIndex< TImage >::IsAtBegin ( void ) const

inlineinherited

Is the iterator at the beginning of the region?

Definition at line 176 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

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

inlineinherited

Is the iterator at the end of the region?

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 180 of file itkImageRandomConstIteratorWithIndex.h.

Referenced by itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate().

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::ImageRandomConstIteratorWithIndex< TImage >::operator++ ( )

inlineinherited

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

See also:: GetIndex; operator–

Definition at line 185 of file itkImageRandomConstIteratorWithIndex.h.

template<typename TImage>

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

inlineinherited

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

See also:: GetIndex; operator++

Definition at line 194 of file itkImageRandomConstIteratorWithIndex.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 >

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

protected

Definition at line 65 of file itkImageRandomIteratorWithIndex.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::ImageRandomConstIteratorWithIndex< TImage >::ReinitializeSeed ( )

inherited

Reinitialize the seed of the random number generator

Definition at line 72 of file itkImageRandomConstIteratorWithIndex.txx.

Referenced by itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate().

template<class TImage >

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

inherited

Definition at line 80 of file itkImageRandomConstIteratorWithIndex.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::ImageRandomIteratorWithIndex< TImage >::Set ( const PixelType & value ) const

inline

Set the pixel value

Definition at line 103 of file itkImageRandomIteratorWithIndex.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::ImageRandomConstIteratorWithIndex< 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 itkImageRandomConstIteratorWithIndex.txx.

Referenced by itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate().

template<typename TImage>

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

Definition at line 242 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::ImageMomentsCalculator< TImage >::Compute().

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension

staticinherited

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.

Reimplemented in itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 101 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin

protectedinherited

Definition at line 291 of file itkImageConstIteratorWithIndex.h.

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

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex

protectedinherited

Definition at line 281 of file itkImageConstIteratorWithIndex.h.

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