ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageRandomConstIteratorWithOnlyIndex.h>
A multi-dimensional image iterator that visits a random set of locations within an image region, providing index information.
ImageRandomConstIteratorWithOnlyIndex is a multi-dimensional iterator class that is templated over image type. ImageRandomConstIteratorWithOnlyIndex is constrained to walk only within the specified region. It samples random region positions at each increment or decrement.
No access to image data is possible, and thus the class can be used with images of type ImageBase.
ImageRandomConstIteratorWithOnlyIndex 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.
The operator++ method provides a simple syntax for walking around a region of a multidimensional image. operator++ performs a jump to a random position within the specified image region. This is designed to facilitate the extraction of random indecies from the image.
This is the typical use of this iterator in a loop:
or
Index-only iterators:
Pixel data-access iterators:
Definition at line 123 of file itkImageRandomConstIteratorWithOnlyIndex.h.
Public Types | |
typedef Superclass::ImageType | ImageType |
typedef Superclass::IndexType | IndexType |
typedef Superclass::IndexValueType | IndexValueType |
typedef Superclass::OffsetType | OffsetType |
typedef Superclass::OffsetValueType | OffsetValueType |
typedef Superclass::RegionType | RegionType |
typedef ImageRandomConstIteratorWithOnlyIndex | Self |
typedef Superclass::SizeType | SizeType |
typedef Superclass::SizeValueType | SizeValueType |
typedef ImageConstIteratorWithOnlyIndex < TImage > | Superclass |
Public Types inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
typedef TImage | ImageType |
typedef TImage::IndexType | IndexType |
typedef IndexType::IndexValueType | IndexValueType |
typedef TImage::OffsetType | OffsetType |
typedef OffsetType::OffsetValueType | OffsetValueType |
typedef TImage::RegionType | RegionType |
typedef ImageConstIteratorWithOnlyIndex | Self |
typedef TImage::SizeType | SizeType |
typedef SizeType::SizeValueType | SizeValueType |
Private Types | |
typedef Statistics::MersenneTwisterRandomVariateGenerator::Pointer | GeneratorPointer |
Private Member Functions | |
void | RandomJump () |
Private Attributes | |
GeneratorPointer | m_Generator |
SizeValueType | m_NumberOfPixelsInRegion |
SizeValueType | m_NumberOfSamplesDone |
SizeValueType | m_NumberOfSamplesRequested |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
static unsigned int | GetImageDimension () |
Static Public Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
static const unsigned int | ImageDimension = TImage::ImageDimension |
Protected Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
IndexType | m_BeginIndex |
IndexType | m_EndIndex |
TImage::ConstPointer | m_Image |
OffsetValueType | m_OffsetTable [ImageDimension+1] |
IndexType | m_PositionIndex |
RegionType | m_Region |
bool | m_Remaining |
|
private |
Definition at line 220 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::ImageType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageType |
Definition at line 135 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::IndexType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::IndexType |
Inherit types from the superclass
Definition at line 131 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::IndexValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::IndexValueType |
Definition at line 136 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::OffsetType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::OffsetType |
Definition at line 133 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::OffsetValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::OffsetValueType |
Definition at line 137 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::RegionType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::RegionType |
Definition at line 134 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef ImageRandomConstIteratorWithOnlyIndex itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Self |
Standard class typedefs.
Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::SizeType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::SizeType |
Definition at line 132 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef Superclass::SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::SizeValueType |
Definition at line 138 of file itkImageRandomConstIteratorWithOnlyIndex.h.
typedef ImageConstIteratorWithOnlyIndex< TImage > itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Superclass |
Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.
itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex | ( | ) |
Default constructor. Needed since we provide a cast constructor.
|
inline |
Definition at line 142 of file itkImageRandomConstIteratorWithOnlyIndex.h.
itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex | ( | const ImageType * | ptr, |
const RegionType & | region | ||
) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
|
inline |
Constructor that can be used to cast from an ImageIterator to an ImageRandomConstIteratorWithOnlyIndex. Many routines return an ImageIterator, but for a particular task, you may want an ImageRandomConstIteratorWithOnlyIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRandomConstIteratorWithOnlyIndex.
Definition at line 154 of file itkImageRandomConstIteratorWithOnlyIndex.h.
References itk::ImageConstIteratorWithOnlyIndex< TImage >::operator=().
SizeValueType itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::GetNumberOfSamples | ( | void | ) | const |
|
inline |
Move an iterator to the beginning of the region.
Definition at line 160 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Move an iterator to one position past the End of the region.
Definition at line 168 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Is the iterator at the beginning of the region?
Definition at line 176 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Is the iterator at the end of the region?
Definition at line 182 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Increment (prefix) the selected dimension. No bounds checking is performed.
Definition at line 189 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Decrement (prefix) the selected dimension. No bounds checking is performed.
Definition at line 199 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed | ( | ) |
Reinitialize the seed of the random number generator
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed | ( | int | ) |
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::SetNumberOfSamples | ( | SizeValueType | number | ) |
Set/Get number of random samples to get from the image region
|
private |
Definition at line 221 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 224 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 223 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 222 of file itkImageRandomConstIteratorWithOnlyIndex.h.