summaryrefslogtreecommitdiff
path: root/src/cython/doc
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-27 16:03:43 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-27 16:03:43 +0000
commit0902c35ad4701d78a91b30e2d055a529f4de01d5 (patch)
tree9a82c6359e994aa25cdf9d12afd15930129b35fb /src/cython/doc
parent50bff0fced63e298ae9952a192f8e1b70d9abfb8 (diff)
Remove show_palette_values
Add legend flag to display the legend Set rips threshold to 0.3 for users not to be surprised when playing with threshold git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_2.1.0_fix_vincent@3406 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 03999711eafb81748a82b5725482a9f0d4307861
Diffstat (limited to 'src/cython/doc')
-rw-r--r--src/cython/doc/persistence_graphical_tools_ref.rst1
-rw-r--r--src/cython/doc/persistence_graphical_tools_user.rst22
-rwxr-xr-xsrc/cython/doc/pyplots/diagram_persistence.py2
-rwxr-xr-xsrc/cython/doc/pyplots/show_palette_values.py3
4 files changed, 3 insertions, 25 deletions
diff --git a/src/cython/doc/persistence_graphical_tools_ref.rst b/src/cython/doc/persistence_graphical_tools_ref.rst
index 27c2f68a..a69c8ba2 100644
--- a/src/cython/doc/persistence_graphical_tools_ref.rst
+++ b/src/cython/doc/persistence_graphical_tools_ref.rst
@@ -3,6 +3,5 @@ Persistence graphical tools reference manual
============================================
.. autofunction:: gudhi.__min_birth_max_death
-.. autofunction:: gudhi.show_palette_values
.. autofunction:: gudhi.plot_persistence_barcode
.. autofunction:: gudhi.plot_persistence_diagram
diff --git a/src/cython/doc/persistence_graphical_tools_user.rst b/src/cython/doc/persistence_graphical_tools_user.rst
index 290b13c3..46f871c7 100644
--- a/src/cython/doc/persistence_graphical_tools_user.rst
+++ b/src/cython/doc/persistence_graphical_tools_user.rst
@@ -5,24 +5,6 @@ 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
- plt = gudhi.show_palette_values(alpha=1.0)
- plt.show()
-
-.. plot::
-
- import gudhi
- plt = gudhi.show_palette_values(alpha=1.0)
- plt.show()
-
Show persistence as a barcode
-----------------------------
@@ -59,7 +41,7 @@ This function can display the persistence result as a diagram:
import gudhi
point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + '/data/points/tore3D_1307.off')
- rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2)
+ rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3)
simplex_tree = rips_complex.create_simplex_tree(max_dimension=3)
diag = simplex_tree.persistence()
plt = gudhi.plot_persistence_diagram(diag)
@@ -70,7 +52,7 @@ This function can display the persistence result as a diagram:
import gudhi
point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + '/data/points/tore3D_1307.off')
- rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2)
+ rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3)
simplex_tree = rips_complex.create_simplex_tree(max_dimension=3)
diag = simplex_tree.persistence()
plt = gudhi.plot_persistence_diagram(diag)
diff --git a/src/cython/doc/pyplots/diagram_persistence.py b/src/cython/doc/pyplots/diagram_persistence.py
index 5abf52b9..3bab0ca1 100755
--- a/src/cython/doc/pyplots/diagram_persistence.py
+++ b/src/cython/doc/pyplots/diagram_persistence.py
@@ -2,7 +2,7 @@ import gudhi
point_cloud = gudhi.read_off(off_file=gudhi.__root_source_dir__ + \
'/data/points/tore3D_1307.off')
-rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.2)
+rips_complex = gudhi.RipsComplex(points=point_cloud, max_edge_length=0.3)
simplex_tree = rips_complex.create_simplex_tree(max_dimension=3)
diag = simplex_tree.persistence()
plt = gudhi.plot_persistence_diagram(diag)
diff --git a/src/cython/doc/pyplots/show_palette_values.py b/src/cython/doc/pyplots/show_palette_values.py
deleted file mode 100755
index fdf9645f..00000000
--- a/src/cython/doc/pyplots/show_palette_values.py
+++ /dev/null
@@ -1,3 +0,0 @@
-import gudhi
-plt = gudhi.show_palette_values(alpha=1.0)
-plt.show()