vtkImageStencilAlgorithm Class Reference

#include <vtkImageStencilAlgorithm.h>

Inheritance diagram for vtkImageStencilAlgorithm:

[legend]

Collaboration diagram for vtkImageStencilAlgorithm:

[legend]

List of all members.

---

Detailed Description

producer of vtkImageStencilData

vtkImageStencilAlgorithm is a superclass for filters that generate the special vtkImageStencilData type. This data type is a special representation of a binary image that can be used as a mask by several imaging filters.

See also:

vtkImageStencilData vtkImageStencilSource

Definition at line 34 of file vtkImageStencilAlgorithm.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 vtkImageStencilAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencilAlgorithm *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencilAlgorithm ()
	~vtkImageStencilAlgorithm ()
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 vtkImageStencilAlgorithm::Superclass

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

Definition at line 38 of file vtkImageStencilAlgorithm.h.

---

Constructor & Destructor Documentation

vtkImageStencilAlgorithm::vtkImageStencilAlgorithm

(

)

[protected]

vtkImageStencilAlgorithm::~vtkImageStencilAlgorithm

(

)

[protected]

---

Member Function Documentation

static vtkImageStencilAlgorithm* vtkImageStencilAlgorithm::New

(

)

[static]

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

virtual const char* vtkImageStencilAlgorithm::GetClassName

(

)

[virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

static int vtkImageStencilAlgorithm::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

virtual int vtkImageStencilAlgorithm::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

static vtkImageStencilAlgorithm* vtkImageStencilAlgorithm::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

void vtkImageStencilAlgorithm::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, vtkImageStencilSource, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

void vtkImageStencilAlgorithm::SetOutput

(

vtkImageStencilData *

output

)

Get or set the output for this source.

vtkImageStencilData* vtkImageStencilAlgorithm::GetOutput

(

)

Get or set the output for this source.

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

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

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

Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

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

Reimplemented in vtkImageStencilSource, and vtkImageToImageStencil.

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

Reimplemented in vtkImageToImageStencil.

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

virtual int vtkImageStencilAlgorithm::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/vtkImageStencilAlgorithm.h