ITK
6.0.0
Insight 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 indices 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 | |
using | ImageType = TImage |
using | IndexType = typename TImage::IndexType |
using | IndexValueType = typename IndexType::IndexValueType |
using | OffsetType = typename TImage::OffsetType |
using | OffsetValueType = typename OffsetType::OffsetValueType |
using | RegionType = typename TImage::RegionType |
using | Self = ImageRandomConstIteratorWithOnlyIndex |
using | SizeType = typename TImage::SizeType |
using | SizeValueType = typename SizeType::SizeValueType |
using | Superclass = ImageConstIteratorWithOnlyIndex< TImage > |
Public Types inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
using | ImageType = TImage |
using | IndexType = typename TImage::IndexType |
using | IndexValueType = typename IndexType::IndexValueType |
using | OffsetType = typename TImage::OffsetType |
using | OffsetValueType = typename OffsetType::OffsetValueType |
using | RegionType = typename TImage::RegionType |
using | Self = ImageConstIteratorWithOnlyIndex |
using | SizeType = typename TImage::SizeType |
using | SizeValueType = typename SizeType::SizeValueType |
Private Types | |
using | GeneratorPointer = typename Statistics::MersenneTwisterRandomVariateGenerator::Pointer |
Private Member Functions | |
void | RandomJump () |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
static constexpr unsigned int | GetImageDimension () |
Static Public Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
static constexpr unsigned int | ImageDimension = TImage::ImageDimension |
Protected Attributes inherited from itk::ImageConstIteratorWithOnlyIndex< TImage > | |
IndexType | m_BeginIndex { { 0 } } |
IndexType | m_EndIndex { { 0 } } |
TImage::ConstPointer | m_Image {} |
OffsetValueType | m_OffsetTable [ImageDimension+1] {} |
IndexType | m_PositionIndex { { 0 } } |
RegionType | m_Region {} |
bool | m_Remaining { false } |
|
private |
Definition at line 239 of file itkImageRandomConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::ImageType = TImage |
Image type alias support
Definition at line 121 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::IndexType = typename TImage::IndexType |
Index type alias support
Definition at line 110 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::IndexValueType = typename IndexType::IndexValueType |
Definition at line 111 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::OffsetType = typename TImage::OffsetType |
Type of the Offset taken from the image
Definition at line 124 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::OffsetValueType = typename OffsetType::OffsetValueType |
Definition at line 125 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::RegionType = typename TImage::RegionType |
Region type alias support
Definition at line 118 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Self = ImageRandomConstIteratorWithOnlyIndex |
Standard class type aliases.
Definition at line 127 of file itkImageRandomConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::SizeType = typename TImage::SizeType |
Size type alias support
Definition at line 114 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageConstIteratorWithOnlyIndex< TImage >::SizeValueType = typename SizeType::SizeValueType |
Definition at line 115 of file itkImageConstIteratorWithOnlyIndex.h.
using itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::Superclass = ImageConstIteratorWithOnlyIndex<TImage> |
Definition at line 128 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
default |
Default constructor. Needed since we provide a cast constructor.
|
overridedefault |
Default constructor. Needed since we provide a cast constructor.
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 155 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Definition at line 222 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Move an iterator to the beginning of the region.
Definition at line 162 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Move an iterator to one position past the End of the region.
Definition at line 171 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Is the iterator at the beginning of the region?
Definition at line 180 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Is the iterator at the end of the region?
Definition at line 187 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Increment (prefix) the selected dimension. No bounds checking is performed.
Definition at line 195 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
inline |
Decrement (prefix) the selected dimension. No bounds checking is performed.
Definition at line 206 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Execute a random jump.
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed | ( | ) |
Reinitialize the seed of the random number generator.
void itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ReinitializeSeed | ( | int | ) |
|
inline |
Set/Get number of random samples to extract from the image region.
Definition at line 216 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 240 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 243 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 242 of file itkImageRandomConstIteratorWithOnlyIndex.h.
|
private |
Definition at line 241 of file itkImageRandomConstIteratorWithOnlyIndex.h.