vtkDataSetAlgorithm Class Reference
#include <vtkDataSetAlgorithm.h>
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. Ther 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 seperate functions such as RequestDataObject RequestData and RequestInformation. The default implementation of RequestDataObject will create an output data of the same type as the input.
Definition at line 49 of file vtkDataSetAlgorithm.h.
Member Typedef Documentation
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
Definition at line 53 of file vtkDataSetAlgorithm.h.
Constructor & Destructor Documentation
| vtkDataSetAlgorithm::vtkDataSetAlgorithm | ( | ) | [protected] |
| vtkDataSetAlgorithm::~vtkDataSetAlgorithm | ( | ) | [inline, protected] |
Definition at line 118 of file vtkDataSetAlgorithm.h.
Member Function Documentation
| static vtkDataSetAlgorithm* vtkDataSetAlgorithm::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| virtual const char* vtkDataSetAlgorithm::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| static int vtkDataSetAlgorithm::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| virtual int vtkDataSetAlgorithm::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| static vtkDataSetAlgorithm* vtkDataSetAlgorithm::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| void vtkDataSetAlgorithm::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 vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkDicer, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
| vtkDataSet* vtkDataSetAlgorithm::GetOutput | ( | ) |
Get the output data object for a port on this algorithm.
Reimplemented in vtkDataObjectToDataSetFilter.
| vtkDataSet* vtkDataSetAlgorithm::GetOutput | ( | int | ) |
Get the output data object for a port on this algorithm.
Reimplemented in vtkDataObjectToDataSetFilter.
| vtkDataObject* vtkDataSetAlgorithm::GetInput | ( | ) |
Get the input data object. This method is not recommended for use, but lots of old style filters use it.
Reimplemented in vtkDataObjectToDataSetFilter.
| vtkPolyData* vtkDataSetAlgorithm::GetPolyDataOutput | ( | ) |
Get the output as vtkPolyData.
Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.
| vtkStructuredPoints* vtkDataSetAlgorithm::GetStructuredPointsOutput | ( | ) |
Get the output as vtkStructuredPoints.
Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.
| vtkImageData* vtkDataSetAlgorithm::GetImageDataOutput | ( | ) |
Get the output as vtkStructuredPoints.
| vtkStructuredGrid* vtkDataSetAlgorithm::GetStructuredGridOutput | ( | ) |
Get the output as vtkStructuredGrid.
Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.
| vtkUnstructuredGrid* vtkDataSetAlgorithm::GetUnstructuredGridOutput | ( | ) |
Get the output as vtkUnstructuredGrid.
Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.
| vtkRectilinearGrid* vtkDataSetAlgorithm::GetRectilinearGridOutput | ( | ) |
Get the output as vtkRectilinearGrid.
Reimplemented in vtkDataObjectToDataSetFilter, and vtkProgrammableSource.
| void vtkDataSetAlgorithm::SetInput | ( | vtkDataObject * | ) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
| void vtkDataSetAlgorithm::SetInput | ( | int | , | |
| vtkDataObject * | ||||
| ) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
| void vtkDataSetAlgorithm::SetInput | ( | vtkDataSet * | ) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
Reimplemented in vtkExtractVectorComponents.
| void vtkDataSetAlgorithm::SetInput | ( | int | , | |
| vtkDataSet * | ||||
| ) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
| void vtkDataSetAlgorithm::AddInput | ( | vtkDataObject * | ) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
| void vtkDataSetAlgorithm::AddInput | ( | vtkDataSet * | ) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
Reimplemented in vtkProgrammableAttributeDataFilter.
| void vtkDataSetAlgorithm::AddInput | ( | int | , | |
| vtkDataSet * | ||||
| ) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
| void vtkDataSetAlgorithm::AddInput | ( | int | , | |
| vtkDataObject * | ||||
| ) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
| 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 * | ||||
| ) | [inline, protected, virtual] |
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 vtkCastToConcrete, vtkDataObjectToDataSetFilter, vtkProbeFilter, vtkProgrammableSource, and vtkPProbeFilter.
Definition at line 126 of file vtkDataSetAlgorithm.h.
| virtual int vtkDataSetAlgorithm::RequestUpdateExtent | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [inline, protected, virtual] |
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, vtkGradientFilter, vtkMergeFilter, vtkProbeFilter, vtkPCellDataToPointData, and vtkPProbeFilter.
Definition at line 136 of file vtkDataSetAlgorithm.h.
| virtual int vtkDataSetAlgorithm::RequestDataObject | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
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, vtkProgrammableSource, and vtkPDataSetReader.
| virtual int vtkDataSetAlgorithm::RequestData | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [inline, protected, virtual] |
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 vtkCastToConcrete, vtkGenericProbeFilter, vtkArrayCalculator, vtkAttributeDataToFieldDataFilter, vtkBrownianPoints, vtkCellDataToPointData, vtkCellDerivatives, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkElevationFilter, vtkExtractTensorComponents, vtkExtractVectorComponents, vtkFieldDataToAttributeDataFilter, vtkGradientFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkIdFilter, vtkImplicitTextureCoords, vtkInterpolateDataSetAttributes, vtkMaskFields, vtkMergeDataObjectFilter, vtkMergeFields, vtkMergeFilter, vtkMeshQuality, vtkOBBDicer, vtkPointDataToCellData, vtkProbeFilter, vtkProgrammableAttributeDataFilter, vtkProgrammableSource, vtkProjectedTexture, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkRandomAttributeGenerator, vtkRearrangeFields, vtkSelectEnclosedPoints, vtkSimpleElevationFilter, vtkSplitField, vtkTextureMapToCylinder, vtkTextureMapToPlane, vtkTextureMapToSphere, vtkThresholdTextureCoords, vtkTransformTextureCoords, vtkVectorDot, vtkVectorNorm, vtkPassThroughFilter, vtkPCellDataToPointData, vtkPDataSetReader, vtkPieceScalars, vtkPProbeFilter, and vtkProcessIdScalars.
Definition at line 163 of file vtkDataSetAlgorithm.h.
| virtual int vtkDataSetAlgorithm::FillOutputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, and vtkQuadratureSchemeDictionaryGenerator.
| virtual int vtkDataSetAlgorithm::FillInputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
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 vtkGenericProbeFilter, vtkCompositeDataProbeFilter, vtkDataObjectToDataSetFilter, vtkHyperOctreeDepth, vtkHyperOctreeLimiter, vtkInterpolateDataSetAttributes, vtkMergeDataObjectFilter, vtkMergeFilter, vtkQuadraturePointInterpolator, vtkQuadraturePointsGenerator, vtkQuadratureSchemeDictionaryGenerator, vtkSelectEnclosedPoints, and vtkPProbeFilter.
| vtkDataObject* vtkDataSetAlgorithm::GetInput | ( | int | port | ) | [protected] |
The documentation for this class was generated from the following file:
- dox/Filtering/vtkDataSetAlgorithm.h
