iterate over point data in an image. More...

#include <vtkImagePointDataIterator.h>

Inheritance diagram for vtkImagePointDataIterator:

Collaboration diagram for vtkImagePointDataIterator:

Public Member Functions
	vtkImagePointDataIterator ()
	Default constructor, its use must be followed by Initialize(). More...

	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. More...

void	Initialize (vtkImageData image, const int extent[6]=nullptr, vtkImageStencilData stencil=nullptr, vtkAlgorithm *algorithm=nullptr, int threadId=0)
	Initialize an iterator. More...

void	NextSpan ()
	Move the iterator to the beginning of the next span. More...

bool	IsAtEnd ()
	Test if the iterator has completed iterating over the entire extent. More...

bool	IsInStencil ()
	Check if the iterator is within the region specified by the stencil. More...

const int *	GetIndex ()
	Get the index at the beginning of the current span. More...

vtkIdType	GetId ()
	Get the point Id at the beginning of the current span. More...

vtkIdType	SpanEndId ()
	Get the end of the span. More...


void	GetIndex (int result[3])
	Get the index at the beginning of the current span. More...

Static Public Member Functions
static void *	GetVoidPointer (vtkImageData image, vtkIdType i=0, int pixelIncrement=nullptr)
	Get a void pointer and pixel increment for the given point Id. More...

static void *	GetVoidPointer (vtkDataArray array, vtkIdType i=0, int pixelIncrement=nullptr)
	Get a void pointer and pixel increment for the given point Id. More...

Protected Member Functions
void	SetSpanState (int idX)
	Set all the state variables for the stencil span that includes idX. More...

void	ReportProgress ()
	Report the progress and do an abort check, for compatibility with existing image filters. More...

Protected Attributes
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

Detailed Description

iterate over point data in an image.

This class will iterate over an image. For each position, it will provide the (I,J,K) index, the point Id, and if a stencil is supplied, it will report whether the point is inside or outside of the stencil.

For efficiency, this class iterates over spans rather than points. Each span is one image row or partial row, defined by a start position and a size. Within a span, only the X index and the point Id will change. The vtkImagePointDataIterator and related iterators are the preferred method of iterating over image data within the VTK image filters.

See also: vtkImageData vtkImageStencilData vtkImageProgressIterator

Tests:: vtkImagePointDataIterator (Tests)

Definition at line 45 of file vtkImagePointDataIterator.h.

Constructor & Destructor Documentation

vtkImagePointDataIterator::vtkImagePointDataIterator ( )

Default constructor, its use must be followed by Initialize().

vtkImagePointDataIterator::vtkImagePointDataIterator	(	vtkImageData *	image,
		const int	extent[6] = `nullptr`,
		vtkImageStencilData *	stencil = `nullptr`,
		vtkAlgorithm *	algorithm = `nullptr`,
		int	threadId = `0`
	)

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 62 of file vtkImagePointDataIterator.h.

Member Function Documentation

void vtkImagePointDataIterator::Initialize	(	vtkImageData *	image,
		const int	extent[6] = `nullptr`,
		vtkImageStencilData *	stencil = `nullptr`,
		vtkAlgorithm *	algorithm = `nullptr`,
		int	threadId = `0`
	)