vtkExtractTensorComponents Class Reference

#include <vtkExtractTensorComponents.h>

Inheritance diagram for vtkExtractTensorComponents:

Inheritance graph
[legend]
Collaboration diagram for vtkExtractTensorComponents:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

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 scalar extraction mode is set.

Tests:
vtkExtractTensorComponents (Tests)

Definition at line 54 of file vtkExtractTensorComponents.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)
virtual void SetPassTensorsToOutput (int)
virtual int GetPassTensorsToOutput ()
virtual void PassTensorsToOutputOn ()
virtual void PassTensorsToOutputOff ()
virtual void SetExtractScalars (int)
virtual int GetExtractScalars ()
virtual void ExtractScalarsOn ()
virtual void ExtractScalarsOff ()
virtual void SetScalarComponents (int, int)
void SetScalarComponents (int[2])
virtual int * GetScalarComponents ()
virtual void GetScalarComponents (int data[2])
virtual void SetScalarMode (int)
virtual int GetScalarMode ()
void SetScalarModeToComponent ()
void SetScalarModeToEffectiveStress ()
void SetScalarModeToDeterminant ()
void ScalarIsComponent ()
void ScalarIsEffectiveStress ()
void ScalarIsDeterminant ()
virtual void SetExtractVectors (int)
virtual int GetExtractVectors ()
virtual void ExtractVectorsOn ()
virtual void ExtractVectorsOff ()
virtual void SetVectorComponents (int, int, int, int, int, int)
virtual void SetVectorComponents (int[6])
virtual int * GetVectorComponents ()
virtual void GetVectorComponents (int data[6])
virtual void SetExtractNormals (int)
virtual int GetExtractNormals ()
virtual void ExtractNormalsOn ()
virtual void ExtractNormalsOff ()
virtual void SetNormalizeNormals (int)
virtual int GetNormalizeNormals ()
virtual void NormalizeNormalsOn ()
virtual void NormalizeNormalsOff ()
virtual void SetNormalComponents (int, int, int, int, int, int)
virtual void SetNormalComponents (int[6])
virtual int * GetNormalComponents ()
virtual void GetNormalComponents (int data[6])
virtual void SetExtractTCoords (int)
virtual int GetExtractTCoords ()
virtual void ExtractTCoordsOn ()
virtual void ExtractTCoordsOff ()
virtual void SetNumberOfTCoords (int)
virtual int GetNumberOfTCoords ()
virtual void SetTCoordComponents (int, int, int, int, int, int)
virtual void SetTCoordComponents (int[6])
virtual int * GetTCoordComponents ()
virtual void GetTCoordComponents (int data[6])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkExtractTensorComponentsSafeDownCast (vtkObject *o)
static vtkExtractTensorComponentsNew ()

Protected Member Functions

 vtkExtractTensorComponents ()
 ~vtkExtractTensorComponents ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int PassTensorsToOutput
int ExtractScalars
int ExtractVectors
int ExtractNormals
int ExtractTCoords
int ScalarMode
int ScalarComponents [2]
int VectorComponents [6]
int NormalizeNormals
int NormalComponents [6]
int NumberOfTCoords
int TCoordComponents [6]

Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 57 of file vtkExtractTensorComponents.h.


Constructor & Destructor Documentation

vtkExtractTensorComponents::vtkExtractTensorComponents (  )  [protected]

vtkExtractTensorComponents::~vtkExtractTensorComponents (  )  [inline, protected]

Definition at line 166 of file vtkExtractTensorComponents.h.


Member Function Documentation

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

Reimplemented from vtkDataSetAlgorithm.

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

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

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

Reimplemented from vtkDataSetAlgorithm.

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

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

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

Reimplemented from vtkDataSetAlgorithm.

virtual void vtkExtractTensorComponents::SetPassTensorsToOutput ( int   )  [virtual]

Boolean controls whether tensor data is passed through to output.

virtual int vtkExtractTensorComponents::GetPassTensorsToOutput (  )  [virtual]

Boolean controls whether tensor data is passed through to output.

virtual void vtkExtractTensorComponents::PassTensorsToOutputOn (  )  [virtual]

Boolean controls whether tensor data is passed through to output.

virtual void vtkExtractTensorComponents::PassTensorsToOutputOff (  )  [virtual]

Boolean controls whether tensor data is passed through to output.

virtual void vtkExtractTensorComponents::SetExtractScalars ( int   )  [virtual]

Boolean controls whether scalar data is extracted from tensor.

virtual int vtkExtractTensorComponents::GetExtractScalars (  )  [virtual]

Boolean controls whether scalar data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractScalarsOn (  )  [virtual]

Boolean controls whether scalar data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractScalarsOff (  )  [virtual]

Boolean controls whether scalar data is extracted from tensor.

virtual void vtkExtractTensorComponents::SetScalarComponents ( int  ,
int   
) [virtual]

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

void vtkExtractTensorComponents::SetScalarComponents ( int  [2]  ) 

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

virtual int* vtkExtractTensorComponents::GetScalarComponents (  )  [virtual]

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

virtual void vtkExtractTensorComponents::GetScalarComponents ( int  data[2]  )  [virtual]

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

virtual void vtkExtractTensorComponents::SetScalarMode ( int   )  [virtual]

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 component make sure that you set the ScalarComponents ivar.

virtual int vtkExtractTensorComponents::GetScalarMode (  )  [virtual]

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 component make sure that you set the ScalarComponents ivar.

void vtkExtractTensorComponents::SetScalarModeToComponent (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 91 of file vtkExtractTensorComponents.h.

void vtkExtractTensorComponents::SetScalarModeToEffectiveStress (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 93 of file vtkExtractTensorComponents.h.

void vtkExtractTensorComponents::SetScalarModeToDeterminant (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 95 of file vtkExtractTensorComponents.h.

void vtkExtractTensorComponents::ScalarIsComponent (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 97 of file vtkExtractTensorComponents.h.

void vtkExtractTensorComponents::ScalarIsEffectiveStress (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 99 of file vtkExtractTensorComponents.h.

void vtkExtractTensorComponents::ScalarIsDeterminant (  )  [inline]

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 component make sure that you set the ScalarComponents ivar.

Definition at line 101 of file vtkExtractTensorComponents.h.

virtual void vtkExtractTensorComponents::SetExtractVectors ( int   )  [virtual]

Boolean controls whether vector data is extracted from tensor.

virtual int vtkExtractTensorComponents::GetExtractVectors (  )  [virtual]

Boolean controls whether vector data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractVectorsOn (  )  [virtual]

Boolean controls whether vector data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractVectorsOff (  )  [virtual]

Boolean controls whether vector data is extracted from tensor.

virtual void vtkExtractTensorComponents::SetVectorComponents ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

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

virtual void vtkExtractTensorComponents::SetVectorComponents ( int  [6]  )  [virtual]

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

virtual int* vtkExtractTensorComponents::GetVectorComponents (  )  [virtual]

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

virtual void vtkExtractTensorComponents::GetVectorComponents ( int  data[6]  )  [virtual]

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

virtual void vtkExtractTensorComponents::SetExtractNormals ( int   )  [virtual]

Boolean controls whether normal data is extracted from tensor.

virtual int vtkExtractTensorComponents::GetExtractNormals (  )  [virtual]

Boolean controls whether normal data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractNormalsOn (  )  [virtual]

Boolean controls whether normal data is extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractNormalsOff (  )  [virtual]

Boolean controls whether normal data is extracted from tensor.

virtual void vtkExtractTensorComponents::SetNormalizeNormals ( int   )  [virtual]

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

virtual int vtkExtractTensorComponents::GetNormalizeNormals (  )  [virtual]

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

virtual void vtkExtractTensorComponents::NormalizeNormalsOn (  )  [virtual]

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

virtual void vtkExtractTensorComponents::NormalizeNormalsOff (  )  [virtual]

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

virtual void vtkExtractTensorComponents::SetNormalComponents ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

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

virtual void vtkExtractTensorComponents::SetNormalComponents ( int  [6]  )  [virtual]

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

virtual int* vtkExtractTensorComponents::GetNormalComponents (  )  [virtual]

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

virtual void vtkExtractTensorComponents::GetNormalComponents ( int  data[6]  )  [virtual]

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

virtual void vtkExtractTensorComponents::SetExtractTCoords ( int   )  [virtual]

Boolean controls whether texture coordinates are extracted from tensor.

virtual int vtkExtractTensorComponents::GetExtractTCoords (  )  [virtual]

Boolean controls whether texture coordinates are extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractTCoordsOn (  )  [virtual]

Boolean controls whether texture coordinates are extracted from tensor.

virtual void vtkExtractTensorComponents::ExtractTCoordsOff (  )  [virtual]

Boolean controls whether texture coordinates are extracted from tensor.

virtual void vtkExtractTensorComponents::SetNumberOfTCoords ( int   )  [virtual]

Set the dimension of the texture coordinates to extract.

virtual int vtkExtractTensorComponents::GetNumberOfTCoords (  )  [virtual]

Set the dimension of the texture coordinates to extract.

virtual void vtkExtractTensorComponents::SetTCoordComponents ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

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

virtual void vtkExtractTensorComponents::SetTCoordComponents ( int  [6]  )  [virtual]

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

virtual int* vtkExtractTensorComponents::GetTCoordComponents (  )  [virtual]

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

virtual void vtkExtractTensorComponents::GetTCoordComponents ( int  data[6]  )  [virtual]

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

int vtkExtractTensorComponents::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.


Member Data Documentation

Definition at line 170 of file vtkExtractTensorComponents.h.

Definition at line 172 of file vtkExtractTensorComponents.h.

Definition at line 173 of file vtkExtractTensorComponents.h.

Definition at line 174 of file vtkExtractTensorComponents.h.

Definition at line 175 of file vtkExtractTensorComponents.h.

Definition at line 177 of file vtkExtractTensorComponents.h.

Definition at line 178 of file vtkExtractTensorComponents.h.

Definition at line 180 of file vtkExtractTensorComponents.h.

Definition at line 182 of file vtkExtractTensorComponents.h.

Definition at line 183 of file vtkExtractTensorComponents.h.

Definition at line 185 of file vtkExtractTensorComponents.h.

Definition at line 186 of file vtkExtractTensorComponents.h.


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

Generated on Wed Aug 24 11:36:00 2011 for VTK by  doxygen 1.5.6