Superclass for all sources, filters, and sinks in VTK. More...

#include <vtkAlgorithm.h>

Inheritance diagram for vtkAlgorithm:

Collaboration diagram for vtkAlgorithm:

Public Types
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.


virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.


bool	UsesGarbageCollector () const override
	Participate in garbage collection.


virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.


virtual double	GetProgress ()
	Get the execution progress of a process object.


void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.


virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.


void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.


void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.


virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.


void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.


virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.


virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.


virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.


virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.


int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.


int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.


int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.


void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.


void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

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 *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Public Attributes
std::atomic< vtkTypeBool >	AbortExecute

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)


int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.


vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.


vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.


vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.


vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Detailed Description

Superclass for all sources, filters, and sinks in VTK.

vtkAlgorithm is the superclass for all sources, filters, and sinks in VTK. It defines a generalized interface for executing data processing algorithms. Pipeline connections are associated with input and output ports that are independent of the type of data passing through the connections.

Instances may be used independently or within pipelines with a variety of architectures and update mechanisms. Pipelines are controlled by instances of vtkExecutive. Every vtkAlgorithm instance has an associated vtkExecutive when it is used in a pipeline. The executive is responsible for data flow.

Events:: vtkCommand::ProgressEvent

Examples:: vtkAlgorithm (Examples)

Online Examples:

vtkTestAlgorithmFilter

vtkTestAlgorithmSource

vtkTestFilterProgressFilter

vtkTestFilterSelfProgressFilter

vtkTestProgressReportFilter

OpenVRTessellatedBoxSource

TessellatedBoxSource

EllipticalButton

ReverseAccess

FixedPointVolumeRayCastMapperCT

Tests:: vtkAlgorithm (Tests)

Definition at line 161 of file vtkAlgorithm.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAlgorithm::Superclass

Definition at line 165 of file vtkAlgorithm.h.

Member Enumeration Documentation

◆ DesiredOutputPrecision

enum vtkAlgorithm::DesiredOutputPrecision

Values used for setting the desired output precision for various algorithms.

Currently, the following algorithms support changing their output precision: vtkAppendPolyData, vtkCleanPolyData, vtkClipPolyData, vtkConnectivityFilter, vtkDecimatePolylineFilter, vtkDecimatePro, vtkDelaunay3D, vtkFeatureEdges, vtkGlyph3D, vtkHedgeHog, vtkMaskPoints, vtkPolyDataConnectivityFilter, vtkSmoothPolyDataFilter, vtkStaticCleanPolyData, vtkThresholdPoints, vtkTubeFilter, vtkAppendPoints, vtkTransformFilter, vtkTransformPolyDataFilter, vtkLinearToQuadraticCellsFilter, vtkProcrustesAlignmentFilter, vtkAdaptiveSubdivisionFilter, vtkBoundedPointSource, vtkArcSource, vtkConeSource, vtkCubeSource, vtkCylinderSource, vtkDiskSource, vtkEllipseArcSource, vtkEllipticalButtonSource, vtkFrustumSource, vtkGlyphSource2D, vtkLineSource, vtkOutlineSource, vtkParametricFunctionSource, vtkPlaneSource, vtkPlatonicSolidSource, vtkPointSource, vtkRectangularButtonSource, vtkRegularPolygonSource, vtkSphereSource, vtkSuperquadricSource, vtkTessellatedBoxSource, vtkTextSource, vtkTexturedSphereSource, vtkImageToPoints, vtkDepthImageToPointCloud. SINGLE_PRECISION - Output single-precision floating-point (i.e. float) DOUBLE_PRECISION - Output double-precision floating-point (i.e. double) DEFAULT_PRECISION - Output precision should match the input precision.

Enumerator
SINGLE_PRECISION
DOUBLE_PRECISION
DEFAULT_PRECISION

Definition at line 188 of file vtkAlgorithm.h.

Constructor & Destructor Documentation

◆ vtkAlgorithm()

vtkAlgorithm::vtkAlgorithm ( )

protected

◆ ~vtkAlgorithm()

vtkAlgorithm::~vtkAlgorithm ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAlgorithm * vtkAlgorithm::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkAlgorithm::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkAlgorithm::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 vtkObjectBase.

◆ SafeDownCast()

static vtkAlgorithm * vtkAlgorithm::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAlgorithm::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkAlgorithm * vtkAlgorithm::NewInstance ( ) const

◆ PrintSelf()

void vtkAlgorithm::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

◆ HasExecutive()

vtkTypeBool vtkAlgorithm::HasExecutive ( )

Check whether this algorithm has an assigned executive.

This will NOT create a default executive.

◆ GetExecutive()

vtkExecutive * vtkAlgorithm::GetExecutive ( )

Get this algorithm's executive.

If it has none, a default executive will be created.

◆ SetExecutive()

virtual void vtkAlgorithm::SetExecutive ( vtkExecutive * executive )

virtual

Set this algorithm's executive.

This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.

◆ ProcessRequest() [1/2]

virtual vtkTypeBool vtkAlgorithm::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inInfo,
		vtkInformationVector *	outInfo
	)

virtual

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs.

A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest.

An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest.

It returns the boolean status of the pipeline (false means failure).

Reimplemented in vtkmExternalFaces, vtkAnnotationLayersAlgorithm, vtkArrayDataAlgorithm, vtkCellGridAlgorithm, vtkDataObjectAlgorithm, vtkDirectedGraphAlgorithm, vtkExplicitStructuredGridAlgorithm, vtkGraphAlgorithm, vtkHyperTreeGridAlgorithm, vtkImageAlgorithm, vtkMoleculeAlgorithm, vtkMultiTimeStepAlgorithm, vtkPiecewiseFunctionAlgorithm, vtkPolyDataAlgorithm, vtkRectilinearGridAlgorithm, vtkSelectionAlgorithm, vtkStructuredGridAlgorithm, vtkTableAlgorithm, vtkTreeAlgorithm, vtkTrivialProducer, vtkUndirectedGraphAlgorithm, vtkUnstructuredGridAlgorithm, vtkUnstructuredGridBaseAlgorithm, vtkAppendDataSets, vtkConnectivityFilter, vtkResampleToImage, vtkStreamerBase, vtkExtractDataOverTime, vtkImplicitModeller, vtkRenderLargeImage, vtkTransformToGrid, vtkMemoryLimitImageDataStreamer, vtkSignedDistance, vtkUnsignedDistance, vtkSMPContourGrid, vtkImageDataStreamer, vtkImageStencilAlgorithm, vtkImageOpenClose3D, vtkADIOS2CoreImageReader, vtkCGNSFileSeriesReader, vtkExodusIIReader, vtkFidesReader, vtkXMLPMultiBlockDataWriter, vtkXdmf3Reader, vtkXMLCompositeDataWriter, vtkXMLTableWriter, vtkXMLUnstructuredDataWriter, vtkPolyDataMapper, vtkRendererSource, vtkResizingWindowToImageFilter, vtkWindowToImageFilter, vtkLabelHierarchyAlgorithm, vtkPartitionedDataSetAlgorithm, vtkPartitionedDataSetCollectionAlgorithm, vtkReaderAlgorithm, vtkPythonAlgorithm, vtkWindBladeReader, vtkIOSSReader, vtkMNITransformReader, vtkMNITransformWriter, vtkXMLWriter2, vtkImageMapper3D, vtkImageSliceMapper, vtkImageResliceMapper, vtkCompositeDataSetAlgorithm, vtkDataSetAlgorithm, vtkEnsembleSource, vtkHierarchicalBoxDataSetAlgorithm, vtkMultiBlockDataSetAlgorithm, vtkPassInputTypeAlgorithm, vtkPointSetAlgorithm, vtkUniformGridAMRAlgorithm, vtkPassArrays, vtkCompositeDataGeometryFilter, vtkTemporalDataSetCache, vtkTemporalFractal, vtkTemporalShiftScale, vtkTemporalSnapToTimeStep, vtkHyperTreeGridCellCenters, vtkPieceRequestFilter, vtkGenerateIndexArray, vtkStringToCategory, vtkStringToNumeric, vtkWriter, vtkCPExodusIIInSituReader, vtkExodusIIWriter, vtkHDFWriter, vtkIOSSWriter, vtkOpenVDBWriter, vtkXMLPDataObjectWriter, vtkXdmfReader, vtkXMLReader, vtkXMLStructuredDataWriter, and vtkXMLWriter.

◆ ProcessRequest() [2/2]

vtkTypeBool vtkAlgorithm::ProcessRequest	(	vtkInformation *	request,
		vtkCollection *	inInfo,
		vtkInformationVector *	outInfo
	)

Version of ProcessRequest() that is wrapped.

This converts the collection to an array and calls the other version.

◆ ComputePipelineMTime()

virtual int vtkAlgorithm::ComputePipelineMTime	(	vtkInformation *	request,
		vtkInformationVector **	inInfoVec,
		vtkInformationVector *	outInfoVec,
		int	requestFromOutputPort,
		vtkMTimeType *	mtime
	)

virtual

A special version of ProcessRequest meant specifically for the pipeline modified time request.

See vtkExecutive::ComputePipelineMTime() for details.

Reimplemented in vtkImageOpenClose3D, vtkImageImport, vtkClipClosedSurface, and vtkVolumeOutlineSource.

◆ ModifyRequest()

virtual int vtkAlgorithm::ModifyRequest	(	vtkInformation *	request,
		int	when
	)

virtual

This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.

◆ GetInputPortInformation()

vtkInformation * vtkAlgorithm::GetInputPortInformation ( int port )

Get the information object associated with an input port.

There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.

◆ GetOutputPortInformation()

vtkInformation * vtkAlgorithm::GetOutputPortInformation ( int port )

Get the information object associated with an output port.

There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.

◆ GetInformation()

virtual vtkInformation * vtkAlgorithm::GetInformation ( )

virtual

Set/Get the information object associated with this algorithm.

◆ SetInformation()

virtual void vtkAlgorithm::SetInformation ( vtkInformation * )

virtual

Set/Get the information object associated with this algorithm.

◆ GetNumberOfInputPorts()

int vtkAlgorithm::GetNumberOfInputPorts ( )

Get the number of input ports used by the algorithm.

◆ GetNumberOfOutputPorts()

int vtkAlgorithm::GetNumberOfOutputPorts ( )

Get the number of output ports provided by the algorithm.

◆ UsesGarbageCollector()

bool vtkAlgorithm::UsesGarbageCollector ( ) const

inlineoverridevirtual

Participate in garbage collection.

Reimplemented from vtkObjectBase.

Definition at line 302 of file vtkAlgorithm.h.

◆ SetAbortExecuteAndUpdateTime()

void vtkAlgorithm::SetAbortExecuteAndUpdateTime ( )

Set AbortExecute Flag and update LastAbortTime.

◆ SetAbortExecute()

virtual void vtkAlgorithm::SetAbortExecute ( vtkTypeBool )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ GetAbortExecute()

virtual vtkTypeBool vtkAlgorithm::GetAbortExecute ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ AbortExecuteOn()

virtual void vtkAlgorithm::AbortExecuteOn ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ AbortExecuteOff()

virtual void vtkAlgorithm::AbortExecuteOff ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ GetProgress()

virtual double vtkAlgorithm::GetProgress ( )

virtual

Get the execution progress of a process object.

◆ UpdateProgress()

void vtkAlgorithm::UpdateProgress ( double amount )

Update the progress of the process object.

If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

◆ CheckAbort()

bool vtkAlgorithm::CheckAbort ( )

Checks to see if this filter should abort.

◆ SetContainerAlgorithm()

void vtkAlgorithm::SetContainerAlgorithm ( vtkAlgorithm * containerAlg )

inline

Set/get a Container algorithm for this algorithm.

Allows this algorithm to check to abort status of its Container algorithm as well as have access to its Container's information.

Definition at line 345 of file vtkAlgorithm.h.

◆ GetContainerAlgorithm()

vtkAlgorithm * vtkAlgorithm::GetContainerAlgorithm ( )

inline

Set/get a Container algorithm for this algorithm.

Allows this algorithm to check to abort status of its Container algorithm as well as have access to its Container's information.

Definition at line 349 of file vtkAlgorithm.h.

◆ SetAbortOutput()

virtual void vtkAlgorithm::SetAbortOutput ( bool )

virtual

Set/Get an internal variable used to communicate between the algorithm and executive.

If the executive sees this value is set, it will initialize the output data and pass the ABORTED flag downstream.

CheckAbort sets this value to true if the function returns true.

◆ GetAbortOutput()

virtual bool vtkAlgorithm::GetAbortOutput ( )

virtual

Set/Get an internal variable used to communicate between the algorithm and executive.

If the executive sees this value is set, it will initialize the output data and pass the ABORTED flag downstream.

CheckAbort sets this value to true if the function returns true.

◆ SetProgressShiftScale()

void vtkAlgorithm::SetProgressShiftScale	(	double	shift,
		double	scale
	)

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ GetProgressShift()

virtual double vtkAlgorithm::GetProgressShift ( )

virtual

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ GetProgressScale()

virtual double vtkAlgorithm::GetProgressScale ( )

virtual

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ SetProgressText()

void vtkAlgorithm::SetProgressText ( const char * ptext )

Set the current text message associated with the progress state.

This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

◆ GetProgressText()

virtual char * vtkAlgorithm::GetProgressText ( )

virtual

Set the current text message associated with the progress state.

This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

◆ GetErrorCode()

virtual unsigned long vtkAlgorithm::GetErrorCode ( )

virtual

The error code contains a possible error that occurred while reading or writing the file.

◆ SetInputArrayToProcess() [1/5]

void vtkAlgorithm::SetInputArrayToProcess	(	const char *	name,
		int	fieldAssociation
	)

Set the input data arrays that this algorithm will process.

Default to SetInputArrayToProcess(0, 0, 0, fieldAssociation, name)

Parameters

name	the name of the array to process
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.

See also: void SetInputArrayToProcess(int, int, int, int, const char*)

◆ SetInputArrayToProcess() [2/5]

virtual void vtkAlgorithm::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		int	fieldAssociation,
		const char *	name
	)

virtual

Set the input data arrays that this algorithm will process.

Array is expected to be in the input data object specified by (port, connection), and is stored under the given fieldAssociation with given name Internally, this algorithm references it at idx position.

Full signature with array name.

Parameters

idx	the intern index of the array, in vtkAlgorithm scope. Useful for algorithm expecting different arrays to work.
port	the algorithm input port of the data object where to look for the requested array. See GetInputDataObject
connection	the algorithm input connection of the data object where to look for the requested array. See GetInputDataObject
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.
name	the name of the array to process

Reimplemented in vtkCompositePolyDataMapper, and vtkCompositePolyDataMapper.

◆ SetInputArrayToProcess() [3/5]

virtual void vtkAlgorithm::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		int	fieldAssociation,
		int	fieldAttributeType
	)

virtual

Set the input data arrays that this algorithm will process.

Full signature with attribute type.

Parameters

idx	the intern index of the array, in vtkAlgorithm scope. Useful for algorithm expecting different arrays to work.
port	the algorithm input port of the data object where to look for the requested array. See GetInputDataObject
connection	the algorithm input connection of the data object where to look for the requested array. See GetInputDataObject
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.
fieldAttributeType	the attribute type related to the array to use. See vtkDataSetAttributes::AttributeTypes for possible values.

Reimplemented in vtkCompositePolyDataMapper, and vtkCompositePolyDataMapper.

◆ SetInputArrayToProcess() [4/5]

virtual void vtkAlgorithm::SetInputArrayToProcess	(	int	idx,
		vtkInformation *	info
	)

virtual

Set the input data arrays that this algorithm will process.

Alternative variant that copy information into relevant InputArrayInformation. See GetInputArrayInformation

Reimplemented in vtkCompositePolyDataMapper, and vtkCompositePolyDataMapper.

◆ SetInputArrayToProcess() [5/5]

virtual void vtkAlgorithm::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		const char *	fieldAssociation,
		const char *	attributeTypeorName
	)

virtual

Set the input data arrays that this algorithm will process.

String based version of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information.

Field association is one of the following:

Attribute type is one of the following:

If the last argument is not an attribute type, it is assumed to be an array name.

See also: void SetInputArrayToProcess(int, int, int, int, int)

Reimplemented in vtkCompositePolyDataMapper.

◆ GetInputArrayInformation()

vtkInformation * vtkAlgorithm::GetInputArrayInformation ( int idx )

Get the info object for the specified input array to this algorithm.

◆ RemoveAllInputs()

void vtkAlgorithm::RemoveAllInputs ( )

Remove all the input data.

◆ GetOutputDataObject()

vtkDataObject * vtkAlgorithm::GetOutputDataObject ( int port )

Get the data object that will contain the algorithm output for the given port.

◆ GetInputDataObject()

vtkDataObject * vtkAlgorithm::GetInputDataObject	(	int	port,
		int	connection
	)

Get the data object that will contain the algorithm input for the given port and given connection.

◆ SetInputConnection() [1/2]

virtual void vtkAlgorithm::SetInputConnection	(	int	port,
		vtkAlgorithmOutput *	input
	)

virtual

Set the connection for the given input port index.

Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().

The input for the connection is the output port of another filter, which is obtained with GetOutputPort(). Typical usage is

filter2->SetInputConnection(0, filter1->GetOutputPort(0)).

Reimplemented in vtkImageMathematics, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, and vtkAbstractHyperTreeGridMapper.

◆ SetInputConnection() [2/2]

virtual void vtkAlgorithm::SetInputConnection ( vtkAlgorithmOutput * input )

virtual

Set the connection for the given input port index.

Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().

The input for the connection is the output port of another filter, which is obtained with GetOutputPort(). Typical usage is

filter2->SetInputConnection(0, filter1->GetOutputPort(0)).

Reimplemented in vtkImageMathematics, vtkAbstractHyperTreeGridMapper, vtkGPUVolumeRayCastMapper, and vtkAMRVolumeMapper.

◆ AddInputConnection() [1/2]

virtual void vtkAlgorithm::AddInputConnection	(	int	port,
		vtkAlgorithmOutput *	input
	)

virtual

Add a connection to the given input port index.

See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is

filter2->AddInputConnection(0, filter1->GetOutputPort(0)).

◆ AddInputConnection() [2/2]

virtual void vtkAlgorithm::AddInputConnection ( vtkAlgorithmOutput * input )

virtual

Add a connection to the given input port index.

See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is

filter2->AddInputConnection(0, filter1->GetOutputPort(0)).

◆ RemoveInputConnection() [1/2]

virtual void vtkAlgorithm::RemoveInputConnection	(	int	port,
		vtkAlgorithmOutput *	input
	)

virtual

Remove a connection from the given input port index.

See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is

filter2->RemoveInputConnection(0, filter1->GetOutputPort(0)).

Reimplemented in vtkGPUVolumeRayCastMapper.

◆ RemoveInputConnection() [2/2]

virtual void vtkAlgorithm::RemoveInputConnection	(	int	port,
		int	idx
	)

virtual

Remove a connection given by index idx.

Reimplemented in vtkGPUVolumeRayCastMapper.

◆ RemoveAllInputConnections()

virtual void vtkAlgorithm::RemoveAllInputConnections ( int port )

virtual

Removes all input connections.

◆ SetInputDataObject() [1/2]

virtual void vtkAlgorithm::SetInputDataObject	(	int	port,
		vtkDataObject *	data
	)

virtual

Sets the data-object as an input on the given port index.

Setting the input with this method removes all other connections from the port. Internally, this method creates a vtkTrivialProducer instance and sets that as the input-connection for the given port. It is safe to call this method repeatedly with the same input data object. The MTime of the vtkAlgorithm will not change unless the data object changed.

Reimplemented in vtkHyperTreeGridMapper.

◆ SetInputDataObject() [2/2]

virtual void vtkAlgorithm::SetInputDataObject ( vtkDataObject * data )

inlinevirtual

Reimplemented in vtkHyperTreeGridMapper.

Definition at line 636 of file vtkAlgorithm.h.

◆ AddInputDataObject() [1/2]

virtual void vtkAlgorithm::AddInputDataObject	(	int	port,
		vtkDataObject *	data
	)

virtual

Add the data-object as an input to this given port.

This will add a new input connection on the specified port without affecting any existing connections on the same input port.

◆ AddInputDataObject() [2/2]

virtual void vtkAlgorithm::AddInputDataObject ( vtkDataObject * data )

inlinevirtual

Definition at line 644 of file vtkAlgorithm.h.

◆ GetOutputPort() [1/2]

vtkAlgorithmOutput * vtkAlgorithm::GetOutputPort ( int index )

Get a proxy object corresponding to the given output port of this algorithm.

The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.

◆ GetOutputPort() [2/2]

vtkAlgorithmOutput * vtkAlgorithm::GetOutputPort ( )

inline

Definition at line 653 of file vtkAlgorithm.h.

◆ GetNumberOfInputConnections()

int vtkAlgorithm::GetNumberOfInputConnections ( int port )

Get the number of inputs currently connected to a port.

◆ GetTotalNumberOfInputConnections()

int vtkAlgorithm::GetTotalNumberOfInputConnections ( )

Get the total number of inputs for this algorithm.

◆ GetInputConnection()

vtkAlgorithmOutput * vtkAlgorithm::GetInputConnection	(	int	port,
		int	index
	)

Get the algorithm output port connected to an input port.

◆ GetInputAlgorithm() [1/3]

vtkAlgorithm * vtkAlgorithm::GetInputAlgorithm	(	int	port,
		int	index,
		int &	algPort
	)

Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

◆ GetInputAlgorithm() [2/3]

vtkAlgorithm * vtkAlgorithm::GetInputAlgorithm	(	int	port,
		int	index
	)

Returns the algorithm connected to a port-index pair.

◆ GetInputAlgorithm() [3/3]

vtkAlgorithm * vtkAlgorithm::GetInputAlgorithm ( )

inline

Equivalent to GetInputAlgorithm(0, 0).

Definition at line 684 of file vtkAlgorithm.h.

◆ GetInputExecutive() [1/2]

vtkExecutive * vtkAlgorithm::GetInputExecutive	(	int	port,
		int	index
	)

Returns the executive associated with a particular input connection.

◆ GetInputExecutive() [2/2]

vtkExecutive * vtkAlgorithm::GetInputExecutive ( )

inline

Equivalent to GetInputExecutive(0, 0)

Definition at line 695 of file vtkAlgorithm.h.

◆ GetInputInformation() [1/2]

vtkInformation * vtkAlgorithm::GetInputInformation	(	int	port,
		int	index
	)

Return the information object that is associated with a particular input connection.

This can be used to get meta-data coming from the REQUEST_INFORMATION pass and set requests for the REQUEST_UPDATE_EXTENT pass. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

◆ GetInputInformation() [2/2]

vtkInformation * vtkAlgorithm::GetInputInformation ( )

inline

Equivalent to GetInputInformation(0, 0)

Definition at line 710 of file vtkAlgorithm.h.

◆ GetOutputInformation()

vtkInformation * vtkAlgorithm::GetOutputInformation ( int port )

Return the information object that is associated with a particular output port.

This can be used to set meta-data coming during the REQUEST_INFORMATION. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

◆ Update() [1/4]

virtual VTK_UNBLOCKTHREADS void vtkAlgorithm::Update ( int port )

virtual

Bring this algorithm's outputs up-to-date.

Reimplemented in vtkCellGridMapper, vtkPolyDataMapper, and vtkImageResliceMapper.

◆ Update() [2/4]

virtual VTK_UNBLOCKTHREADS void vtkAlgorithm::Update ( )

virtual

Bring this algorithm's outputs up-to-date.

Reimplemented in vtkCellGridMapper, vtkPolyDataMapper, and vtkImageResliceMapper.

◆ Update() [3/4]

virtual vtkTypeBool vtkAlgorithm::Update	(	int	port,
		vtkInformationVector *	requests
	)

virtual

This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

The requests argument should contain an information object for each port that requests need to be passed. For each of those, the pipeline will copy all keys to the output information before execution. This is equivalent to:

* algorithm->UpdateInformation();
* for (int i=0; i<algorithm->GetNumberOfOutputPorts(); i++)
* {
* vtkInformation* portRequests = requests->GetInformationObject(i);
* if (portRequests)
* {
* algorithm->GetOutputInformation(i)->Append(portRequests);
* }
* }
* algorithm->Update();
*

Available requests include UPDATE_PIECE_NUMBER(), UPDATE_NUMBER_OF_PIECES() UPDATE_EXTENT() etc etc.

Reimplemented in vtkCellGridMapper, vtkPolyDataMapper, and vtkImageResliceMapper.

◆ Update() [4/4]

virtual vtkTypeBool vtkAlgorithm::Update ( vtkInformation * requests )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details.

Reimplemented in vtkCellGridMapper, vtkPolyDataMapper, and vtkImageResliceMapper.

◆ UpdatePiece()

virtual int vtkAlgorithm::UpdatePiece	(	int	piece,
		int	numPieces,
		int	ghostLevels,
		const int	extents[6] = `nullptr`
	)

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details. Supports piece and extent (optional) requests.

◆ UpdateExtent()

virtual VTK_UNBLOCKTHREADS int vtkAlgorithm::UpdateExtent ( const int extents[6] )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

Supports extent request.

◆ UpdateTimeStep()

virtual VTK_UNBLOCKTHREADS int vtkAlgorithm::UpdateTimeStep	(	double	time,
		int	piece = `-1`,
		int	numPieces = `1`,
		int	ghostLevels = `0`,
		const int	extents[6] = `nullptr`
	)

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details. Supports time, piece (optional) and extent (optional) requests.

◆ UpdateInformation()

virtual VTK_UNBLOCKTHREADS void vtkAlgorithm::UpdateInformation ( )

virtual

Bring the algorithm's information up-to-date.

◆ UpdateDataObject()

virtual void vtkAlgorithm::UpdateDataObject ( )

virtual

Create output object(s).

◆ PropagateUpdateExtent()

virtual void vtkAlgorithm::PropagateUpdateExtent ( )

virtual

Propagate meta-data upstream.

◆ UpdateWholeExtent()

virtual VTK_UNBLOCKTHREADS void vtkAlgorithm::UpdateWholeExtent ( )

virtual

Bring this algorithm's outputs up-to-date.

◆ ConvertTotalInputToPortConnection()

void vtkAlgorithm::ConvertTotalInputToPortConnection	(	int	ind,
		int &	port,
		int &	conn
	)

Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

◆ SetReleaseDataFlag()

virtual void vtkAlgorithm::SetReleaseDataFlag ( vtkTypeBool )

virtual

Turn release data flag on or off for all output ports.

◆ GetReleaseDataFlag()

virtual vtkTypeBool vtkAlgorithm::GetReleaseDataFlag ( )

virtual

Turn release data flag on or off for all output ports.

◆ ReleaseDataFlagOn()

void vtkAlgorithm::ReleaseDataFlagOn ( )

Turn release data flag on or off for all output ports.

◆ ReleaseDataFlagOff()

void vtkAlgorithm::ReleaseDataFlagOff ( )

Turn release data flag on or off for all output ports.

◆ UpdateExtentIsEmpty() [1/2]

int vtkAlgorithm::UpdateExtentIsEmpty	(	vtkInformation *	pinfo,
		vtkDataObject *	output
	)

This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

The source uses this call to determine whether to call Execute.

◆ UpdateExtentIsEmpty() [2/2]

int vtkAlgorithm::UpdateExtentIsEmpty	(	vtkInformation *	pinfo,
		int	extentType
	)

This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

The source uses this call to determine whether to call Execute.

◆ SetDefaultExecutivePrototype()

static void vtkAlgorithm::SetDefaultExecutivePrototype ( vtkExecutive * proto )

static

If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().