VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTensorGlyph Class Reference

scale and orient glyph(s) according to tensor eigenvalues and eigenvectors More...

#include <vtkTensorGlyph.h>

Inherits vtkPolyDataAlgorithm.

Public Types

enum  { COLOR_BY_SCALARS, COLOR_BY_EIGENVALUES }
 
typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTensorGlyphNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSourceData (vtkPolyData *source)
 
vtkPolyData * GetSource ()
 
void SetSourceConnection (int id, vtkAlgorithmOutput *algOutput)
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetScaling (int)
 
virtual int GetScaling ()
 
virtual void ScalingOn ()
 
virtual void ScalingOff ()
 
virtual void SetScaleFactor (double)
 
virtual double GetScaleFactor ()
 
virtual void SetThreeGlyphs (int)
 
virtual int GetThreeGlyphs ()
 
virtual void ThreeGlyphsOn ()
 
virtual void ThreeGlyphsOff ()
 
virtual void SetSymmetric (int)
 
virtual int GetSymmetric ()
 
virtual void SymmetricOn ()
 
virtual void SymmetricOff ()
 
virtual void SetLength (double)
 
virtual double GetLength ()
 
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 SetColorMode (int)
 
virtual int GetColorMode ()
 
void SetColorModeToScalars ()
 
void SetColorModeToEigenvalues ()
 
virtual void SetClampScaling (int)
 
virtual int GetClampScaling ()
 
virtual void ClampScalingOn ()
 
virtual void ClampScalingOff ()
 
virtual void SetMaxScaleFactor (double)
 
virtual double GetMaxScaleFactor ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTensorGlyphSafeDownCast (vtkObjectBase *o)
 
static vtkTensorGlyphNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTensorGlyph ()
 
 ~vtkTensorGlyph ()
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 

Protected Attributes

int Scaling
 
double ScaleFactor
 
int ExtractEigenvalues
 
int ColorGlyphs
 
int ColorMode
 
int ClampScaling
 
double MaxScaleFactor
 
int ThreeGlyphs
 
int Symmetric
 
double Length
 

Detailed Description

scale and orient glyph(s) according to tensor eigenvalues and eigenvectors

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.

If the boolean variable ThreeGlyphs is not set 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.

If the boolean variable ThreeGlyphs is set three glyphs are produced, each of them oriented along an eigenvector and scaled according to the corresponding eigenvector.

If the boolean variable Symmetric is set each glyph is mirrored (2 or 6 glyphs will be produced)

The x-axis of the source glyph will correspond to the eigenvector on output. Point (0,0,0) in the source will be placed in the data point. Variable Length will normally correspond to the distance from the origin to the tip of the source glyph along the x-axis, but can be changed to produce other results when Symmetric is on, e.g. glyphs that do not touch or that overlap.

Please note that when Symmetric is false it will generally be better to place the source glyph from (-0.5,0,0) to (0.5,0,0), i.e. centred at the origin. When symmetric is true the placement from (0,0,0) to (1,0,0) will generally be more convenient.

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.

If the boolean variable ColorGlyphs is set to true the glyphs are colored. The glyphs can be colored using the input scalars (SetColorModeToScalars), which is the default, or colored using the eigenvalues (SetColorModeToEigenvalues).

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 (the norm of column, always positive, is the eigenvalue). This allows additional capability over the vtkGlyph3D object. That is, the glyph can be oriented in three directions instead of one.

Thanks:
Thanks to Jose Paulo Moitinho de Almeida for enhancements.
See Also
vtkGlyph3D vtkPointLoad vtkHyperStreamline
Tests:
vtkTensorGlyph (Tests)

Definition at line 87 of file vtkTensorGlyph.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkTensorGlyph::Superclass

Definition at line 90 of file vtkTensorGlyph.h.

Member Enumeration Documentation

anonymous enum
Enumerator
COLOR_BY_SCALARS 
COLOR_BY_EIGENVALUES 

Definition at line 168 of file vtkTensorGlyph.h.

Constructor & Destructor Documentation

vtkTensorGlyph::vtkTensorGlyph ( )
protected
vtkTensorGlyph::~vtkTensorGlyph ( )
protected

Member Function Documentation

static int vtkTensorGlyph::IsTypeOf ( const char *  type)
static
virtual int vtkTensorGlyph::IsA ( const char *  type)
virtual
static vtkTensorGlyph* vtkTensorGlyph::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTensorGlyph::NewInstanceInternal ( ) const
protectedvirtual
vtkTensorGlyph* vtkTensorGlyph::NewInstance ( ) const
void vtkTensorGlyph::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static 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.

void vtkTensorGlyph::SetSourceData ( vtkPolyData *  source)

Specify the geometry to copy to each point. Old style. See SetSourceConnection.

vtkPolyData* vtkTensorGlyph::GetSource ( )

Specify the geometry to copy to each point. Old style. See SetSourceConnection.

void vtkTensorGlyph::SetSourceConnection ( int  id,
vtkAlgorithmOutput *  algOutput 
)

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

void vtkTensorGlyph::SetSourceConnection ( vtkAlgorithmOutput *  algOutput)
inline

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

Definition at line 110 of file vtkTensorGlyph.h.

virtual void vtkTensorGlyph::SetScaling ( int  )
virtual

Turn on/off scaling of glyph with eigenvalues.

virtual int vtkTensorGlyph::GetScaling ( )
virtual

Turn on/off scaling of glyph with eigenvalues.

virtual void vtkTensorGlyph::ScalingOn ( )
virtual

Turn on/off scaling of glyph with eigenvalues.

virtual void vtkTensorGlyph::ScalingOff ( )
virtual

Turn on/off scaling of glyph with eigenvalues.

virtual void vtkTensorGlyph::SetScaleFactor ( double  )
virtual

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

virtual double vtkTensorGlyph::GetScaleFactor ( )
virtual

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

virtual void vtkTensorGlyph::SetThreeGlyphs ( int  )
virtual

Turn on/off drawing three glyphs

virtual int vtkTensorGlyph::GetThreeGlyphs ( )
virtual

Turn on/off drawing three glyphs

virtual void vtkTensorGlyph::ThreeGlyphsOn ( )
virtual

Turn on/off drawing three glyphs

virtual void vtkTensorGlyph::ThreeGlyphsOff ( )
virtual

Turn on/off drawing three glyphs

virtual void vtkTensorGlyph::SetSymmetric ( int  )
virtual

Turn on/off drawing a mirror of each glyph

virtual int vtkTensorGlyph::GetSymmetric ( )
virtual

Turn on/off drawing a mirror of each glyph

virtual void vtkTensorGlyph::SymmetricOn ( )
virtual

Turn on/off drawing a mirror of each glyph

virtual void vtkTensorGlyph::SymmetricOff ( )
virtual

Turn on/off drawing a mirror of each glyph

virtual void vtkTensorGlyph::SetLength ( double  )
virtual

Set/Get the distance, along x, from the origin to the end of the source glyph. It is used to draw the symmetric glyphs.

virtual double vtkTensorGlyph::GetLength ( )
virtual

Set/Get the distance, along x, from the origin to the end of the source glyph. It is used to draw the symmetric glyphs.

virtual void vtkTensorGlyph::SetExtractEigenvalues ( int  )
virtual

Turn on/off extraction of eigenvalues from tensor.

virtual void vtkTensorGlyph::ExtractEigenvaluesOn ( )
virtual

Turn on/off extraction of eigenvalues from tensor.

virtual void vtkTensorGlyph::ExtractEigenvaluesOff ( )
virtual

Turn on/off extraction of eigenvalues from tensor.

virtual int vtkTensorGlyph::GetExtractEigenvalues ( )
virtual

Turn on/off extraction of eigenvalues from tensor.

virtual void vtkTensorGlyph::SetColorGlyphs ( int  )
virtual

Turn on/off coloring of glyph with input scalar data or eigenvalues. 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

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

virtual void vtkTensorGlyph::ColorGlyphsOn ( )
virtual

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

virtual void vtkTensorGlyph::ColorGlyphsOff ( )
virtual

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

virtual void vtkTensorGlyph::SetColorMode ( int  )
virtual

Set the color mode to be used for the glyphs. This can be set to use the input scalars (default) or to use the eigenvalues at the point. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. The recognized values are: COLOR_BY_SCALARS = 0 (default) COLOR_BY_EIGENVALUES = 1

virtual int vtkTensorGlyph::GetColorMode ( )
virtual

Set the color mode to be used for the glyphs. This can be set to use the input scalars (default) or to use the eigenvalues at the point. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. The recognized values are: COLOR_BY_SCALARS = 0 (default) COLOR_BY_EIGENVALUES = 1

void vtkTensorGlyph::SetColorModeToScalars ( )
inline

Set the color mode to be used for the glyphs. This can be set to use the input scalars (default) or to use the eigenvalues at the point. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. The recognized values are: COLOR_BY_SCALARS = 0 (default) COLOR_BY_EIGENVALUES = 1

Definition at line 185 of file vtkTensorGlyph.h.

void vtkTensorGlyph::SetColorModeToEigenvalues ( )
inline

Set the color mode to be used for the glyphs. This can be set to use the input scalars (default) or to use the eigenvalues at the point. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. The recognized values are: COLOR_BY_SCALARS = 0 (default) COLOR_BY_EIGENVALUES = 1

Definition at line 187 of file vtkTensorGlyph.h.

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

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 void vtkTensorGlyph::ClampScalingOn ( )
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 void vtkTensorGlyph::ClampScalingOff ( )
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 void vtkTensorGlyph::SetMaxScaleFactor ( double  )
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 double vtkTensorGlyph::GetMaxScaleFactor ( )
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 int vtkTensorGlyph::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkTensorGlyph::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkTensorGlyph::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Member Data Documentation

int vtkTensorGlyph::Scaling
protected

Definition at line 217 of file vtkTensorGlyph.h.

double vtkTensorGlyph::ScaleFactor
protected

Definition at line 218 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ExtractEigenvalues
protected

Definition at line 219 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ColorGlyphs
protected

Definition at line 220 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ColorMode
protected

Definition at line 221 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ClampScaling
protected

Definition at line 222 of file vtkTensorGlyph.h.

double vtkTensorGlyph::MaxScaleFactor
protected

Definition at line 223 of file vtkTensorGlyph.h.

int vtkTensorGlyph::ThreeGlyphs
protected

Definition at line 224 of file vtkTensorGlyph.h.

int vtkTensorGlyph::Symmetric
protected

Definition at line 225 of file vtkTensorGlyph.h.

double vtkTensorGlyph::Length
protected

Definition at line 226 of file vtkTensorGlyph.h.


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