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

vtkFieldDataToAttributeDataFilter Class Reference

map field data to dataset attribute data. More...

#include <vtkFieldDataToAttributeDataFilter.h>

Inheritance diagram for vtkFieldDataToAttributeDataFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkFieldDataToAttributeDataFilter:

Collaboration graph
[legend]
List of all members.

Public Methods

void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void SetInputField (int)
virtual int GetInputField ()
void SetInputFieldToDataObjectField ()
void SetInputFieldToPointDataField ()
void SetInputFieldToCellDataField ()
virtual void SetOutputAttributeData (int)
virtual int GetOutputAttributeData ()
void SetOutputAttributeDataToCellData ()
void SetOutputAttributeDataToPointData ()
void SetScalarComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetScalarComponent (int comp, const char *arrayName, int arrayComp)
const char * GetScalarComponentArrayName (int comp)
int GetScalarComponentArrayComponent (int comp)
int GetScalarComponentMinRange (int comp)
int GetScalarComponentMaxRange (int comp)
int GetScalarComponentNormalizeFlag (int comp)
void SetVectorComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetVectorComponent (int comp, const char *arrayName, int arrayComp)
const char * GetVectorComponentArrayName (int comp)
int GetVectorComponentArrayComponent (int comp)
int GetVectorComponentMinRange (int comp)
int GetVectorComponentMaxRange (int comp)
int GetVectorComponentNormalizeFlag (int comp)
void SetGhostLevelComponent (const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetGhostLevelComponent (const char *arrayName, int arrayComp)
const char * GetGhostLevelComponentArrayName ()
int GetGhostLevelComponentArrayComponent ()
int GetGhostLevelComponentMinRange ()
int GetGhostLevelComponentMaxRange ()
int GetGhostLevelComponentNormalizeFlag ()
void SetNormalComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetNormalComponent (int comp, const char *arrayName, int arrayComp)
const char * GetNormalComponentArrayName (int comp)
int GetNormalComponentArrayComponent (int comp)
int GetNormalComponentMinRange (int comp)
int GetNormalComponentMaxRange (int comp)
int GetNormalComponentNormalizeFlag (int comp)
void SetTensorComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetTensorComponent (int comp, const char *arrayName, int arrayComp)
const char * GetTensorComponentArrayName (int comp)
int GetTensorComponentArrayComponent (int comp)
int GetTensorComponentMinRange (int comp)
int GetTensorComponentMaxRange (int comp)
int GetTensorComponentNormalizeFlag (int comp)
void SetTCoordComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
void SetTCoordComponent (int comp, const char *arrayName, int arrayComp)
const char * GetTCoordComponentArrayName (int comp)
int GetTCoordComponentArrayComponent (int comp)
int GetTCoordComponentMinRange (int comp)
int GetTCoordComponentMaxRange (int comp)
int GetTCoordComponentNormalizeFlag (int comp)
virtual void SetDefaultNormalize (int)
virtual int GetDefaultNormalize ()
virtual void DefaultNormalizeOn ()
virtual void DefaultNormalizeOff ()

Static Public Methods

int IsTypeOf (const char *type)
vtkFieldDataToAttributeDataFilter * SafeDownCast (vtkObject *o)
vtkFieldDataToAttributeDataFilter * New ()
int GetComponentsType (int numComp, vtkDataArray **arrays)
int ConstructArray (vtkDataArray *da, int comp, vtkDataArray *frray, int fieldComp, int min, int max, int normalize)
vtkDataArrayGetFieldArray (vtkFieldData *fd, char *name, int comp)
void SetArrayName (vtkObject *self, char *&name, const char *newName)
int UpdateComponentRange (vtkDataArray *da, int compRange[2])

Protected Methods

 vtkFieldDataToAttributeDataFilter ()
 ~vtkFieldDataToAttributeDataFilter ()
 vtkFieldDataToAttributeDataFilter (const vtkFieldDataToAttributeDataFilter &)
void operator= (const vtkFieldDataToAttributeDataFilter &)
void Execute ()
void ConstructScalars (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[4][2], char *arrays[4], int arrayComponents[4], int normalize[4], int numComp)
void ConstructVectors (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])
void ConstructGhostLevels (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[2], char *array, int arrayComponent, int normalize)
void ConstructNormals (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])
void ConstructTCoords (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3], int numComp)
void ConstructTensors (int num, vtkFieldData *fd, vtkDataSetAttributes *attr, int componentRange[9][2], char *arrays[9], int arrayComponents[9], int normalize[9])
void ConstructFieldData (int num, vtkDataSetAttributes *attr)

Protected Attributes

int InputField
int OutputAttributeData
int NumberOfScalarComponents
char * ScalarArrays [4]
int ScalarArrayComponents [4]
int ScalarComponentRange [4][2]
int ScalarNormalize [4]
char * VectorArrays [3]
int VectorArrayComponents [3]
int VectorComponentRange [3][2]
int VectorNormalize [3]
char * GhostLevelArray
int GhostLevelArrayComponent
int GhostLevelComponentRange [2]
int GhostLevelNormalize
char * NormalArrays [3]
int NormalArrayComponents [3]
int NormalComponentRange [3][2]
int NormalNormalize [3]
char * TensorArrays [9]
int TensorArrayComponents [9]
int TensorComponentRange [9][2]
int TensorNormalize [9]
int NumberOfTCoordComponents
char * TCoordArrays [3]
int TCoordArrayComponents [3]
int TCoordComponentRange [3][2]
int TCoordNormalize [3]
int DefaultNormalize

Detailed Description

map field data to dataset attribute data.

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

vtkFieldDataToAttributeDataFilter is a class that maps field data into dataset attributes. The input to this filter is any type of dataset and the output is the same dataset (geometry/topology) with new attribute data (attribute data is passed through if not replaced during filter execution).

To use this filter you must specify which field data from the input dataset to use. There are three possibilities: the cell field data, the point field data, or the field data associated with the data object superclass. Then you specify which attribute data to create: either cell attribute data or point attribute data. Finally, you must define how to construct the various attribute data types (e.g., scalars, vectors, normals, etc.) from the arrays and the components of the arrays from the field data. This is done by associating components in the input field with components making up the attribute data. For example, you would specify a scalar with three components (RGB) by assigning components from the field for the R, then G, then B values of the scalars. You may also have to specify component ranges (for each R-G-B) to make sure that the number of R, G, and B values is the same. Also, you may want to normalize the components which helps distribute the data uniformly.

This filter is often used in conjunction with vtkDataObjectToDataSetFilter. vtkDataObjectToDataSetFilter filter generates dataset topology and geometry and passes its input field data along to its output. Then this filter is used to generate the attribute data to go along with the dataset.

Warning:
Make sure that the data you extract is consistent. That is, if you have N points, extract N point attributes (scalars, vectors, etc.).
See also:
vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray
Examples:
vtkFieldDataToAttributeDataFilter (examples)


Member Function Documentation

int vtkFieldDataToAttributeDataFilter::ConstructArray vtkDataArray   da,
int    comp,
vtkDataArray   frray,
int    fieldComp,
int    min,
int    max,
int    normalize
[static]
 

Construct a portion of a data array (the comp portion) from another data array and its component. The variables min and max control the range of the data to use from the other data array; normalize is a flag that when set will normalize the data between (0,1).

virtual const char* vtkFieldDataToAttributeDataFilter::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 vtkDataSetToDataSetFilter.

int vtkFieldDataToAttributeDataFilter::GetComponentsType int    numComp,
vtkDataArray **    arrays
[static]
 

Given an array of names of arrays in field data, return the common type for these arrays. For example, if a vector is constructed of the three type (char,int,float), the return type is float.

vtkDataArray* vtkFieldDataToAttributeDataFilter::GetFieldArray vtkFieldData   fd,
char *    name,
int    comp
[static]
 

Return an array of a particular name from field data and do error checking.

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

int vtkFieldDataToAttributeDataFilter::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 vtkDataSetToDataSetFilter.

vtkFieldDataToAttributeDataFilter* vtkFieldDataToAttributeDataFilter::New   [static]
 

Construct object with input field set to the data object field, and the output attribute data set to generate point data.

Reimplemented from vtkDataSetSource.

void vtkFieldDataToAttributeDataFilter::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.

vtkFieldDataToAttributeDataFilter* vtkFieldDataToAttributeDataFilter::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 vtkDataSetToDataSetFilter.

void vtkFieldDataToAttributeDataFilter::SetArrayName vtkObject   self,
char *&    name,
const char *    newName
[static]
 

Specify an array name for one of the components.

virtual void vtkFieldDataToAttributeDataFilter::SetDefaultNormalize int    [virtual]
 

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

void vtkFieldDataToAttributeDataFilter::SetGhostLevelComponent const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the component of the field to be used for the ghost level component. Because there is only one component, we are not using the comp parameter. To define the field component to use you 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.

virtual void vtkFieldDataToAttributeDataFilter::SetInputField int    [virtual]
 

Specify which field data to use to generate the output attribute data. There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

void vtkFieldDataToAttributeDataFilter::SetNormalComponent int    comp,
const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the component(s) of the field to be used for the normal components. Note that the parameter comp must lie between (0,3). To define the field component to use you 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.

virtual void vtkFieldDataToAttributeDataFilter::SetOutputAttributeData int    [virtual]
 

Specify which attribute data to output: point or cell data attributes.

void vtkFieldDataToAttributeDataFilter::SetScalarComponent int    comp,
const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the component(s) of the field to be used for the scalar components. Note that the parameter comp must lie between (0,4). To define the field component to use you 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.

void vtkFieldDataToAttributeDataFilter::SetTCoordComponent int    comp,
const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the components of the field to be used for the cell texture coord components. Note that the parameter comp must lie between (0,9). To define the field component to use you 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.

void vtkFieldDataToAttributeDataFilter::SetTensorComponent int    comp,
const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the components of the field to be used for the tensor components. Note that the parameter comp must lie between (0,9). To define the field component to use you 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.

void vtkFieldDataToAttributeDataFilter::SetVectorComponent int    comp,
const char *    arrayName,
int    arrayComp,
int    min,
int    max,
int    normalize
 

Define the component(s) of the field to be used for the vector components. Note that the parameter comp must lie between (0,3). To define the field component to use you 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.

int vtkFieldDataToAttributeDataFilter::UpdateComponentRange vtkDataArray   da,
int    compRange[2]
[static]
 

Update the maximum and minimum component range values. Returns a flag indicating whether the range was updated.


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