vtkArrayDataAlgorithm Class Reference

#include <vtkArrayDataAlgorithm.h>

Inheritance diagram for vtkArrayDataAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for vtkArrayDataAlgorithm:

Collaboration graph
[legend]

List of all members.


Detailed Description

Superclass for algorithms that produce vtkArrayDatas as output.

vtkArrayDataAlgorithm 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 class constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be vtkArrayData. 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 ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output) signature. For even older filters that don't implement ExecuteData the default implementation calls the even older Execute() signature.

Thanks:
Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

Definition at line 55 of file vtkArrayDataAlgorithm.h.


Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkArrayDataGetOutput ()
vtkArrayDataGetOutput (int index)
void SetInput (vtkDataObject *obj)
void SetInput (int index, vtkDataObject *obj)

Static Public Member Functions

static vtkArrayDataAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkArrayDataAlgorithmSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkArrayDataAlgorithm ()
 ~vtkArrayDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Member Typedef Documentation


Constructor & Destructor Documentation

vtkArrayDataAlgorithm::vtkArrayDataAlgorithm (  )  [protected]

vtkArrayDataAlgorithm::~vtkArrayDataAlgorithm (  )  [protected]


Member Function Documentation

static vtkArrayDataAlgorithm* vtkArrayDataAlgorithm::New (  )  [static]

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkArrayNorm, vtkDiagonalMatrixSource, vtkConcatenateArray, vtkEntropyMatrixWeighting, vtkExtractSelectedSlices, vtkPointwiseMutualInformation, vtkPowerWeighting, vtkScaleDimension, and vtkUnityMatrixWeighting.

virtual const char* vtkArrayDataAlgorithm::GetClassName (  )  [virtual]

static int vtkArrayDataAlgorithm::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkArrayNorm, vtkDiagonalMatrixSource, vtkConcatenateArray, vtkEntropyMatrixWeighting, vtkExtractSelectedSlices, vtkPointwiseMutualInformation, vtkPowerWeighting, vtkScaleDimension, and vtkUnityMatrixWeighting.

virtual int vtkArrayDataAlgorithm::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkArrayNorm, vtkDiagonalMatrixSource, vtkConcatenateArray, vtkEntropyMatrixWeighting, vtkExtractSelectedSlices, vtkPointwiseMutualInformation, vtkPowerWeighting, vtkScaleDimension, and vtkUnityMatrixWeighting.

static vtkArrayDataAlgorithm* vtkArrayDataAlgorithm::SafeDownCast ( vtkObject o  )  [static]

void vtkArrayDataAlgorithm::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 vtkArrayNorm, vtkDiagonalMatrixSource, vtkConcatenateArray, vtkEntropyMatrixWeighting, vtkExtractSelectedSlices, vtkPointwiseMutualInformation, vtkPowerWeighting, vtkScaleDimension, and vtkUnityMatrixWeighting.

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

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

vtkArrayData* vtkArrayDataAlgorithm::GetOutput (  )  [inline]

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

Definition at line 71 of file vtkArrayDataAlgorithm.h.

vtkArrayData* vtkArrayDataAlgorithm::GetOutput ( int  index  ) 

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

void vtkArrayDataAlgorithm::SetInput ( vtkDataObject obj  )  [inline]

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.

Definition at line 83 of file vtkArrayDataAlgorithm.h.

void vtkArrayDataAlgorithm::SetInput ( int  index,
vtkDataObject obj 
)

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.

virtual int vtkArrayDataAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

virtual int vtkArrayDataAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

This is called by the superclass. This is the method you should override.

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

virtual int vtkArrayDataAlgorithm::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 vtkExtractSelectedSlices, and vtkScaleDimension.


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

Generated on Wed Aug 24 11:28:53 2011 for VTK by  doxygen 1.5.6