Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkDataObjectToDataSetFilter Class Reference

map field data to concrete dataset. More...

#include <vtkDataObjectToDataSetFilter.h>

Inheritance diagram for vtkDataObjectToDataSetFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkDataObjectToDataSetFilter:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetInput (vtkDataObject *input)
vtkDataObjectGetInput ()
void SetDataSetType (int)
virtual int GetDataSetType ()
void SetDataSetTypeToPolyData ()
void SetDataSetTypeToStructuredPoints ()
void SetDataSetTypeToStructuredGrid ()
void SetDataSetTypeToRectilinearGrid ()
void SetDataSetTypeToUnstructuredGrid ()
vtkDataSetGetOutput ()
vtkDataSetGetOutput (int idx)
vtkPolyDataGetPolyDataOutput ()
vtkStructuredPointsGetStructuredPointsOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
void SetPointComponent (int comp, char *arrayName, int arrayComp, int min, int max, int normalize)
void SetPointComponent (int comp, char *arrayName, int arrayComp)
const char * GetPointComponentArrayName (int comp)
int GetPointComponentArrayComponent (int comp)
int GetPointComponentMinRange (int comp)
int GetPointComponentMaxRange (int comp)
int GetPointComponentNormailzeFlag (int comp)
void SetVertsComponent (char *arrayName, int arrayComp, int min, int max)
void SetVertsComponent (char *arrayName, int arrayComp)
const char * GetVertsComponentArrayName ()
int GetVertsComponentArrayComponent ()
int GetVertsComponentMinRange ()
int GetVertsComponentMaxRange ()
void SetLinesComponent (char *arrayName, int arrayComp, int min, int max)
void SetLinesComponent (char *arrayName, int arrayComp)
const char * GetLinesComponentArrayName ()
int GetLinesComponentArrayComponent ()
int GetLinesComponentMinRange ()
int GetLinesComponentMaxRange ()
void SetPolysComponent (char *arrayName, int arrayComp, int min, int max)
void SetPolysComponent (char *arrayName, int arrayComp)
const char * GetPolysComponentArrayName ()
int GetPolysComponentArrayComponent ()
int GetPolysComponentMinRange ()
int GetPolysComponentMaxRange ()
void SetStripsComponent (char *arrayName, int arrayComp, int min, int max)
void SetStripsComponent (char *arrayName, int arrayComp)
const char * GetStripsComponentArrayName ()
int GetStripsComponentArrayComponent ()
int GetStripsComponentMinRange ()
int GetStripsComponentMaxRange ()
void SetCellTypeComponent (char *arrayName, int arrayComp, int min, int max)
void SetCellTypeComponent (char *arrayName, int arrayComp)
const char * GetCellTypeComponentArrayName ()
int GetCellTypeComponentArrayComponent ()
int GetCellTypeComponentMinRange ()
int GetCellTypeComponentMaxRange ()
void SetCellConnectivityComponent (char *arrayName, int arrayComp, int min, int max)
void SetCellConnectivityComponent (char *arrayName, int arrayComp)
const char * GetCellConnectivityComponentArrayName ()
int GetCellConnectivityComponentArrayComponent ()
int GetCellConnectivityComponentMinRange ()
int GetCellConnectivityComponentMaxRange ()
virtual void SetDefaultNormalize (int)
virtual int GetDefaultNormalize ()
virtual void DefaultNormalizeOn ()
virtual void DefaultNormalizeOff ()
virtual void SetDimensions (int, int, int)
virtual void SetDimensions (int[3])
virtual int * GetDimensions ()
virtual void GetDimensions (int data[3])
virtual void SetOrigin (float, float, float)
virtual void SetOrigin (float[3])
virtual float * GetOrigin ()
virtual void GetOrigin (float data[3])
virtual void SetSpacing (float, float, float)
virtual void SetSpacing (float[3])
virtual float * GetSpacing ()
virtual void GetSpacing (float data[3])
void SetDimensionsComponent (char *arrayName, int arrayComp, int min, int max)
void SetDimensionsComponent (char *arrayName, int arrayComp)
void SetSpacingComponent (char *arrayName, int arrayComp, int min, int max)
void SetSpacingComponent (char *arrayName, int arrayComp)
void SetOriginComponent (char *arrayName, int arrayComp, int min, int max)
void SetOriginComponent (char *arrayName, int arrayComp)

Static Public Methods

vtkDataObjectToDataSetFilter * New ()
int IsTypeOf (const char *type)
vtkDataObjectToDataSetFilter * SafeDownCast (vtkObject *o)

Protected Methods

 vtkDataObjectToDataSetFilter ()
 ~vtkDataObjectToDataSetFilter ()
 vtkDataObjectToDataSetFilter (const vtkDataObjectToDataSetFilter &)
void operator= (const vtkDataObjectToDataSetFilter &)
void Execute ()
void ExecuteInformation ()
void ComputeInputUpdateExtents (vtkDataObject *output)
void SetArrayName (char *&name, char *newName)
int ConstructPoints (vtkPointSet *ps)
int ConstructPoints (vtkRectilinearGrid *rg)
int ConstructCells (vtkPolyData *pd)
int ConstructCells (vtkUnstructuredGrid *ug)
vtkCellArrayConstructCellArray (vtkDataArray *da, int comp, int compRange[2])
void ConstructDimensions ()
void ConstructSpacing ()
void ConstructOrigin ()

Protected Attributes

char Updating
int DataSetType
char * PointArrays [3]
int PointArrayComponents [3]
int PointComponentRange [3][2]
int PointNormalize [3]
char * VertsArray
int VertsArrayComponent
int VertsComponentRange [2]
char * LinesArray
int LinesArrayComponent
int LinesComponentRange [2]
char * PolysArray
int PolysArrayComponent
int PolysComponentRange [2]
char * StripsArray
int StripsArrayComponent
int StripsComponentRange [2]
char * CellTypeArray
int CellTypeArrayComponent
int CellTypeComponentRange [2]
char * CellConnectivityArray
int CellConnectivityArrayComponent
int CellConnectivityComponentRange [2]
int DefaultNormalize
int Dimensions [3]
float Origin [3]
float Spacing [3]
char * DimensionsArray
int DimensionsArrayComponent
int DimensionsComponentRange [2]
char * OriginArray
int OriginArrayComponent
int OriginComponentRange [2]
char * SpacingArray
int SpacingArrayComponent
int SpacingComponentRange [2]

Detailed Description

map field data to concrete dataset.

Date:
2000/12/10 20:08:33
Revision:
1.17

vtkDataObjectToDataSetFilter is an class that maps a data object (i.e., a field) into a concrete dataset, i.e., gives structure to the field by defining a geometry and topology.

To use this filter you associate components in the input field data with portions of the output dataset. (A component is an array of values from the field.) For example, you would specify x-y-z points by assigning components from the field for the x, then y, then z values of the points. You may also have to specify component ranges (for each z-y-z) to make sure that the number of x, y, and z values is the same. Also, you may want to normalize the components which helps distribute the data uniformly. Once you've setup the filter to combine all the pieces of data into a specified dataset (the geometry, topology, point and cell data attributes), the various output methods (e.g., GetPolyData()) are used to retrieve the final product.

This filter is often used in conjunction with vtkFieldDataToAttributeDataFilter. vtkFieldDataToAttributeDataFilter takes field data and transforms it into attribute data (e.g., point and cell data attributes such as scalars and vectors). To do this, use this filter which constructs a concrete dataset and passes the input data object field data to its output. and then use vtkFieldDataToAttributeDataFilter to generate the attribute data associated with the dataset.

Warning:
Make sure that the data you extract is consistent. That is, if you have N points, extract N x, y, and z components. Also, all the information necessary to define a dataset must be given. For example, vtkPolyData requires points at a minimum; vtkStructuredPoints requires setting the dimensions; vtkStructuredGrid requires defining points and dimensions; vtkUnstructuredGrid requires setting points; and vtkRectilinearGrid requires that you define the x, y, and z-coordinate arrays (by specifying points) as well as the dimensions.
Warning:
If you wish to create a dataset of just points (i.e., unstructured points dataset), create vtkPolyData consisting of points. There will be no cells in such a dataset.
See also:
vtkDataObject vtkFieldData vtkDataSet vtkPolyData vtkStructuredPoints vtkStructuredGrid vtkUnstructuredGrid vtkRectilinearGrid vtkDataSetAttributes vtkScalars vtkDataArray
Examples:
vtkDataObjectToDataSetFilter (examples)


Member Function Documentation

void vtkDataObjectToDataSetFilter::ComputeInputUpdateExtents vtkDataObject   output [protected, virtual]
 

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses.

Reimplemented from vtkSource.

virtual const char* vtkDataObjectToDataSetFilter::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSource.

vtkDataSet* vtkDataObjectToDataSetFilter::GetOutput  
 

Get the output in different forms. The particular method invoked should be consistent with the SetDataSetType() method. (Note: GetOutput() will always return a type consistent with SetDataSetType(). Also, GetOutput() will return NULL if the filter aborted due to inconsistent data.)

virtual int vtkDataObjectToDataSetFilter::IsA const char *    type [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 vtkSource.

int vtkDataObjectToDataSetFilter::IsTypeOf const char *    type [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 vtkSource.

vtkDataObjectToDataSetFilter* vtkDataObjectToDataSetFilter::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkSource.

void vtkDataObjectToDataSetFilter::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 vtkSource.

vtkDataObjectToDataSetFilter* vtkDataObjectToDataSetFilter::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSource.

void vtkDataObjectToDataSetFilter::SetCellTypeComponent char *    arrayName,
int    arrayComp,
int    min,
int    max
 

Define cell types and cell connectivity when creating unstructured grid data. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you need to define an array of cell types (an integer value per cell), and another array consisting (for each cell) of a number of points per cell, and then the cell connectivity. (This is the vtk file format described in in the textbook or User's Guide.)

void vtkDataObjectToDataSetFilter::SetDataSetType int   
 

Control what type of data is generated for output.

virtual void vtkDataObjectToDataSetFilter::SetDefaultNormalize int    [virtual]
 

Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetPointComponent).

virtual void vtkDataObjectToDataSetFilter::SetDimensions int   ,
int   ,
int   
[virtual]
 

Specify the dimensions to use if generating a dataset that requires dimensions specification (vtkStructuredPoints, vtkStructuredGrid, vtkRectilinearGrid).

void vtkDataObjectToDataSetFilter::SetDimensionsComponent char *    arrayName,
int    arrayComp,
int    min,
int    max
 

Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this information. You need to specify the name of an array; the component of the array, and the range of the array (min,max). These methods will override the information given by the previous methods.

void vtkDataObjectToDataSetFilter::SetInput vtkDataObject   input
 

Set the input to the filter.

virtual void vtkDataObjectToDataSetFilter::SetOrigin float   ,
float   ,
float   
[virtual]
 

Specify the origin to use if generating a dataset whose origin can be set (i.e., a vtkStructuredPoints dataset).

void vtkDataObjectToDataSetFilter::SetPointComponent int    comp,
char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the component of the field to be used for the x, y, and z values of the points. Note that the parameter comp must lie between (0,2) and refers to the x-y-z (i.e., 0,1,2) components of the points. To define the field component to use you can specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract. (This method should be used for vtkPolyData, vtkUnstructuredGrid, vtkStructuredGrid, and vtkRectilinearGrid.) A convenience method, SetPointComponent(),is also provided which does not require setting the (min,max) component range or the normalize flag (normalize is set to DefaulatNormalize value).

virtual void vtkDataObjectToDataSetFilter::SetSpacing float   ,
float   ,
float   
[virtual]
 

Specify the spacing to use if generating a dataset whose spacing can be set (i.e., a vtkStructuredPoints dataset).

void vtkDataObjectToDataSetFilter::SetVertsComponent char *    arrayName,
int    arrayComp,
int    min,
int    max
 

Define cell connectivity when creating vtkPolyData. You can define vertices, lines, polygons, and/or triangle strips via these methods. These methods are similar to those for defining points, except that no normalization of the data is possible. Basically, you need to define an array of values that (for each cell) includes the number of points per cell, and then the cell connectivity. (This is the vtk file format described in in the textbook or User's Guide.)


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:24:37 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002