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

vtkTensorGlyph Class Reference

scale and orient glyph according to tensor eigenvalues and eigenvectors. More...

#include <vtkTensorGlyph.h>

Inheritance diagram for vtkTensorGlyph:

Inheritance graph
[legend]
Collaboration diagram for vtkTensorGlyph:

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 SetSource (vtkPolyData *source)
vtkPolyDataGetSource ()
virtual void SetScaling (int)
virtual int GetScaling ()
virtual void ScalingOn ()
virtual void ScalingOff ()
virtual void SetScaleFactor (float)
virtual float GetScaleFactor ()
virtual void SetExtractEigenvalues (int)
virtual void ExtractEigenvaluesOn ()
virtual void ExtractEigenvaluesOff ()
virtual int GetExtractEigenvalues ()
virtual void SetColorGlyphs (int)
virtual int GetColorGlyphs ()
virtual void ColorGlyphsOn ()
virtual void ColorGlyphsOff ()
virtual void SetClampScaling (int)
virtual int GetClampScaling ()
virtual void ClampScalingOn ()
virtual void ClampScalingOff ()
virtual void SetMaxScaleFactor (float)
virtual float GetMaxScaleFactor ()

Static Public Methods

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

Protected Methods

 vtkTensorGlyph ()
 ~vtkTensorGlyph ()
 vtkTensorGlyph (const vtkTensorGlyph &)
void operator= (const vtkTensorGlyph &)
void Execute ()

Protected Attributes

int Scaling
float ScaleFactor
int ExtractEigenvalues
int ColorGlyphs
int ClampScaling
float MaxScaleFactor

Detailed Description

scale and orient glyph according to tensor eigenvalues and eigenvectors.

Date:
2000/12/10 20:08:55
Revision:
1.33

vtkTensorGlyph is a filter that copies a geometric representation (specified as polygonal data) to every input point. The geometric representation, or glyph, can be scaled and/or rotated according to the tensor at the input point. Scaling and rotation is controlled by the eigenvalues/eigenvectors of the tensor as follows. For each tensor, the eigenvalues (and associated eigenvectors) are sorted to determine the major, medium, and minor eigenvalues/eigenvectors. The major eigenvalue scales the glyph in the x-direction, the medium in the y-direction, and the minor in the z-direction. Then, the glyph is rotated so that the glyph's local x-axis lies along the major eigenvector, y-axis along the medium eigenvector, and z-axis along the minor.

A scale factor is provided to control the amount of scaling. Also, you can turn off scaling completely if desired. The boolean variable ClampScaling controls the maximum scaling (in conjunction with MaxScaleFactor.) This is useful in certain applications where singularities or large order of magnitude differences exist in the eigenvalues.

Another instance variable, ExtractEigenvalues, has been provided to control extraction of eigenvalues/eigenvectors. If this boolean is false, then eigenvalues/eigenvectors are not extracted, and the columns of the tensor are taken as the eigenvectors (norm of column is eigenvalue). This allows additional capability over the vtkGlyph3D object. That is, the glyph can be oriented in three directions instead of one.

See also:
vtkGlyph3D vtkPointLoad vtkHyperStreamline
Examples:
vtkTensorGlyph (examples)

Definition at line 83 of file vtkTensorGlyph.h.


Constructor & Destructor Documentation

vtkTensorGlyph::vtkTensorGlyph   [protected]
 

vtkTensorGlyph::~vtkTensorGlyph   [protected]
 

vtkTensorGlyph::vtkTensorGlyph const vtkTensorGlyph &    [inline, protected]
 

Definition at line 137 of file vtkTensorGlyph.h.


Member Function Documentation

virtual const char* vtkTensorGlyph::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 vtkDataSetToPolyDataFilter.

int vtkTensorGlyph::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 vtkDataSetToPolyDataFilter.

virtual int vtkTensorGlyph::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 vtkDataSetToPolyDataFilter.

vtkTensorGlyph* vtkTensorGlyph::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 vtkDataSetToPolyDataFilter.

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

vtkTensorGlyph* vtkTensorGlyph::New   [static]
 

Construct object with scaling on and scale factor 1.0. Eigenvalues are extracted, glyphs are colored with input scalar data, and logarithmic scaling is turned off.

Reimplemented from vtkPolyDataSource.

void vtkTensorGlyph::SetSource vtkPolyData   source
 

Specify the geometry to copy to each point.

vtkPolyData* vtkTensorGlyph::GetSource  
 

virtual void vtkTensorGlyph::SetScaling int    [virtual]
 

Turn on/off scaling of glyph with eigenvalues.

virtual int vtkTensorGlyph::GetScaling   [virtual]
 

virtual void vtkTensorGlyph::ScalingOn   [virtual]
 

virtual void vtkTensorGlyph::ScalingOff   [virtual]
 

virtual void vtkTensorGlyph::SetScaleFactor float    [virtual]
 

Specify scale factor to scale object by. (Scale factor always affects output even if scaling is off.)

virtual float vtkTensorGlyph::GetScaleFactor   [virtual]
 

virtual void vtkTensorGlyph::SetExtractEigenvalues int    [virtual]
 

Turn on/off extraction of eigenvalues from tensor.

virtual void vtkTensorGlyph::ExtractEigenvaluesOn   [virtual]
 

virtual void vtkTensorGlyph::ExtractEigenvaluesOff   [virtual]
 

virtual int vtkTensorGlyph::GetExtractEigenvalues   [virtual]
 

virtual void vtkTensorGlyph::SetColorGlyphs int    [virtual]
 

Turn on/off coloring of glyph with input scalar data. If false, or input scalar data not present, then the scalars from the source object are passed through the filter.

virtual int vtkTensorGlyph::GetColorGlyphs   [virtual]
 

virtual void vtkTensorGlyph::ColorGlyphsOn   [virtual]
 

virtual void vtkTensorGlyph::ColorGlyphsOff   [virtual]
 

virtual void vtkTensorGlyph::SetClampScaling int    [virtual]
 

Turn on/off scalar clamping. If scalar clamping is on, the ivar MaxScaleFactor is used to control the maximum scale factor. (This is useful to prevent uncontrolled scaling near singularities.)

virtual int vtkTensorGlyph::GetClampScaling   [virtual]
 

virtual void vtkTensorGlyph::ClampScalingOn   [virtual]
 

virtual void vtkTensorGlyph::ClampScalingOff   [virtual]
 

virtual void vtkTensorGlyph::SetMaxScaleFactor float    [virtual]
 

Set/Get the maximum allowable scale factor. This value is compared to the combination of the scale factor times the eigenvalue. If less, the scale factor is reset to the MaxScaleFactor. The boolean ClampScaling has to be "on" for this to work.

virtual float vtkTensorGlyph::GetMaxScaleFactor   [virtual]
 

void vtkTensorGlyph::operator= const vtkTensorGlyph &    [inline, protected]
 

Definition at line 138 of file vtkTensorGlyph.h.

void vtkTensorGlyph::Execute   [protected, virtual]
 

Reimplemented from vtkSource.


Member Data Documentation

int vtkTensorGlyph::Scaling [protected]
 

Definition at line 142 of file vtkTensorGlyph.h.

float vtkTensorGlyph::ScaleFactor [protected]
 

Definition at line 143 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ExtractEigenvalues [protected]
 

Definition at line 144 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ColorGlyphs [protected]
 

Definition at line 145 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ClampScaling [protected]
 

Definition at line 146 of file vtkTensorGlyph.h.

float vtkTensorGlyph::MaxScaleFactor [protected]
 

Definition at line 147 of file vtkTensorGlyph.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 13:00:45 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001