VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDataSetAlgorithm Class Reference

Superclass for algorithms that produce output of the same type as input. More...

#include <vtkDataSetAlgorithm.h>

Inherits vtkAlgorithm.

Inherited by vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCastToConcrete, vtkCellDataToPointData, vtkCellDerivatives, vtkCellQuality, vtkDataObjectToDataSetFilter, vtkDataSetGradient, vtkDataSetGradientPrecompute, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGenericProbeFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMatrixMathFilter, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkPassThroughFilter, vtkPieceScalars, vtkPointDataToCellData, vtkProbeFilter, vtkProbePolyhedron, vtkProcessIdScalars, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, and vtkVectorNorm.

Collaboration diagram for vtkDataSetAlgorithm:
[legend]

Public Types

typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataSetAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkPolyDataGetPolyDataOutput ()
 
vtkStructuredPointsGetStructuredPointsOutput ()
 
vtkImageData * GetImageDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGrid * GetUnstructuredGridOutput ()
 
vtkRectilinearGridGetRectilinearGridOutput ()
 
vtkDataSet * GetOutput ()
 
vtkDataSet * GetOutput (int)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void SetInputData (vtkDataSet *)
 
void SetInputData (int, vtkDataSet *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (vtkDataSet *)
 
void AddInputData (int, vtkDataSet *)
 
void AddInputData (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkDataSetAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
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 vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
vtkDataObjectGetInput (int port)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

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
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Superclass for algorithms that produce output of the same type as input.

vtkDataSetAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this class you should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this classes contstructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be DataSet. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into separate functions such as RequestDataObject RequestData and RequestInformation. The default implementation of RequestDataObject will create an output data of the same type as the input.

Tests:
vtkDataSetAlgorithm (Tests)

Definition at line 50 of file vtkDataSetAlgorithm.h.

Member Typedef Documentation

Definition at line 54 of file vtkDataSetAlgorithm.h.

Constructor & Destructor Documentation

vtkDataSetAlgorithm::vtkDataSetAlgorithm ( )
protected
vtkDataSetAlgorithm::~vtkDataSetAlgorithm ( )
inlineprotected

Definition at line 114 of file vtkDataSetAlgorithm.h.

Member Function Documentation

static vtkDataSetAlgorithm* vtkDataSetAlgorithm::New ( )
static
static int vtkDataSetAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkDataSetAlgorithm::IsA ( const char *  type)
virtual
static vtkDataSetAlgorithm* vtkDataSetAlgorithm::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkDataSetAlgorithm::NewInstanceInternal ( ) const
protectedvirtual
vtkDataSetAlgorithm* vtkDataSetAlgorithm::NewInstance ( ) const
void vtkDataSetAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
vtkDataSet* vtkDataSetAlgorithm::GetOutput ( )

Get the output data object for a port on this algorithm.

vtkDataSet* vtkDataSetAlgorithm::GetOutput ( int  )

Get the output data object for a port on this algorithm.

vtkDataObject* vtkDataSetAlgorithm::GetInput ( )

Get the input data object. This method is not recommended for use, but lots of old style filters use it.

vtkPolyData* vtkDataSetAlgorithm::GetPolyDataOutput ( )

Get the output as vtkPolyData.

vtkStructuredPoints* vtkDataSetAlgorithm::GetStructuredPointsOutput ( )

Get the output as vtkStructuredPoints.

vtkImageData* vtkDataSetAlgorithm::GetImageDataOutput ( )

Get the output as vtkStructuredPoints.

vtkStructuredGrid* vtkDataSetAlgorithm::GetStructuredGridOutput ( )

Get the output as vtkStructuredGrid.

vtkUnstructuredGrid* vtkDataSetAlgorithm::GetUnstructuredGridOutput ( )

Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid* vtkDataSetAlgorithm::GetRectilinearGridOutput ( )

Get the output as vtkRectilinearGrid.

void vtkDataSetAlgorithm::SetInputData ( vtkDataObject )

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::SetInputData ( int  ,
vtkDataObject  
)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::SetInputData ( vtkDataSet *  )

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::SetInputData ( int  ,
vtkDataSet *   
)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::AddInputData ( vtkDataObject )

Assign a data object as input. Note that this method does not establish a pipeline connection. Use AddInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::AddInputData ( vtkDataSet *  )

Assign a data object as input. Note that this method does not establish a pipeline connection. Use AddInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::AddInputData ( int  ,
vtkDataSet *   
)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use AddInputConnection() to setup a pipeline connection.

void vtkDataSetAlgorithm::AddInputData ( int  ,
vtkDataObject  
)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use AddInputConnection() to setup a pipeline connection.

virtual int vtkDataSetAlgorithm::ProcessRequest ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
virtual

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

virtual int vtkDataSetAlgorithm::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
inlineprotectedvirtual

This is called within ProcessRequest when a request asks for Information. Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens in the first pass of the pipeline execution.

Reimplemented in vtkDataObjectToDataSetFilter, vtkProbeFilter, vtkProbePolyhedron, vtkProgrammableSource, vtkGenericProbeFilter, vtkCastToConcrete, and vtkPProbeFilter.

Definition at line 122 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
inlineprotectedvirtual

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. This happens during the second pass in the pipeline execution process.

Reimplemented in vtkDataObjectToDataSetFilter, vtkFieldDataToAttributeDataFilter, vtkMergeFilter, vtkProbeFilter, vtkGradientFilter, vtkProbePolyhedron, vtkPProbeFilter, and vtkPCellDataToPointData.

Definition at line 132 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. This typically happens early on in the execution of the pipeline. The default behavior is to create an output DataSet of the same type as the input for each output port. This method can be overridden to change the output data type of an algorithm. This happens in the third pass of the pipeline execution.

Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.

virtual int vtkDataSetAlgorithm::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
inlineprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented in vtkMeshQuality, vtkCellQuality, vtkRandomAttributeGenerator, vtkDataObjectToDataSetFilter, vtkFieldDataToAttributeDataFilter, vtkArrayCalculator, vtkRearrangeFields, vtkExtractTensorComponents, vtkMergeFilter, vtkSelectEnclosedPoints, vtkMaskFields, vtkSplitField, vtkMergeFields, vtkGradientFilter, vtkProgrammableAttributeDataFilter, vtkProbeFilter, vtkTransformTextureCoords, vtkProjectedTexture, vtkProbePolyhedron, vtkTextureMapToPlane, vtkCellDerivatives, vtkProgrammableSource, vtkTextureMapToCylinder, vtkImplicitTextureCoords, vtkThresholdTextureCoords, vtkTextureMapToSphere, vtkCompositeDataProbeFilter, vtkIdFilter, vtkExtractVectorComponents, vtkMatrixMathFilter, vtkVectorNorm, vtkGenericProbeFilter, vtkMergeDataObjectFilter, vtkProcessIdScalars, vtkAttributeDataToFieldDataFilter, vtkCellDataToPointData, vtkElevationFilter, vtkPieceScalars, vtkPointDataToCellData, vtkInterpolateDataSetAttributes, vtkCastToConcrete, vtkOBBDicer, vtkVectorDot, vtkBrownianPoints, vtkPProbeFilter, vtkSimpleElevationFilter, vtkDataSetGradient, vtkQuadraturePointInterpolator, vtkQuadratureSchemeDictionaryGenerator, vtkHyperOctreeLimiter, vtkPCellDataToPointData, vtkDataSetGradientPrecompute, vtkPassThroughFilter, and vtkHyperOctreeDepth.

Definition at line 159 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::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.

Reimplemented in vtkHyperOctreeLimiter, vtkQuadraturePointInterpolator, vtkQuadratureSchemeDictionaryGenerator, and vtkHyperOctreeDepth.

virtual int vtkDataSetAlgorithm::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkDataObjectToDataSetFilter, vtkMergeFilter, vtkSelectEnclosedPoints, vtkGenericProbeFilter, vtkMergeDataObjectFilter, vtkCompositeDataProbeFilter, vtkInterpolateDataSetAttributes, vtkPProbeFilter, vtkHyperOctreeLimiter, vtkQuadraturePointInterpolator, vtkQuadratureSchemeDictionaryGenerator, and vtkHyperOctreeDepth.

vtkDataObject* vtkDataSetAlgorithm::GetInput ( int  port)
protected

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