vtkImageStencilIterator< DType > Class Template Reference
#include <vtkImageStencilIterator.h>
Detailed Description
template<class DType>
class vtkImageStencilIterator< DType >
an image region iterator
This is an image iterator that can be used to iterate over a region of an image.
Definition at line 34 of file vtkImageStencilIterator.h.
Public Member Functions | |
| vtkImageStencilIterator () | |
| void | NextSpan () |
| vtkImageStencilIterator (vtkImageData *image, vtkImageStencilData *stencil, int extent[6], vtkAlgorithm *algorithm=0, int threadId=0) | |
| void | Initialize (vtkImageData *image, vtkImageStencilData *stencil, int extent[6]) |
| bool | IsInStencil () |
| bool | IsAtEnd () |
| DType * | BeginSpan () |
| DType * | EndSpan () |
Protected Member Functions | |
| void | SetSpanState (int idX) |
| void | ReportProgress () |
Protected Attributes | |
| DType * | Pointer |
| DType * | SpanEndPointer |
| DType * | RowEndPointer |
| DType * | SliceEndPointer |
| DType * | EndPointer |
| vtkIdType | PixelIncrement |
| vtkIdType | RowIncrement |
| vtkIdType | SliceIncrement |
| vtkIdType | RowEndIncrement |
| vtkIdType | SliceEndIncrement |
| bool | HasStencil |
| bool | InStencil |
| int | SpanSliceEndIncrement |
| int | SpanSliceIncrement |
| int | SpanMinX |
| int | SpanMaxX |
| int | SpanMinY |
| int | SpanMaxY |
| int | SpanMinZ |
| int | SpanMaxZ |
| int | SpanIndexX |
| int | SpanIndexY |
| int | SpanIndexZ |
| int * | SpanCountPointer |
| int ** | SpanListPointer |
| vtkAlgorithm * | Algorithm |
| vtkIdType | Count |
| vtkIdType | Target |
Constructor & Destructor Documentation
| vtkImageStencilIterator< DType >::vtkImageStencilIterator | ( | ) |
Default empty constructor, useful only when creating an array of iterators. Call Initialize() on each iterator before using.
| vtkImageStencilIterator< DType >::vtkImageStencilIterator | ( | vtkImageData * | image, | |
| vtkImageStencilData * | stencil, | |||
| int | extent[6], | |||
| vtkAlgorithm * | algorithm = 0, |
|||
| int | threadId = 0 | |||
| ) |
Create an iterator for an extent of an image. If a stencil is provided, it must have an extent at least as large as the desired extent.
Member Function Documentation
| void vtkImageStencilIterator< DType >::Initialize | ( | vtkImageData * | image, | |
| vtkImageStencilData * | stencil, | |||
| int | extent[6] | |||
| ) |
Initialize an iterator for an extent of the image. If a stencil is provided, it must have an extent at least as large as the desired extent.
| bool vtkImageStencilIterator< DType >::IsInStencil | ( | ) | [inline] |
Check if the iterator is within the stencilled region. This is updated when NextSpan() is called.
Definition at line 61 of file vtkImageStencilIterator.h.
| void vtkImageStencilIterator< DType >::NextSpan | ( | ) |
Move the iterator to the start of the next span. A span is a contiguous region over which nothing but the X index changes.
| bool vtkImageStencilIterator< DType >::IsAtEnd | ( | ) | [inline] |
Test if the end of the extent has been reached
Definition at line 73 of file vtkImageStencilIterator.h.
| DType* vtkImageStencilIterator< DType >::BeginSpan | ( | ) | [inline] |
Return a pointer to the beginning of the current span.
Definition at line 81 of file vtkImageStencilIterator.h.
| DType* vtkImageStencilIterator< DType >::EndSpan | ( | ) | [inline] |
Return a pointer to the end of the current span.
Definition at line 89 of file vtkImageStencilIterator.h.
| void vtkImageStencilIterator< DType >::SetSpanState | ( | int | idX | ) | [protected] |
Set all the state variables for the stencil span that includes idX.
| void vtkImageStencilIterator< DType >::ReportProgress | ( | ) | [protected] |
Report the progress and do an abort check. This must be called every time that one row of the image is completed. Only called if Algorithm is not null.
Member Data Documentation
DType* vtkImageStencilIterator< DType >::Pointer [protected] |
Definition at line 106 of file vtkImageStencilIterator.h.
DType* vtkImageStencilIterator< DType >::SpanEndPointer [protected] |
Definition at line 107 of file vtkImageStencilIterator.h.
DType* vtkImageStencilIterator< DType >::RowEndPointer [protected] |
Definition at line 108 of file vtkImageStencilIterator.h.
DType* vtkImageStencilIterator< DType >::SliceEndPointer [protected] |
Definition at line 109 of file vtkImageStencilIterator.h.
DType* vtkImageStencilIterator< DType >::EndPointer [protected] |
Definition at line 110 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::PixelIncrement [protected] |
Definition at line 113 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::RowIncrement [protected] |
Definition at line 114 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::SliceIncrement [protected] |
Definition at line 115 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::RowEndIncrement [protected] |
Definition at line 116 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::SliceEndIncrement [protected] |
Definition at line 117 of file vtkImageStencilIterator.h.
bool vtkImageStencilIterator< DType >::HasStencil [protected] |
Definition at line 120 of file vtkImageStencilIterator.h.
bool vtkImageStencilIterator< DType >::InStencil [protected] |
Definition at line 121 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanSliceEndIncrement [protected] |
Definition at line 122 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanSliceIncrement [protected] |
Definition at line 123 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMinX [protected] |
Definition at line 124 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMaxX [protected] |
Definition at line 125 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMinY [protected] |
Definition at line 126 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMaxY [protected] |
Definition at line 127 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMinZ [protected] |
Definition at line 128 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanMaxZ [protected] |
Definition at line 129 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanIndexX [protected] |
Definition at line 130 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanIndexY [protected] |
Definition at line 131 of file vtkImageStencilIterator.h.
int vtkImageStencilIterator< DType >::SpanIndexZ [protected] |
Definition at line 132 of file vtkImageStencilIterator.h.
int* vtkImageStencilIterator< DType >::SpanCountPointer [protected] |
Definition at line 133 of file vtkImageStencilIterator.h.
int** vtkImageStencilIterator< DType >::SpanListPointer [protected] |
Definition at line 134 of file vtkImageStencilIterator.h.
vtkAlgorithm* vtkImageStencilIterator< DType >::Algorithm [protected] |
Definition at line 137 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::Count [protected] |
Definition at line 138 of file vtkImageStencilIterator.h.
vtkIdType vtkImageStencilIterator< DType >::Target [protected] |
Definition at line 139 of file vtkImageStencilIterator.h.
The documentation for this class was generated from the following file:
- dox/Imaging/vtkImageStencilIterator.h
