vtkStrahlerMetric Class Reference

#include <vtkStrahlerMetric.h>

Inheritance diagram for vtkStrahlerMetric:

[legend]

Collaboration diagram for vtkStrahlerMetric:

[legend]

List of all members.

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 50 of file vtkStrahlerMetric.h.


Public Types
typedef vtkTreeAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 vtkStrahlerMetric *	New ()
static int	IsTypeOf (const char *type)
static vtkStrahlerMetric *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkStrahlerMetric ()
	~vtkStrahlerMetric ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
float	CalculateStrahler (vtkIdType root, vtkFloatArray metric, vtkTree graph)
Protected Attributes
int	Normalize
float	MaxStrahler
char *	MetricArrayName

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkStrahlerMetric::Superclass

Reimplemented from vtkTreeAlgorithm.

Definition at line 54 of file vtkStrahlerMetric.h.

Constructor & Destructor Documentation

vtkStrahlerMetric::vtkStrahlerMetric ( ) [protected]

vtkStrahlerMetric::~vtkStrahlerMetric ( ) [protected]

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTreeAlgorithm.

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

Reimplemented from vtkTreeAlgorithm.

static int vtkStrahlerMetric::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 vtkTreeAlgorithm.

virtual int vtkStrahlerMetric::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 vtkTreeAlgorithm.

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

Reimplemented from vtkTreeAlgorithm.

void vtkStrahlerMetric::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 vtkTreeAlgorithm.

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 *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`