Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated documentation #1052

Merged
merged 7 commits into from
Sep 10, 2024
Merged

Updated documentation #1052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
936002a
changelog update
julien-tierny Sep 9, 2024
d7bbc7d
[ci] adding ubuntu 24.04
julien-tierny Sep 9, 2024
6fb30c2
[ci] disabling ubuntu 24.04
julien-tierny Sep 9, 2024
3de14bc
[pd-pga] updted paraview xml doc
julien-tierny Sep 9, 2024
88ca359
[pd-pga] updated vtk docuemntation
julien-tierny Sep 9, 2024
1df627d
[pd-pga] update core documentation
julien-tierny Sep 9, 2024
cdedba3
clang-formatting doc
julien-tierny Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
=
### dev
- Wasserstein Auto-Encoders of Merge Trees / Pers. Diagrams (IEEE TVCG 2024)
- Topological simplification optimization (IEEE VIS 2024)
- TopoMap dimensionality reduction (IEEE TVCG 2020)
- TTK is Getting MPI-ready! (IEEE TVCG 2024)
- ExTreeM merge tree computation backend (IEEE TVCG 2024)
- Ripser integration
- DMS performance improvements (allocation)
- Saddle connector reversal performance improvements
- Signed distance fields
- Migration to ParaView 5.12
- Switch to C++17
- Bug fixes
Expand Down
3 changes: 3 additions & 0 deletions core/base/dimensionReduction/DimensionReduction.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <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/persistentGenerators_householdAnalysis/">Persistent
/// Generators Household Analysis example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/base/mergeTreeDistanceMatrix/MergeTreeDistanceMatrix.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/base/mergeTreePrincipalGeodesics/MergeTreePrincipalGeodesics.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/base/mergeTreePrincipalGeodesicsDecoding/MergeTreePrincipalGeodesicsDecoding.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/base/persistenceDiagram/PersistenceDiagram.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/">Persistence
/// Diagram Distance example</a> \n
/// - <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/persistenceDiagramWAE/">Persistence
/// Diagram Wasserstein Auto-Encoder example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/base/projectionFromTable/ProjectionFromTable.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/base/scalarFieldSmoother/ScalarFieldSmoother.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale
/// segmentation example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkBlockAggregator/ttkBlockAggregator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/nestedTrackingFromOverlap/">Nested
/// Tracking from Overlap example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkCinemaProductReader/ttkCinemaProductReader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/">Persistence
/// Diagram Distance example</a> \n
/// - <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/persistenceDiagramWAE/">Persistence
/// Diagram Wasserstein Auto-Encoder example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkCinemaReader/ttkCinemaReader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/">Persistence
/// Diagram Distance example</a> \n
/// - <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/persistenceDiagramWAE/">Persistence
/// Diagram Wasserstein Auto-Encoder example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkDataSetToTable/ttkDataSetToTable.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
/// href="https://topology-tool-kit.github.io/examples/mergeTreeWAE/">Merge
/// tree Wasserstein Auto-Encoder example</a> \n
/// - <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/persistenceDiagramWAE/">Persistence
/// Diagram Wasserstein Auto-Encoder example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkDimensionReduction/ttkDimensionReduction.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <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/persistentGenerators_householdAnalysis/">Persistent
/// Generators Household Analysis example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkFlattenMultiBlock/ttkFlattenMultiBlock.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/nestedTrackingFromOverlap/">Nested
/// Tracking from Overlap example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale
/// segmentation example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n
///

#pragma once
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkMergeBlockTables/ttkMergeBlockTables.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <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/persistentGenerators_periodicPicture/">Persistent
/// Generators Periodic Picture example</a> \n

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkMergeTreeDistanceMatrix/ttkMergeTreeDistanceMatrix.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">
/// Persistence Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkMergeTreePrincipalGeodesics/ttkMergeTreePrincipalGeodesics.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkMergeTreePrincipalGeodesicsDecoding/ttkMergeTreePrincipalGeodesicsDecoding.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/">Persistence
/// Diagram Distance example</a> \n
/// - <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/tectonicPuzzle/">Tectonic
/// Puzzle example</a> \n
/// - <a
Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkPointSetToCurve/ttkPointSetToCurve.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkPointSetToSurface/ttkPointSetToSurface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
3 changes: 3 additions & 0 deletions core/vtk/ttkProjectionFromTable/ttkProjectionFromTable.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
/// - <a
/// href="https://topology-tool-kit.github.io/examples/mergeTreePGA/">Merge
/// Tree Principal Geodesic Analysis example</a> \n
/// - <a
/// href="https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/">Persistence
/// Diagram Principal Geodesic Analysis example</a> \n

#pragma once

Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/BlockAggregator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

- https://topology-tool-kit.github.io/examples/nestedTrackingFromOverlap/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

</Documentation>

<InputProperty name="Input" port_index="0" clean_command="RemoveAllInputs" command="AddInputConnection" multiple_input="1">
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/CinemaProductReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

- https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramWAE/

- https://topology-tool-kit.github.io/examples/persistentGenerators_periodicPicture/
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/CinemaReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

- https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramWAE/

- https://topology-tool-kit.github.io/examples/persistentGenerators_periodicPicture/
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/DataSetToTable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

- https://topology-tool-kit.github.io/examples/mergeTreeWAE/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramWAE/

- https://topology-tool-kit.github.io/examples/persistentGenerators_periodicPicture/
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/DimensionReduction.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistentGenerators_householdAnalysis/

- https://topology-tool-kit.github.io/examples/persistentGenerators_periodicPicture/
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/FlattenMultiBlock.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

- https://topology-tool-kit.github.io/examples/nestedTrackingFromOverlap/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

</Documentation>

<InputProperty
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/GeometrySmoother.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@

- https://topology-tool-kit.github.io/examples/morseMolecule/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

</Documentation>
<InputProperty
name="Input"
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/MergeBlockTables.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistentGenerators_periodicPicture/
</Documentation>

Expand Down
2 changes: 0 additions & 2 deletions paraview/xmls/MergeTree.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@
- https://topology-tool-kit.github.io/examples/mergeTreeWAE/




</Documentation>

<InputProperty
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/MergeTreeDistanceMatrix.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Online examples:
- https://topology-tool-kit.github.io/examples/mergeTreeClustering/

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
</Documentation>

<!-- INPUT -->
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/MergeTreePrincipalGeodesics.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

</Documentation>

<!-- INPUT DATA OBJECTS -->
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/MergeTreePrincipalGeodesicsDecoding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

</Documentation>

<!-- INPUT DATA OBJECTS -->
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/PersistenceDiagram.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@

- https://topology-tool-kit.github.io/examples/persistenceDiagramDistance/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramWAE/

- https://topology-tool-kit.github.io/examples/tectonicPuzzle/
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/PointSetToCurve.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
Online examples:

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
</Documentation>

<InputProperty
Expand Down
2 changes: 2 additions & 0 deletions paraview/xmls/PointSetToSurface.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
Online examples:

- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
</Documentation>

<InputProperty
Expand Down
4 changes: 3 additions & 1 deletion paraview/xmls/ProjectionFromTable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@

Online examples:

- https://topology-tool-kit.github.io/examples/mergeTreePGA/
- https://topology-tool-kit.github.io/examples/mergeTreePGA/

- https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/
</Documentation>

<!-- INPUT DATA OBJECTS -->
Expand Down
Loading