diff options
| author | glisse <glisse@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-03-26 11:32:25 +0000 |
|---|---|---|
| committer | glisse <glisse@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-03-26 11:32:25 +0000 |
| commit | 1208d423e700764a3453767886e6a3b4c0a09125 (patch) | |
| tree | 3e938a2e1e984e80e1137fd30968e385068ec8e4 /src/cython/doc/persistence_graphical_tools_user.rst | |
| parent | 6f9560fe6d6cca6c5a0de35fcf7938912e103930 (diff) | |
| parent | 6ed42daddfede2288bc02ab2e98fc12b47cac74e (diff) | |
merge from trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/farthest_distance@2244 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 7d261d59dae839dd5de8f6a03c5a167d015f7d85
Diffstat (limited to 'src/cython/doc/persistence_graphical_tools_user.rst')
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_user.rst | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/src/cython/doc/persistence_graphical_tools_user.rst b/src/cython/doc/persistence_graphical_tools_user.rst new file mode 100644 index 00000000..f713e971 --- /dev/null +++ b/src/cython/doc/persistence_graphical_tools_user.rst @@ -0,0 +1,67 @@ +======================================= +Persistence graphical tools user manual +======================================= +Definition +---------- +.. include:: persistence_graphical_tools_sum.rst + + +Show palette values +------------------- + +This function is useful to show the color palette values of dimension: + + +.. testcode:: + + import gudhi + gudhi.show_palette_values(alpha=1.0) + +.. plot:: + + import gudhi + gudhi.show_palette_values(alpha=1.0) + +Show persistence as a barcode +----------------------------- + +This function can display the persistence result as a barcode: + +.. testcode:: + + import gudhi + + periodic_cc = gudhi.PeriodicCubicalComplex(perseus_file='3d_torus.txt') + diag = periodic_cc.persistence() + gudhi.plot_persistence_barcode(diag) + +.. plot:: + + import gudhi + + periodic_cc = gudhi.PeriodicCubicalComplex(perseus_file='3d_torus.txt') + diag = periodic_cc.persistence() + gudhi.plot_persistence_barcode(diag) + +Show persistence as a diagram +----------------------------- + +This function can display the persistence result as a diagram: + +.. testcode:: + + import gudhi + + rips_complex = gudhi.RipsComplex(off_file='tore3D_300.off', max_edge_length=2.0) + simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) + diag = simplex_tree.persistence() + gudhi.plot_persistence_diagram(diag) + +.. plot:: + + import gudhi + + rips_complex = gudhi.RipsComplex(off_file='tore3D_300.off', max_edge_length=2.0) + simplex_tree = rips_complex.create_simplex_tree(max_dimension=3) + diag = simplex_tree.persistence() + gudhi.plot_persistence_diagram(diag) |