VTK  9.0.1
vtkClustering2DLayoutStrategy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkClustering2DLayoutStrategy.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
36 #ifndef vtkClustering2DLayoutStrategy_h
37 #define vtkClustering2DLayoutStrategy_h
38 
39 #include "vtkGraphLayoutStrategy.h"
40 #include "vtkInfovisLayoutModule.h" // For export macro
41 
42 #include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
43 
44 class vtkFastSplatter;
45 class vtkImageData;
46 class vtkIntArray;
47 class vtkFloatArray;
48 
49 class VTKINFOVISLAYOUT_EXPORT vtkClustering2DLayoutStrategy : public vtkGraphLayoutStrategy
50 {
51 public:
53 
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
63  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
64  vtkGetMacro(RandomSeed, int);
66 
68 
76  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
77  vtkGetMacro(MaxNumberOfIterations, int);
79 
81 
88  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
89  vtkGetMacro(IterationsPerLayout, int);
91 
93 
99  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
100  vtkGetMacro(InitialTemperature, float);
102 
104 
112  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
113  vtkGetMacro(CoolDownRate, double);
115 
117 
121  vtkSetMacro(RestDistance, float);
122  vtkGetMacro(RestDistance, float);
124 
129  void Initialize() override;
130 
138  void Layout() override;
139 
144  int IsLayoutComplete() override { return this->LayoutComplete; }
145 
146 protected:
148  ~vtkClustering2DLayoutStrategy() override;
149 
150  int MaxNumberOfIterations; // Maximum number of iterations.
152  float CoolDownRate; // Cool-down rate. Note: Higher # = Slower rate.
153 
154 private:
155  // An edge consists of two vertices joined together.
156  // This struct acts as a "pointer" to those two vertices.
157  typedef struct
158  {
159  vtkIdType from;
160  vtkIdType to;
161  float weight;
162  int dead_edge; // I'm making this an int so that the edge array is
163  // word boundary aligned... but I'm not sure what
164  // really happens in these days of magical compilers
165  } vtkLayoutEdge;
166 
167  // This class 'has a' vtkFastSplatter for the density grid
170  vtkSmartPointer<vtkFloatArray> RepulsionArray;
171  vtkSmartPointer<vtkFloatArray> AttractionArray;
172  vtkSmartPointer<vtkIntArray> EdgeCountArray;
173 
174  vtkLayoutEdge* EdgeArray;
175 
176  int RandomSeed;
177  int IterationsPerLayout;
178  int TotalIterations;
179  int LayoutComplete;
180  float Temp;
181  float RestDistance;
182  float CuttingThreshold;
183 
184  // Private helper methods
185  void GenerateCircularSplat(vtkImageData* splat, int x, int y);
186  void GenerateGaussianSplat(vtkImageData* splat, int x, int y);
187  void ResolveCoincidentVertices();
188 
190  void operator=(const vtkClustering2DLayoutStrategy&) = delete;
191 };
192 
193 #endif
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:155
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:35
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkGraphLayoutStrategy
abstract superclass for all graph layout strategies
Definition: vtkGraphLayoutStrategy.h:45
vtkX3D::weight
@ weight
Definition: vtkX3D.h:538
vtkSmartPointer< vtkFastSplatter >
vtkClustering2DLayoutStrategy
a simple fast 2D graph layout
Definition: vtkClustering2DLayoutStrategy.h:49
vtkGraphLayoutStrategy::Layout
virtual void Layout()=0
This is the layout method where the graph that was set in SetGraph() is laid out.
vtkClustering2DLayoutStrategy::MaxNumberOfIterations
int MaxNumberOfIterations
Definition: vtkClustering2DLayoutStrategy.h:150
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkIntArray
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:39
vtkClustering2DLayoutStrategy::InitialTemperature
float InitialTemperature
Definition: vtkClustering2DLayoutStrategy.h:151
vtkGraphLayoutStrategy::Initialize
virtual void Initialize()
This method allows the layout strategy to do initialization of data structures or whatever else it mi...
Definition: vtkGraphLayoutStrategy.h:61
vtkSmartPointer.h
vtkGraphLayoutStrategy::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkFastSplatter
A splatter optimized for splatting single kernels.
Definition: vtkFastSplatter.h:51
VTK_FLOAT_MAX
#define VTK_FLOAT_MAX
Definition: vtkType.h:163
vtkGraphLayoutStrategy.h
vtkClustering2DLayoutStrategy::IsLayoutComplete
int IsLayoutComplete() override
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
Definition: vtkClustering2DLayoutStrategy.h:144
vtkClustering2DLayoutStrategy::CoolDownRate
float CoolDownRate
Definition: vtkClustering2DLayoutStrategy.h:152
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition: vtkType.h:165