vtkImageStencilSource Class Reference

#include <vtkImageStencilSource.h>

Inheritance diagram for vtkImageStencilSource:

[legend]

Collaboration diagram for vtkImageStencilSource:

[legend]

List of all members.

---

Detailed Description

generate an image stencil

vtkImageStencilSource is a superclass for filters that generate image stencils. Given a clipping object such as a vtkImplicitFunction, it will set up a list of clipping extents for each x-row through the image data. The extents for each x-row can be retrieved via the GetNextExtent() method after the extent lists have been built with the BuildExtents() method. For large images, using clipping extents is much more memory efficient (and slightly more time-efficient) than building a mask. This class can be subclassed to allow clipping with objects other than vtkImplicitFunction.

See also:

vtkImplicitFunction vtkImageStencil vtkPolyDataToImageStencil

Definition at line 39 of file vtkImageStencilSource.h.

Public Types
typedef vtkAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetOutput (vtkImageStencilData *output)
vtkImageStencilData *	GetOutput ()
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Static Public Member Functions
static vtkImageStencilSource *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencilSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencilSource ()
	~vtkImageStencilSource ()
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkImageStencilData *	AllocateOutputData (vtkDataObject *out, int *updateExt)
virtual int	FillOutputPortInformation (int, vtkInformation *)

---

Member Typedef Documentation

typedef vtkAlgorithm vtkImageStencilSource::Superclass

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

Definition at line 43 of file vtkImageStencilSource.h.

---

Constructor & Destructor Documentation

vtkImageStencilSource::vtkImageStencilSource

(

)

[protected]

vtkImageStencilSource::~vtkImageStencilSource

(

)

[protected]

---

Member Function Documentation

static vtkImageStencilSource* vtkImageStencilSource::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual const char* vtkImageStencilSource::GetClassName

(

)

[virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

static int vtkImageStencilSource::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual int vtkImageStencilSource::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

static vtkImageStencilSource* vtkImageStencilSource::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

void vtkImageStencilSource::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

void vtkImageStencilSource::SetOutput

(

vtkImageStencilData *

output

)

Get or set the output for this source.

vtkImageStencilData* vtkImageStencilSource::GetOutput

(

)

Get or set the output for this source.

virtual int vtkImageStencilSource::ProcessRequest	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			[virtual]

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

virtual int vtkImageStencilSource::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			[protected, virtual]

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual int vtkImageStencilSource::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			[inline, protected, virtual]

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

Definition at line 66 of file vtkImageStencilSource.h.

virtual int vtkImageStencilSource::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			[inline, protected, virtual]

Reimplemented in vtkImageToImageStencil.

Definition at line 68 of file vtkImageStencilSource.h.

vtkImageStencilData* vtkImageStencilSource::AllocateOutputData	(	vtkDataObject *	out,
		int *	updateExt
	)			[protected]

virtual int vtkImageStencilSource::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)			[protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

---

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

• dox/Imaging/vtkImageStencilSource.h