VTK
Public Types | Public Member Functions | Protected Attributes | List of all members
vtkImageIterator< DType > Class Template Reference

a simple image iterator More...

#include <vtkImageIterator.h>

Inheritance diagram for vtkImageIterator< DType >:
[legend]

Public Types

typedef DType * SpanIterator
 

Public Member Functions

 vtkImageIterator ()
 
 vtkImageIterator (vtkImageData *id, int *ext)
 
void Initialize (vtkImageData *id, int *ext)
 
void NextSpan ()
 
SpanIterator BeginSpan ()
 
SpanIterator EndSpan ()
 
int IsAtEnd ()
 

Protected Attributes

DType * Pointer
 
DType * SpanEndPointer
 
DType * SliceEndPointer
 
DType * EndPointer
 
vtkIdType Increments [3]
 
vtkIdType ContinuousIncrements [3]
 

Detailed Description

template<class DType>
class vtkImageIterator< DType >

a simple image iterator

This is a simple image iterator that can be used to iterate over an image. This should be used internally by Filter writers.

See also
vtkImageData vtkImageProgressIterator
Tests:
vtkImageIterator (Tests)

Definition at line 36 of file vtkImageIterator.h.

Member Typedef Documentation

template<class DType >
typedef DType* vtkImageIterator< DType >::SpanIterator

Definition at line 39 of file vtkImageIterator.h.

Constructor & Destructor Documentation

template<class DType >
vtkImageIterator< DType >::vtkImageIterator ( )

Default empty constructor, useful only when creating an array of iterators You need to call Initialize afterward

template<class DType >
vtkImageIterator< DType >::vtkImageIterator ( vtkImageData id,
int ext 
)

Create an image iterator for a given image data and a given extent

Member Function Documentation

template<class DType >
void vtkImageIterator< DType >::Initialize ( vtkImageData id,
int ext 
)

Initialize the image iterator for a given image data, and given extent

template<class DType >
void vtkImageIterator< DType >::NextSpan ( )

Move the iterator to the next span

template<class DType >
SpanIterator vtkImageIterator< DType >::BeginSpan ( )
inline

Return an iterator (pointer) for the span

Definition at line 57 of file vtkImageIterator.h.

template<class DType >
SpanIterator vtkImageIterator< DType >::EndSpan ( )
inline

Return an iterator (pointer) for the end of the span

Definition at line 65 of file vtkImageIterator.h.

template<class DType >
int vtkImageIterator< DType >::IsAtEnd ( )
inline

Test if the end of the extent has been reached

Definition at line 73 of file vtkImageIterator.h.

Member Data Documentation

template<class DType >
DType* vtkImageIterator< DType >::Pointer
protected

Definition at line 80 of file vtkImageIterator.h.

template<class DType >
DType* vtkImageIterator< DType >::SpanEndPointer
protected

Definition at line 81 of file vtkImageIterator.h.

template<class DType >
DType* vtkImageIterator< DType >::SliceEndPointer
protected

Definition at line 82 of file vtkImageIterator.h.

template<class DType >
DType* vtkImageIterator< DType >::EndPointer
protected

Definition at line 83 of file vtkImageIterator.h.

template<class DType >
vtkIdType vtkImageIterator< DType >::Increments[3]
protected

Definition at line 84 of file vtkImageIterator.h.

template<class DType >
vtkIdType vtkImageIterator< DType >::ContinuousIncrements[3]
protected

Definition at line 85 of file vtkImageIterator.h.


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