an image region iterator More...

#include <vtkImageStencilIterator.h>

Collaboration diagram for vtkImageStencilIterator< DType >:

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

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.

See also: vtkImageData vtkImageStencilData vtkImageProgressIterator

Definition at line 35 of file vtkImageStencilIterator.h.

Constructor & Destructor Documentation

template<class DType >

vtkImageStencilIterator< DType >::vtkImageStencilIterator ( )

Default empty constructor, useful only when creating an array of iterators. Call Initialize() on each iterator before using.

template<class DType >

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

template<class DType >

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.

template<class DType >

bool vtkImageStencilIterator< DType >::IsInStencil ( )

inline

Check if the iterator is within the stencilled region. This is updated when NextSpan() is called.

Definition at line 62 of file vtkImageStencilIterator.h.

template<class DType >

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.

template<class DType >

bool vtkImageStencilIterator< DType >::IsAtEnd ( )

inline

Test if the end of the extent has been reached

Definition at line 74 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::BeginSpan ( )

inline

Return a pointer to the beginning of the current span.

Definition at line 82 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::EndSpan ( )

inline

Return a pointer to the end of the current span.

Definition at line 90 of file vtkImageStencilIterator.h.

template<class DType >

void vtkImageStencilIterator< DType >::SetSpanState ( int idX )

protected

Set all the state variables for the stencil span that includes idX.

template<class DType >

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

template<class DType >

DType* vtkImageStencilIterator< DType >::Pointer

protected

Definition at line 107 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::SpanEndPointer

protected

Definition at line 108 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::RowEndPointer

protected

Definition at line 109 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::SliceEndPointer

protected

Definition at line 110 of file vtkImageStencilIterator.h.

template<class DType >

DType* vtkImageStencilIterator< DType >::EndPointer

protected

Definition at line 111 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::PixelIncrement

protected

Definition at line 114 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::RowIncrement

protected

Definition at line 115 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::SliceIncrement

protected

Definition at line 116 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::RowEndIncrement

protected

Definition at line 117 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::SliceEndIncrement

protected

Definition at line 118 of file vtkImageStencilIterator.h.

template<class DType >

bool vtkImageStencilIterator< DType >::HasStencil

protected

Definition at line 121 of file vtkImageStencilIterator.h.

template<class DType >

bool vtkImageStencilIterator< DType >::InStencil

protected

Definition at line 122 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanSliceEndIncrement

protected

Definition at line 123 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanSliceIncrement

protected

Definition at line 124 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMinX

protected

Definition at line 125 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMaxX

protected

Definition at line 126 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMinY

protected

Definition at line 127 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMaxY

protected

Definition at line 128 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMinZ

protected

Definition at line 129 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanMaxZ

protected

Definition at line 130 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanIndexX

protected

Definition at line 131 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanIndexY

protected

Definition at line 132 of file vtkImageStencilIterator.h.

template<class DType >

int vtkImageStencilIterator< DType >::SpanIndexZ

protected

Definition at line 133 of file vtkImageStencilIterator.h.

template<class DType >

int* vtkImageStencilIterator< DType >::SpanCountPointer

protected

Definition at line 134 of file vtkImageStencilIterator.h.

template<class DType >

int** vtkImageStencilIterator< DType >::SpanListPointer

protected

Definition at line 135 of file vtkImageStencilIterator.h.

template<class DType >

vtkAlgorithm* vtkImageStencilIterator< DType >::Algorithm

protected

Definition at line 138 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::Count

protected

Definition at line 139 of file vtkImageStencilIterator.h.

template<class DType >

vtkIdType vtkImageStencilIterator< DType >::Target

protected

Definition at line 140 of file vtkImageStencilIterator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Imaging/Core/vtkImageStencilIterator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class DType> class vtkImageStencilIterator< DType >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class DType>
class vtkImageStencilIterator< DType >