ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageRegionIterator.h>
A multi-dimensional iterator templated over image type that walks a region of pixels.
The itk::ImageRegionIterator is optimized for iteration speed and is the first choice for iterative, pixel-wise operations on an image. ImageRegionIterator is the least specialized of the ITK image iterator classes. ImageRegionIterator is templated over the image type, and is constrained to walk only within the specified region and along a line parallel to one of the coordinate axes, "wrapping" to the next line as it reaches the boundary of the image. To walk the entire image, specify the region to be image->GetRequestedRegion()
.
Most of the functionality is inherited from the ImageRegionConstIterator. The current class only adds write access to image pixels.
example ImageRegionIterator.cxx
Definition at line 78 of file itkImageRegionIterator.h.
Public Member Functions | |
ImageRegionIterator () | |
ImageRegionIterator (ImageType *ptr, const RegionType ®ion) | |
ImageRegionIterator (const ImageIterator< TImage > &it) | |
itkLegacyMacro (Self Begin(void) const) | |
itkLegacyMacro (Self End(void) const) | |
void | Set (const PixelType &value) const |
PixelType & | Value (void) |
Public Member Functions inherited from itk::ImageRegionConstIterator< TImage > | |
virtual const char * | GetNameOfClass () const |
void | GoToBegin () |
void | GoToEnd () |
ImageRegionConstIterator () | |
ImageRegionConstIterator (const ImageIterator< TImage > &it) | |
ImageRegionConstIterator (const ImageConstIterator< TImage > &it) | |
itkLegacyMacro (Self Begin(void) const) | |
itkLegacyMacro (Self End(void) const) | |
ImageRegionConstIterator (const ImageType *ptr, const RegionType ®ion) | |
void | SetIndex (const IndexType &ind) |
Self & | operator++ () |
Self & | operator-- () |
Public Member Functions inherited from itk::ImageConstIterator< TImage > | |
ImageConstIterator (const Self &it) | |
virtual | ~ImageConstIterator () |
ImageConstIterator () | |
ImageConstIterator (const ImageType *ptr, const RegionType ®ion) | |
Self & | operator= (const Self &it) |
virtual void | SetRegion (const RegionType ®ion) |
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 |
bool | operator> (const Self &it) const |
const IndexType | GetIndex () const |
const RegionType & | GetRegion () const |
const ImageType * | GetImage () const |
PixelType | Get (void) const |
const PixelType & | Value (void) const |
itkLegacyMacro (Self Begin(void) const) | |
void | GoToBegin () |
itkLegacyMacro (Self End(void) const) | |
void | GoToEnd () |
bool | IsAtBegin (void) const |
bool | IsAtEnd (void) const |
Protected Member Functions | |
ImageRegionIterator (const ImageRegionConstIterator< TImage > &it) | |
Self & | operator= (const ImageRegionConstIterator< TImage > &it) |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::ImageConstIterator< TImage > | |
static unsigned int | GetImageIteratorDimension () |
Static Public Attributes inherited from itk::ImageRegionConstIterator< TImage > | |
static const unsigned int | ImageIteratorDimension = Superclass::ImageIteratorDimension |
Protected Attributes inherited from itk::ImageRegionConstIterator< TImage > | |
OffsetValueType | m_SpanBeginOffset |
OffsetValueType | m_SpanEndOffset |
typedef Superclass::AccessorType itk::ImageRegionIterator< TImage >::AccessorType |
Definition at line 95 of file itkImageRegionIterator.h.
typedef Superclass::ImageType itk::ImageRegionIterator< TImage >::ImageType |
Definition at line 90 of file itkImageRegionIterator.h.
typedef Superclass::IndexType itk::ImageRegionIterator< TImage >::IndexType |
Types inherited from the Superclass
Definition at line 86 of file itkImageRegionIterator.h.
typedef Superclass::InternalPixelType itk::ImageRegionIterator< TImage >::InternalPixelType |
Definition at line 93 of file itkImageRegionIterator.h.
typedef Superclass::OffsetType itk::ImageRegionIterator< TImage >::OffsetType |
Definition at line 88 of file itkImageRegionIterator.h.
typedef Superclass::PixelContainer itk::ImageRegionIterator< TImage >::PixelContainer |
Definition at line 91 of file itkImageRegionIterator.h.
typedef Superclass::PixelContainerPointer itk::ImageRegionIterator< TImage >::PixelContainerPointer |
Definition at line 92 of file itkImageRegionIterator.h.
typedef Superclass::PixelType itk::ImageRegionIterator< TImage >::PixelType |
Definition at line 94 of file itkImageRegionIterator.h.
typedef Superclass::RegionType itk::ImageRegionIterator< TImage >::RegionType |
Definition at line 89 of file itkImageRegionIterator.h.
typedef ImageRegionIterator itk::ImageRegionIterator< TImage >::Self |
Standard class typedefs.
Definition at line 82 of file itkImageRegionIterator.h.
typedef Superclass::SizeType itk::ImageRegionIterator< TImage >::SizeType |
Definition at line 87 of file itkImageRegionIterator.h.
typedef ImageRegionConstIterator< TImage > itk::ImageRegionIterator< TImage >::Superclass |
Definition at line 83 of file itkImageRegionIterator.h.
itk::ImageRegionIterator< TImage >::ImageRegionIterator | ( | ) |
Default constructor. Needed since we provide a cast constructor.
itk::ImageRegionIterator< TImage >::ImageRegionIterator | ( | ImageType * | ptr, |
const RegionType & | region | ||
) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
itk::ImageRegionIterator< TImage >::ImageRegionIterator | ( | const ImageIterator< TImage > & | it | ) |
Constructor that can be used to cast from an ImageIterator to an ImageRegionIterator. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionIterator.
|
protected |
the construction from a const iterator is declared protected in order to enforce const correctness.
itk::ImageRegionIterator< TImage >::itkLegacyMacro | ( | Self Begin(void) | const | ) |
Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.
itk::ImageRegionIterator< TImage >::itkLegacyMacro | ( | Self End(void) | const | ) |
Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.
|
protected |
the construction from a const iterator is declared protected in order to enforce const correctness.
|
inline |
Set the pixel value
Definition at line 113 of file itkImageRegionIterator.h.
Referenced by itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel().
|
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 122 of file itkImageRegionIterator.h.
Referenced by itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel().