VTK
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 -------------------------------------------------------------------------*/
33 #ifndef vtkClustering2DLayoutStrategy_h
34 #define vtkClustering2DLayoutStrategy_h
35 
36 #include "vtkInfovisLayoutModule.h" // For export macro
37 #include "vtkGraphLayoutStrategy.h"
38 
39 #include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
40 
41 class vtkFastSplatter;
42 class vtkImageData;
43 class vtkIntArray;
44 class vtkFloatArray;
45 
46 class VTKINFOVISLAYOUT_EXPORT vtkClustering2DLayoutStrategy : public vtkGraphLayoutStrategy
47 {
48 public:
50 
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
60  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
61  vtkGetMacro(RandomSeed, int);
63 
65 
73  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
74  vtkGetMacro(MaxNumberOfIterations, int);
76 
78 
85  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
86  vtkGetMacro(IterationsPerLayout, int);
88 
90 
96  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
97  vtkGetMacro(InitialTemperature, float);
99 
101 
109  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
110  vtkGetMacro(CoolDownRate, double);
112 
114 
118  vtkSetMacro(RestDistance, float);
119  vtkGetMacro(RestDistance, float);
121 
126  void Initialize() override;
127 
135  void Layout() override;
136 
141  int IsLayoutComplete() override {return this->LayoutComplete;}
142 
143 protected:
145  ~vtkClustering2DLayoutStrategy() override;
146 
147  int MaxNumberOfIterations; //Maximum number of iterations.
149  float CoolDownRate; //Cool-down rate. Note: Higher # = Slower rate.
150 
151 private:
152 
153  // An edge consists of two vertices joined together.
154  // This struct acts as a "pointer" to those two vertices.
155  typedef struct
156  {
157  vtkIdType from;
158  vtkIdType to;
159  float weight;
160  int dead_edge; // I'm making this an int so that the edge array is
161  // word boundary aligned... but I'm not sure what
162  // really happens in these days of magical compilers
163  } vtkLayoutEdge;
164 
165  // This class 'has a' vtkFastSplatter for the density grid
168  vtkSmartPointer<vtkFloatArray> RepulsionArray;
169  vtkSmartPointer<vtkFloatArray> AttractionArray;
170  vtkSmartPointer<vtkIntArray> EdgeCountArray;
171 
172  vtkLayoutEdge *EdgeArray;
173 
174  int RandomSeed;
175  int IterationsPerLayout;
176  int TotalIterations;
177  int LayoutComplete;
178  float Temp;
179  float RestDistance;
180  float CuttingThreshold;
181 
182  // Private helper methods
183  void GenerateCircularSplat(vtkImageData *splat, int x, int y);
184  void GenerateGaussianSplat(vtkImageData *splat, int x, int y);
185  void ResolveCoincidentVertices();
186 
188  void operator=(const vtkClustering2DLayoutStrategy&) = delete;
189 };
190 
191 #endif
192 
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
#define VTK_INT_MAX
Definition: vtkType.h:159
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:41
int vtkIdType
Definition: vtkType.h:347
abstract superclass for all graph layout strategies
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:45
#define VTK_FLOAT_MAX
Definition: vtkType.h:167
A splatter optimized for splatting single kernels.
a simple class to control print indentation
Definition: vtkIndent.h:39
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
int IsLayoutComplete() override
I&#39;m an iterative layout so this method lets the caller know if I&#39;m done laying out the graph...
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void Initialize()
This method allows the layout strategy to do initialization of data structures or whatever else it mi...
virtual void Layout()=0
This is the layout method where the graph that was set in SetGraph() is laid out. ...
a simple fast 2D graph layout