Documentation for vtkExtractTensorComponents

vtkExtractTensorComponents - extract parts of tensor and create a scalar, vector, normal, or texture coordinates.

Super Class: vtkDataSetToDataSetFilter

Description:

vtkExtractTensorComponents is a filter that extracts components of a tensor to create a scalar, vector, normal, or texture coords. For example, if the tensor contains components of stress, then you could extract the normal stress in the x-direction as a scalar (i.e., tensor component (0,0). To use this filter, you must set some boolean flags to control which data is extracted from the tensors, and whether you want to pass the tensor data through to the output. Also, you must specify the tensor component(s) for each type of data you want to extract. The tensor component(s) is(are) specified using matrix notation into a 3x3 matrix. That is, use the (row,column) address to specify a particular tensor component; and if the data you are extracting requires more than one component, use a list of addresses. (Note that the addresses are 0-offset -> (0,0) specifies upper left corner of the tensor.) There are two optional methods to extract scalar data. You can extract the determinant of the tensor, or you can extract the effective stress of the tensor. These require that the ivar ExtractScalars is on, and the appropriate scalr extraction mode is set.

 

Methods:

void vtkExtractTensorComponents ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkExtractTensorComponents *New ()
void SetPassTensorsToOutput (int )
int GetPassTensorsToOutput ()
void PassTensorsToOutputOn ()
void PassTensorsToOutputOff ()
void SetExtractScalars (int )
int GetExtractScalars ()
void ExtractScalarsOn ()
void ExtractScalarsOff ()
void SetScalarComponents (int ,int )
void SetScalarComponents (int *)
int *GetScalarComponents ()
void SetScalarMode (int )
int GetScalarMode ()
void ScalarIsComponent ()
void ScalarIsEffectiveStress ()
void ScalarIsDeterminant ()
void SetExtractVectors (int )
int GetExtractVectors ()
void ExtractVectorsOn ()
void ExtractVectorsOff ()
void SetVectorComponents (int ,int ,int ,int ,int ,int )
void SetVectorComponents (int *)
int *GetVectorComponents ()
void SetExtractNormals (int )
int GetExtractNormals ()
void ExtractNormalsOn ()
void ExtractNormalsOff ()
void SetNormalizeNormals (int )
int GetNormalizeNormals ()
void NormalizeNormalsOn ()
void NormalizeNormalsOff ()
void SetNormalComponents (int ,int ,int ,int ,int ,int )
void SetNormalComponents (int *)
int *GetNormalComponents ()
void SetExtractTCoords (int )
int GetExtractTCoords ()
void ExtractTCoordsOn ()
void ExtractTCoordsOff ()
void SetNumberOfTCoords (int )
int GetNumberOfTCoords ()
void SetTCoordComponents (int ,int ,int ,int ,int ,int )
void SetTCoordComponents (int *)
int *GetTCoordComponents ()
void Execute ()

 

Detailed Method Descriptions:

Construct object to extract nothing and to not pass tensor data through the pipeline.

static vtkExtractTensorComponents *New ()

Boolean controls whether tensor data is passed through to output.

void SetPassTensorsToOutput (int )
int GetPassTensorsToOutput ()
void PassTensorsToOutputOn ()
void PassTensorsToOutputOff ()

Boolean controls whether scalar data is extracted from tensor.

void SetExtractScalars (int )
int GetExtractScalars ()
void ExtractScalarsOn ()
void ExtractScalarsOff ()

Specify the (row,column) tensor component to extract as a scalar.

void SetScalarComponents (int ,int )
void SetScalarComponents (int *)
int *GetScalarComponents ()

Specify how to extract the scalar. You can extract it as one of the components of the tensor, as effective stress, or as the determinant of the tensor. If you extract a copmponent make sure that you set the ScalarComponents ivar.

void SetScalarMode (int )
int GetScalarMode ()
void ScalarIsComponent ()
void ScalarIsEffectiveStress ()
void ScalarIsDeterminant ()

Boolean controls whether vector data is extracted from tensor.

void SetExtractVectors (int )
int GetExtractVectors ()
void ExtractVectorsOn ()
void ExtractVectorsOff ()

Specify the ((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector.

void SetVectorComponents (int ,int ,int ,int ,int ,int )
void SetVectorComponents (int *)
int *GetVectorComponents ()

Boolean controls whether normal data is extracted from tensor.

void SetExtractNormals (int )
int GetExtractNormals ()
void ExtractNormalsOn ()
void ExtractNormalsOff ()

Boolean controls whether normal vector is converted to unit normal after extraction.

void SetNormalizeNormals (int )
int GetNormalizeNormals ()
void NormalizeNormalsOn ()
void NormalizeNormalsOff ()

Specify the ((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector.

void SetNormalComponents (int ,int ,int ,int ,int ,int )
void SetNormalComponents (int *)
int *GetNormalComponents ()

Boolean controls whether texture coordinates are extracted from tensor.

void SetExtractTCoords (int )
int GetExtractTCoords ()
void ExtractTCoordsOn ()
void ExtractTCoordsOff ()

Set the dimension of the texture coordinates to extract.

void SetNumberOfTCoords (int )
int GetNumberOfTCoords ()

Specify the ((row,column)0,(row,column)1,(row,column)2) tensor components to extract as a vector. Up to NumberOfTCoords components are extracted.

void SetTCoordComponents (int ,int ,int ,int ,int ,int )
void SetTCoordComponents (int *)
int *GetTCoordComponents ()