Merge pull request #1061 from julien-tierny/doc

[Doc] Adding Links to Topological Optimization examples (headers)
topology-tool-kit · Sep 17, 2024 · 816e833 · 816e833
2 parents 7d773c0 + 6dec9b9
commit 816e833
Show file tree

Hide file tree

Showing 18 changed files with 95 additions and 2 deletions.
diff --git a/core/base/morseSmaleComplex/MorseSmaleComplex.h b/core/base/morseSmaleComplex/MorseSmaleComplex.h
@@ -70,6 +70,9 @@
 ///   href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 ///   Puzzle example</a> \n
 ///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+///   Optimization DarkSky</a>\n
+///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/tribute/">Tribute
 ///   example</a> \n
 ///

diff --git a/core/base/persistenceDiagram/PersistenceDiagram.h b/core/base/persistenceDiagram/PersistenceDiagram.h
@@ -130,6 +130,15 @@
 ///   href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 ///   Puzzle example</a> \n
 ///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+///   Optimization DarkSky</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
+///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/tribute/">Tribute
 ///   example</a> \n
 ///   - <a

diff --git a/core/base/scalarFieldSmoother/ScalarFieldSmoother.h b/core/base/scalarFieldSmoother/ScalarFieldSmoother.h
@@ -44,6 +44,12 @@
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
 ///   Diagram Principal Geodesic Analysis example</a> \n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+///   Optimization DarkSky</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
 
 #pragma once
 

diff --git a/core/base/signedDistanceField/SignedDistanceField.h b/core/base/signedDistanceField/SignedDistanceField.h
@@ -25,6 +25,14 @@
 /// all the vertices being not yet updated and nearest the input surface are
 /// updated (instead of just one in the fast marching backend). It results in a
 /// faster method (due to parallelism) but is a rougher approximation.
+///
+/// \b Online \b examples: \n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
 
 #pragma once
 #include <iostream>

diff --git a/core/base/topologicalSimplification/TopologicalSimplification.h b/core/base/topologicalSimplification/TopologicalSimplification.h
@@ -88,6 +88,15 @@
 ///   href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic
 ///   Puzzle example</a> \n
 ///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
+///   Optimization DarkSky</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
+///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/tribute/">Tribute
 ///   example</a> \n
 ///   - <a

diff --git a/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h b/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h
@@ -48,6 +48,9 @@
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
 ///   Diagram Principal Geodesic Analysis example</a> \n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
 ///
 
 #pragma once

diff --git a/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h b/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h
@@ -144,7 +144,13 @@
 ///   Puzzle example</a> \n
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
-///   Optimization DarkSky</a>\n
+///   Optimization DarkSky example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/tribute/">Tribute
 ///   example</a> \n

diff --git a/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h b/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h
@@ -34,6 +34,9 @@
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/persistentGenerators_skull/">Persistent
 ///   Generators Skull example</a> \n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
 ///
 
 #pragma once

diff --git a/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h b/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h
@@ -52,6 +52,9 @@
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
 ///   Optimization DarkSky</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
 
 #pragma once
 

diff --git a/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h b/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h
@@ -25,6 +25,14 @@
 /// all the vertices being not yet updated and nearest the input surface are
 /// updated (instead of just one in the fast marching backend). It results in a
 /// faster method (due to parallelism) but is a rougher approximation.
+///
+/// \b Online \b examples: \n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
 
 #pragma once
 

diff --git a/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h b/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h
@@ -117,7 +117,13 @@
 ///   Puzzle example</a> \n
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky//">Topological
-///   Optimization DarkSky</a>\n
+///   Optimization DarkSky example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus//">Topological
+///   Optimization for Pegasus Genus Repair example</a>\n
+///   - <a
+///   href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus//">Topological
+///   Optimization for Torus Repair example</a>\n
 ///   - <a
 ///   href="https://topology-tool-kit.github.io/examples/tribute/">Tribute
 ///   example</a> \n

diff --git a/paraview/xmls/GeometrySmoother.xml b/paraview/xmls/GeometrySmoother.xml
@@ -36,6 +36,8 @@
 
         - https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
 
+        https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
       </Documentation>
       <InputProperty
         name="Input"

diff --git a/paraview/xmls/MorseSmaleComplex.xml b/paraview/xmls/MorseSmaleComplex.xml
@@ -56,6 +56,8 @@
 
         - https://topology-tool-kit.github.io/examples/tectonicPuzzle/
 
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/
+
         - https://topology-tool-kit.github.io/examples/tribute/
 
       </Documentation>

diff --git a/paraview/xmls/PersistenceDiagram.xml b/paraview/xmls/PersistenceDiagram.xml
@@ -140,6 +140,12 @@
 
         - https://topology-tool-kit.github.io/examples/tectonicPuzzle/
 
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/
+
+        https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/
+
         - https://topology-tool-kit.github.io/examples/tribute/
 
         - https://topology-tool-kit.github.io/examples/uncertainStartingVortex/

diff --git a/paraview/xmls/PersistentGenerators.xml b/paraview/xmls/PersistentGenerators.xml
@@ -31,6 +31,8 @@
 
         - https://topology-tool-kit.github.io/examples/persistentGenerators_skull/
 
+        https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
       </Documentation>
 
       <InputProperty

diff --git a/paraview/xmls/ScalarFieldSmoother.xml b/paraview/xmls/ScalarFieldSmoother.xml
@@ -22,6 +22,11 @@
         - https://topology-tool-kit.github.io/examples/morsePersistence/   
 
         - https://topology-tool-kit.github.io/examples/persistentGenerators_darkSky/
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/
+
+        https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
       </Documentation>
       <InputProperty
         name="Input"

diff --git a/paraview/xmls/SignedDistanceField.xml b/paraview/xmls/SignedDistanceField.xml
@@ -20,6 +20,12 @@ A Fast Marching Level Set Method for Monotonically Advancing Fronts,
 Proc. Natl. Acad. Sci., 93, 4, pp.1591--1595, 1996
 
 - The fast marching band backend, a variant of the fast marching for which all the vertices being not yet updated and nearest the input surface are updated (instead of just one in the fast marching backend). It results in a faster method (due to parallelism) but is a rougher approximation.
+
+        Online examples:
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/
       </Documentation>
 
 

diff --git a/paraview/xmls/TopologicalSimplification.xml b/paraview/xmls/TopologicalSimplification.xml
@@ -86,6 +86,12 @@ Identifiers.
 
         - https://topology-tool-kit.github.io/examples/tectonicPuzzle/
 
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/
+
+        - https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/
+
         - https://topology-tool-kit.github.io/examples/tribute/
 
         - https://topology-tool-kit.github.io/examples/uncertainStartingVortex/