summaryrefslogtreecommitdiff
path: root/src/python/doc/persistence_graphical_tools_user.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/doc/persistence_graphical_tools_user.rst')
-rw-r--r--src/python/doc/persistence_graphical_tools_user.rst73
1 files changed, 73 insertions, 0 deletions
diff --git a/src/python/doc/persistence_graphical_tools_user.rst b/src/python/doc/persistence_graphical_tools_user.rst
new file mode 100644
index 00000000..b2124fdd
--- /dev/null
+++ b/src/python/doc/persistence_graphical_tools_user.rst
@@ -0,0 +1,73 @@
+:orphan:
+
+.. To get rid of WARNING: document isn't included in any toctree
+
+Persistence graphical tools user manual
+=======================================
+Definition
+----------
+.. include:: persistence_graphical_tools_sum.inc
+
+
+Show persistence as a barcode
+-----------------------------
+
+.. note::
+ this function requires matplotlib and numpy to be available
+
+This function can display the persistence result as a barcode:
+
+.. plot::
+ :include-source:
+
+ import gudhi
+
+ off_file = gudhi.__root_source_dir__ + '/data/points/tore3D_300.off'
+ point_cloud = gudhi.read_off(off_file=off_file)
+
+ rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.7)
+ simplex_tree = rips_complex.create_simplex_tree(max_dimension=3)
+ diag = simplex_tree.persistence(min_persistence=0.4)
+
+ plot = gudhi.plot_persistence_barcode(diag)
+ plot.show()
+
+Show persistence as a diagram
+-----------------------------
+
+.. note::
+ this function requires matplotlib and numpy to be available
+
+This function can display the persistence result as a diagram:
+
+.. plot::
+ :include-source:
+
+ import gudhi
+
+ # rips_on_tore3D_1307.pers obtained from write_persistence_diagram method
+ persistence_file=gudhi.__root_source_dir__ + \
+ '/data/persistence_diagram/rips_on_tore3D_1307.pers'
+ plt = gudhi.plot_persistence_diagram(persistence_file=persistence_file,
+ legend=True)
+ plt.show()
+
+Persistence density
+-------------------
+
+.. note::
+ this function requires matplotlib, numpy and scipy to be available
+
+If you want more information on a specific dimension, for instance:
+
+.. plot::
+ :include-source:
+
+ import gudhi
+
+ # rips_on_tore3D_1307.pers obtained from write_persistence_diagram method
+ persistence_file=gudhi.__root_source_dir__ + \
+ '/data/persistence_diagram/rips_on_tore3D_1307.pers'
+ plt = gudhi.plot_persistence_density(persistence_file=persistence_file,
+ max_intervals=0, dimension=1, legend=True)
+ plt.show()