vtkMergeDataObjectFilter Class Reference

#include <vtkMergeDataObjectFilter.h>

Inheritance diagram for vtkMergeDataObjectFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkMergeDataObjectFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

merge dataset and data object field to create dataset with attribute data

vtkMergeDataObjectFilter is a filter that merges the field from a vtkDataObject with a vtkDataSet. The resulting combined dataset can then be processed by other filters (e.g., vtkFieldDataToAttributeDataFilter) to create attribute data like scalars, vectors, etc.

The filter operates as follows. The field data from the vtkDataObject is merged with the input's vtkDataSet and then placed in the output. You can choose to place the field data into the cell data field, the point data field, or the datasets field (i.e., the one inherited from vtkDataSet's superclass vtkDataObject). All this data shuffling occurs via reference counting, therefore memory is not copied.

One of the uses of this filter is to allow you to read/generate the structure of a dataset independent of the attributes. So, for example, you could store the dataset geometry/topology in one file, and field data in another. Then use this filter in combination with vtkFieldDataToAttributeData to create a dataset ready for processing in the visualization pipeline.

Definition at line 45 of file vtkMergeDataObjectFilter.h.


Public Types

typedef vtkDataSetAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetDataObject (vtkDataObject *object)
vtkDataObjectGetDataObject ()
virtual void SetOutputField (int)
virtual int GetOutputField ()
void SetOutputFieldToDataObjectField ()
void SetOutputFieldToPointDataField ()
void SetOutputFieldToCellDataField ()

Static Public Member Functions

static vtkMergeDataObjectFilterNew ()
static int IsTypeOf (const char *type)
static vtkMergeDataObjectFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkMergeDataObjectFilter ()
 ~vtkMergeDataObjectFilter ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int FillInputPortInformation (int port, vtkInformation *info)

Protected Attributes

int OutputField

Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 49 of file vtkMergeDataObjectFilter.h.


Constructor & Destructor Documentation

vtkMergeDataObjectFilter::vtkMergeDataObjectFilter (  )  [protected]

vtkMergeDataObjectFilter::~vtkMergeDataObjectFilter (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkDataSetAlgorithm.

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

Reimplemented from vtkDataSetAlgorithm.

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

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

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

Reimplemented from vtkDataSetAlgorithm.

void vtkMergeDataObjectFilter::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 vtkDataSetAlgorithm.

void vtkMergeDataObjectFilter::SetDataObject ( vtkDataObject object  ) 

Specify the data object to merge with the input dataset.

vtkDataObject* vtkMergeDataObjectFilter::GetDataObject (  ) 

Specify the data object to merge with the input dataset.

virtual void vtkMergeDataObjectFilter::SetOutputField ( int   )  [virtual]

Specify where to place the field data during the merge process. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

virtual int vtkMergeDataObjectFilter::GetOutputField (  )  [virtual]

Specify where to place the field data during the merge process. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

void vtkMergeDataObjectFilter::SetOutputFieldToDataObjectField (  ) 

Specify where to place the field data during the merge process. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

void vtkMergeDataObjectFilter::SetOutputFieldToPointDataField (  ) 

Specify where to place the field data during the merge process. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

void vtkMergeDataObjectFilter::SetOutputFieldToCellDataField (  ) 

Specify where to place the field data during the merge process. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

int vtkMergeDataObjectFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [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 from vtkDataSetAlgorithm.

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


Member Data Documentation

Definition at line 78 of file vtkMergeDataObjectFilter.h.


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

Generated on Sat Dec 27 13:36:25 2008 for VTK by  doxygen 1.5.6