VTK
9.1.0
|
an image region iterator More...
#include <vtkImageStencilIterator.h>
Public Member Functions | |
bool | IsAtEnd () |
Test if the iterator has completed iterating over the entire extent. | |
DType * | BeginSpan () |
Return a pointer to the beginning of the current span. | |
DType * | EndSpan () |
Return a pointer to the end of the current span. | |
vtkImageStencilIterator () | |
Default constructor, its use must be followed by Initialize(). | |
vtkImageStencilIterator (vtkImageData *image, vtkImageStencilData *stencil=nullptr, const int extent[6]=nullptr, vtkAlgorithm *algorithm=nullptr, int threadId=0) | |
Create an iterator for the given image, with several options. | |
void | Initialize (vtkImageData *image, vtkImageStencilData *stencil=nullptr, const int extent[6]=nullptr, vtkAlgorithm *algorithm=nullptr, int threadId=0) |
Initialize an iterator. | |
void | NextSpan () |
Move the iterator to the beginning of the next span. | |
Public Member Functions inherited from vtkImagePointDataIterator | |
vtkImagePointDataIterator () | |
Default constructor, its use must be followed by Initialize(). | |
vtkImagePointDataIterator (vtkImageData *image, const int extent[6]=nullptr, vtkImageStencilData *stencil=nullptr, vtkAlgorithm *algorithm=nullptr, int threadId=0) | |
Create an iterator for the given image, with several options. | |
void | Initialize (vtkImageData *image, const int extent[6]=nullptr, vtkImageStencilData *stencil=nullptr, vtkAlgorithm *algorithm=nullptr, int threadId=0) |
Initialize an iterator. | |
void | NextSpan () |
Move the iterator to the beginning of the next span. | |
bool | IsAtEnd () |
Test if the iterator has completed iterating over the entire extent. | |
bool | IsInStencil () |
Check if the iterator is within the region specified by the stencil. | |
const int * | GetIndex () |
Get the index at the beginning of the current span. | |
vtkIdType | GetId () |
Get the point Id at the beginning of the current span. | |
vtkIdType | SpanEndId () |
Get the end of the span. | |
void | GetIndex (int result[3]) |
Get the index at the beginning of the current span. | |
Protected Member Functions | |
void | UpdatePointer () |
Update the pointer (called automatically when a new span begins). | |
Protected Member Functions inherited from vtkImagePointDataIterator | |
void | SetSpanState (int idX) |
Set all the state variables for the stencil span that includes idX. | |
void | ReportProgress () |
Report the progress and do an abort check, for compatibility with existing image filters. | |
Protected Attributes | |
int | Increment |
DType * | BasePointer |
DType * | Pointer |
DType * | SpanEndPointer |
Protected Attributes inherited from vtkImagePointDataIterator | |
vtkIdType | Id |
vtkIdType | SpanEnd |
vtkIdType | RowEnd |
vtkIdType | SliceEnd |
vtkIdType | End |
vtkIdType | RowIncrement |
vtkIdType | SliceIncrement |
vtkIdType | RowEndIncrement |
vtkIdType | SliceEndIncrement |
int | Extent [6] |
int | Index [3] |
int | StartY |
bool | HasStencil |
bool | InStencil |
int | SpanSliceEndIncrement |
int | SpanSliceIncrement |
int | SpanIndex |
int * | SpanCountPointer |
int ** | SpanListPointer |
vtkAlgorithm * | Algorithm |
vtkIdType | Count |
vtkIdType | Target |
int | ThreadId |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkImagePointDataIterator | |
static void * | GetVoidPointer (vtkImageData *image, vtkIdType i=0, int *pixelIncrement=nullptr) |
Get a void pointer and pixel increment for the given point Id. | |
static void * | GetVoidPointer (vtkDataArray *array, vtkIdType i=0, int *pixelIncrement=nullptr) |
Get a void pointer and pixel increment for the given point Id. | |
an image region iterator
This is an image iterator that can be used to iterate over a region of an image.
Definition at line 32 of file vtkImageStencilIterator.h.
|
inline |
Default constructor, its use must be followed by Initialize().
Definition at line 39 of file vtkImageStencilIterator.h.
|
inline |
Create an iterator for the given image, with several options.
If a stencil is provided, then the iterator's IsInStencil() method reports whether each span is inside the stencil. If an extent is provided, it iterates over the extent and ignores the rest of the image (the provided extent must be within the image extent). If a pointer to the algorithm is provided and threadId is set to zero, then progress events will provided for the algorithm.
Definition at line 58 of file vtkImageStencilIterator.h.
|
inline |
Initialize an iterator.
See constructor for more details.
Definition at line 72 of file vtkImageStencilIterator.h.
|
inline |
Move the iterator to the beginning of the next span.
A span is a contiguous region of the image over which nothing but the point Id and the X index changes.
Definition at line 88 of file vtkImageStencilIterator.h.
|
inline |
Test if the iterator has completed iterating over the entire extent.
Definition at line 98 of file vtkImageStencilIterator.h.
|
inline |
Return a pointer to the beginning of the current span.
Definition at line 103 of file vtkImageStencilIterator.h.
|
inline |
Return a pointer to the end of the current span.
Definition at line 108 of file vtkImageStencilIterator.h.
|
inlineprotected |
Update the pointer (called automatically when a new span begins).
Definition at line 115 of file vtkImageStencilIterator.h.
|
protected |
Definition at line 123 of file vtkImageStencilIterator.h.
|
protected |
Definition at line 126 of file vtkImageStencilIterator.h.
|
protected |
Definition at line 127 of file vtkImageStencilIterator.h.
|
protected |
Definition at line 128 of file vtkImageStencilIterator.h.