#include <vtkImageStencilAlgorithm.h>

Inheritance diagram for vtkImageStencilAlgorithm:

Collaboration diagram for vtkImageStencilAlgorithm:

Public Types
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
Public Types inherited from vtkObject

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 )
Public Member Functions inherited from vtkAlgorithm
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
virtual void	Update ()
virtual void	UpdateInformation ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double	ComputePriority ()
int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char event, vtkCommand )
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char event, vtkCommand )
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char event, void callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkImageStencilAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencilAlgorithm *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkAlgorithm
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	PRESERVES_DATASET ()
static vtkInformationIntegerKey *	PRESERVES_GEOMETRY ()
static vtkInformationIntegerKey *	PRESERVES_BOUNDS ()
static vtkInformationIntegerKey *	PRESERVES_TOPOLOGY ()
static vtkInformationIntegerKey *	PRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKey *	PRESERVES_RANGES ()
Static Public Member Functions inherited from vtkObject
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()

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 *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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.

Member Typedef Documentation

typedef vtkAlgorithm vtkImageStencilAlgorithm::Superclass

Reimplemented from vtkAlgorithm.

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

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, vtkLassoStencilSource, vtkROIStencilSource, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual const char* vtkImageStencilAlgorithm::GetClassName ( )

virtual

Reimplemented from vtkAlgorithm.

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

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, vtkLassoStencilSource, vtkROIStencilSource, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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, vtkLassoStencilSource, vtkROIStencilSource, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

static vtkImageStencilAlgorithm* vtkImageStencilAlgorithm::SafeDownCast ( vtkObject * o )

static

Reimplemented from vtkAlgorithm.

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

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, vtkLassoStencilSource, vtkROIStencilSource, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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 *
	)

protectedvirtual

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

virtual int vtkImageStencilAlgorithm::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented in vtkImageStencilSource, and vtkImageToImageStencil.

virtual int vtkImageStencilAlgorithm::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented in vtkImageToImageStencil.

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

protected

virtual int vtkImageStencilAlgorithm::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

protectedvirtual

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation