diff options
Diffstat (limited to 'src/cython/doc/persistence_graphical_tools_user.rst')
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_user.rst | 46 |
1 files changed, 46 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..0cb61cf1 --- /dev/null +++ b/src/cython/doc/persistence_graphical_tools_user.rst @@ -0,0 +1,46 @@ +======================================= +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) + +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.barcode_persistence(diag) + + +Show persistence as a diagram +----------------------------- + +This function can display the persistence result as a diagram: + +.. testcode:: + + import gudhi + + alpha_complex = gudhi.AlphaComplex(off_file='tore3D_300.off') + alpha_complex.initialize_filtration() + diag = alpha_complex.persistence() + gudhi.diagram_persistence(diag) |