VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkTableAlgorithm Class Reference

Superclass for algorithms that produce only vtkTables as output. More...

#include <vtkTableAlgorithm.h>

Inheritance diagram for vtkTableAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for vtkTableAlgorithm:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkTableAlgorithmNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTableGetOutput ()
vtkTableGetOutput (int index)
void SetInputData (vtkDataObject *obj)
void SetInputData (int index, vtkDataObject *obj)

Static Public Member Functions

static vtkTableAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkTableAlgorithm ()
 ~vtkTableAlgorithm ()
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 *)

Detailed Description

Superclass for algorithms that produce only vtkTables as output.

vtkTableAlgorithm 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 Tree. If that isn't the case then please override this method in your subclass.

Thanks:
Thanks to Brian Wylie for creating this class.

Definition at line 47 of file vtkTableAlgorithm.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

static int vtkTableAlgorithm::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 vtkKMeansStatistics, vtkDelimitedTextReader, vtkMultiCorrelativeStatistics, vtkStatisticsAlgorithm, vtkDotProductSimilarity, vtkRRandomTableSource, vtkBoostSplitTableField, vtkDescriptiveStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkOrderStatistics, vtkExtractHistogram2D, vtkPCAStatistics, vtkFixedWidthTextReader, vtkPairwiseExtractHistogram2D, vtkPOrderStatistics, vtkPContingencyStatistics, vtkPCAStatisticsGnuR, vtkAutoCorrelativeStatistics, vtkPPairwiseExtractHistogram2D, vtkBivariateLinearTableThreshold, vtkContingencyStatisticsGnuR, vtkCorrelativeStatisticsGnuR, vtkRISReader, vtkRowQueryToTable, vtkDescriptiveStatisticsGnuR, vtkSparseArrayToTable, vtkISIReader, vtkPExtractHistogram2D, vtkMergeColumns, vtkMergeTables, vtkStreamingStatistics, vtkExtractTemporalFieldData, vtkTableFFT, vtkAdjacencyMatrixToEdgeTable, vtkSQLDatabaseTableSource, vtkPCorrelativeStatistics, vtkPDescriptiveStatistics, vtkPMultiCorrelativeStatistics, vtkPPCAStatistics, vtkThresholdTable, vtkPKMeansStatistics, vtkDataObjectToTable, vtkSplitColumnComponents, vtkArrayToTable, vtkExtractSelectedRows, vtkPAutoCorrelativeStatistics, vtkPBivariateLinearTableThreshold, vtkCollectTable, vtkMySQLToTableReader, vtkPostgreSQLToTableReader, vtkSQLiteToTableReader, and vtkDatabaseToTableReader.

virtual int vtkTableAlgorithm::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 vtkKMeansStatistics, vtkDelimitedTextReader, vtkMultiCorrelativeStatistics, vtkStatisticsAlgorithm, vtkDotProductSimilarity, vtkRRandomTableSource, vtkBoostSplitTableField, vtkDescriptiveStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkOrderStatistics, vtkExtractHistogram2D, vtkPCAStatistics, vtkFixedWidthTextReader, vtkPairwiseExtractHistogram2D, vtkPOrderStatistics, vtkPContingencyStatistics, vtkPCAStatisticsGnuR, vtkAutoCorrelativeStatistics, vtkPPairwiseExtractHistogram2D, vtkBivariateLinearTableThreshold, vtkContingencyStatisticsGnuR, vtkCorrelativeStatisticsGnuR, vtkRISReader, vtkRowQueryToTable, vtkDescriptiveStatisticsGnuR, vtkSparseArrayToTable, vtkISIReader, vtkPExtractHistogram2D, vtkMergeColumns, vtkMergeTables, vtkStreamingStatistics, vtkExtractTemporalFieldData, vtkTableFFT, vtkAdjacencyMatrixToEdgeTable, vtkSQLDatabaseTableSource, vtkPCorrelativeStatistics, vtkPDescriptiveStatistics, vtkPMultiCorrelativeStatistics, vtkPPCAStatistics, vtkThresholdTable, vtkPKMeansStatistics, vtkDataObjectToTable, vtkSplitColumnComponents, vtkArrayToTable, vtkExtractSelectedRows, vtkPAutoCorrelativeStatistics, vtkPBivariateLinearTableThreshold, vtkCollectTable, vtkMySQLToTableReader, vtkPostgreSQLToTableReader, vtkSQLiteToTableReader, and vtkDatabaseToTableReader.

virtual vtkObjectBase* vtkTableAlgorithm::NewInstanceInternal ( ) const [protected, virtual]
void vtkTableAlgorithm::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 vtkKMeansStatistics, vtkDelimitedTextReader, vtkMultiCorrelativeStatistics, vtkStatisticsAlgorithm, vtkDotProductSimilarity, vtkRRandomTableSource, vtkBoostSplitTableField, vtkDescriptiveStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkOrderStatistics, vtkExtractHistogram2D, vtkPCAStatistics, vtkFixedWidthTextReader, vtkPairwiseExtractHistogram2D, vtkPOrderStatistics, vtkPContingencyStatistics, vtkPCAStatisticsGnuR, vtkAutoCorrelativeStatistics, vtkPPairwiseExtractHistogram2D, vtkBivariateLinearTableThreshold, vtkContingencyStatisticsGnuR, vtkCorrelativeStatisticsGnuR, vtkRISReader, vtkRowQueryToTable, vtkDescriptiveStatisticsGnuR, vtkSparseArrayToTable, vtkISIReader, vtkPExtractHistogram2D, vtkMergeColumns, vtkMergeTables, vtkStreamingStatistics, vtkTableFFT, vtkExtractTemporalFieldData, vtkAdjacencyMatrixToEdgeTable, vtkSQLDatabaseTableSource, vtkPCorrelativeStatistics, vtkPDescriptiveStatistics, vtkPMultiCorrelativeStatistics, vtkPPCAStatistics, vtkThresholdTable, vtkPKMeansStatistics, vtkDataObjectToTable, vtkSplitColumnComponents, vtkArrayToTable, vtkExtractSelectedRows, vtkPAutoCorrelativeStatistics, vtkPBivariateLinearTableThreshold, vtkCollectTable, vtkMySQLToTableReader, vtkPostgreSQLToTableReader, vtkSQLiteToTableReader, and vtkDatabaseToTableReader.

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

Reimplemented in vtkExtractTemporalFieldData.

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

Definition at line 63 of file vtkTableAlgorithm.h.

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

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

Definition at line 71 of file vtkTableAlgorithm.h.

void vtkTableAlgorithm::SetInputData ( int  index,
vtkDataObject obj 
)

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

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

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

Reimplemented in vtkCollectTable.

virtual int vtkTableAlgorithm::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 vtkStatisticsAlgorithm, vtkExtractHistogram2D, vtkPairwiseExtractHistogram2D, vtkBivariateLinearTableThreshold, and vtkStreamingStatistics.

virtual int vtkTableAlgorithm::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 vtkStatisticsAlgorithm, vtkPCAStatistics, vtkBivariateLinearTableThreshold, vtkDotProductSimilarity, vtkStreamingStatistics, vtkAdjacencyMatrixToEdgeTable, vtkExtractTemporalFieldData, vtkDataObjectToTable, vtkSparseArrayToTable, vtkExtractSelectedRows, and vtkArrayToTable.


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