forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkStrahlerMetric.h
104 lines (86 loc) · 3.14 KB
/
vtkStrahlerMetric.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*=========================================================================
Program: Visualization Toolkit
Module: vtkStrahlerMetric.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
//-------------------------------------------------------------------------
//Copyright 2008 Sandia Corporation.
//Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
//the U.S. Government retains certain rights in this software.
//-------------------------------------------------------------------------
//
/**
* @class vtkStrahlerMetric
* @brief 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.
*
* @par Thanks:
* Thanks to David Duke from the University of Leeds for providing this
* implementation.
*/
#ifndef vtkStrahlerMetric_h
#define vtkStrahlerMetric_h
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkTreeAlgorithm.h"
class vtkFloatArray;
class VTKFILTERSSTATISTICS_EXPORT vtkStrahlerMetric : public vtkTreeAlgorithm
{
public:
static vtkStrahlerMetric *New();
vtkTypeMacro(vtkStrahlerMetric,vtkTreeAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Set the name of the array in which the Strahler values will
* be stored within the output vertex data.
* Default is "Strahler"
*/
vtkSetStringMacro(MetricArrayName);
//@}
//@{
/**
* 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.
*/
vtkSetMacro(Normalize, int);
vtkGetMacro(Normalize, int);
vtkBooleanMacro(Normalize, int);
//@}
//@{
/**
* Get the maximum strahler value for the tree.
*/
vtkGetMacro(MaxStrahler,float);
//@}
protected:
vtkStrahlerMetric();
~vtkStrahlerMetric() VTK_OVERRIDE;
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) VTK_OVERRIDE;
int Normalize;
float MaxStrahler;
char *MetricArrayName;
float CalculateStrahler(vtkIdType root, vtkFloatArray *metric, vtkTree *graph);
private:
vtkStrahlerMetric(const vtkStrahlerMetric&) VTK_DELETE_FUNCTION;
void operator=(const vtkStrahlerMetric&) VTK_DELETE_FUNCTION;
};
#endif