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
vtkStrahlerMetric Class Reference

compute Strahler metric for a tree More...

#include <vtkStrahlerMetric.h>

Inherits vtkTreeAlgorithm.

Public Types

typedef vtkTreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkStrahlerMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetMetricArrayName (const char *)
 
virtual void SetNormalize (int)
 
virtual int GetNormalize ()
 
virtual void NormalizeOn ()
 
virtual void NormalizeOff ()
 
virtual float GetMaxStrahler ()
 

Static Public Member Functions

static vtkStrahlerMetricNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStrahlerMetricSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkStrahlerMetric ()
 
 ~vtkStrahlerMetric ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
float CalculateStrahler (vtkIdType root, vtkFloatArray *metric, vtkTree *graph)
 

Protected Attributes

int Normalize
 
float MaxStrahler
 
char * MetricArrayName
 

Detailed Description

compute Strahler metric for a tree

The Strahler metric is a value assigned to each vertex of a tree that characterizes the structural complexity of the sub-tree rooted at that node. The metric originated in the study of river systems, but has been applied to other tree- structured systes, Details of the metric and the rationale for using it in infovis can be found in:

Tree Visualization and Navigation Clues for Information Visualization, I. Herman, M. Delest, and G. Melancon, Computer Graphics Forum, Vol 17(2), Blackwell, 1998.

The input tree is copied to the output, but with a new array added to the output vertex data.

Thanks:
Thanks to David Duke from the University of Leeds for providing this implementation.

Definition at line 51 of file vtkStrahlerMetric.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkStrahlerMetric::Superclass

Definition at line 55 of file vtkStrahlerMetric.h.

Constructor & Destructor Documentation

vtkStrahlerMetric::vtkStrahlerMetric ( )
protected
vtkStrahlerMetric::~vtkStrahlerMetric ( )
protected

Member Function Documentation

static vtkStrahlerMetric* vtkStrahlerMetric::New ( )
static
static int vtkStrahlerMetric::IsTypeOf ( const char *  type)
static
virtual int vtkStrahlerMetric::IsA ( const char *  type)
virtual
static vtkStrahlerMetric* vtkStrahlerMetric::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkStrahlerMetric::NewInstanceInternal ( ) const
protectedvirtual
vtkStrahlerMetric* vtkStrahlerMetric::NewInstance ( ) const
void vtkStrahlerMetric::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkStrahlerMetric::SetMetricArrayName ( const char *  )
virtual

Set the name of the array in which the Strahler values will be stored within the output vertex data. Default is "Strahler"

virtual void vtkStrahlerMetric::SetNormalize ( int  )
virtual

Set/get setting of normalize flag. If this is set, the Strahler values are scaled into the range [0..1]. Default is for normalization to be OFF.

virtual int vtkStrahlerMetric::GetNormalize ( )
virtual

Set/get setting of normalize flag. If this is set, the Strahler values are scaled into the range [0..1]. Default is for normalization to be OFF.

virtual void vtkStrahlerMetric::NormalizeOn ( )
virtual

Set/get setting of normalize flag. If this is set, the Strahler values are scaled into the range [0..1]. Default is for normalization to be OFF.

virtual void vtkStrahlerMetric::NormalizeOff ( )
virtual

Set/get setting of normalize flag. If this is set, the Strahler values are scaled into the range [0..1]. Default is for normalization to be OFF.

virtual float vtkStrahlerMetric::GetMaxStrahler ( )
virtual

Get the maximum strahler value for the tree.

int vtkStrahlerMetric::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
float vtkStrahlerMetric::CalculateStrahler ( vtkIdType  root,
vtkFloatArray *  metric,
vtkTree *  graph 
)
protected

Member Data Documentation

int vtkStrahlerMetric::Normalize
protected

Definition at line 84 of file vtkStrahlerMetric.h.

float vtkStrahlerMetric::MaxStrahler
protected

Definition at line 85 of file vtkStrahlerMetric.h.

char* vtkStrahlerMetric::MetricArrayName
protected

Definition at line 86 of file vtkStrahlerMetric.h.


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