diff options
Diffstat (limited to 'src/cython/doc')
| -rw-r--r-- | src/cython/doc/alpha_complex_sum.rst | 4 | ||||
| -rwxr-xr-x | src/cython/doc/conf.py | 4 | ||||
| -rw-r--r-- | src/cython/doc/cubical_complex_sum.rst | 2 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_ref.rst | 8 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_sum.rst | 13 | ||||
| -rw-r--r-- | src/cython/doc/persistence_graphical_tools_user.rst | 46 | ||||
| -rw-r--r-- | src/cython/doc/persistent_cohomology_sum.rst | 2 | ||||
| -rwxr-xr-x | src/cython/doc/pyplots/diagram_persistence.py | 1 | ||||
| -rw-r--r-- | src/cython/doc/simplex_tree_sum.rst | 2 | ||||
| -rw-r--r-- | src/cython/doc/witness_complex_sum.rst | 2 |
10 files changed, 76 insertions, 8 deletions
diff --git a/src/cython/doc/alpha_complex_sum.rst b/src/cython/doc/alpha_complex_sum.rst index b608050e..b3689556 100644 --- a/src/cython/doc/alpha_complex_sum.rst +++ b/src/cython/doc/alpha_complex_sum.rst @@ -1,5 +1,7 @@ ===================================== ===================================== ===================================== -:Author: Vincent Rouvreau :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +:Author: Vincent Rouvreau :Introduced in: GUDHI 1.3.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== +:Requires: CGAL &ge 4.7.0 Eigen3 ===================================== ===================================== ===================================== +-------------------------------------------+----------------------------------------------------------------------+ diff --git a/src/cython/doc/conf.py b/src/cython/doc/conf.py index 8d6483af..8b42ce37 100755 --- a/src/cython/doc/conf.py +++ b/src/cython/doc/conf.py @@ -67,9 +67,9 @@ copyright = u'2016, Vincent Rouvreau' # built documents. # # The short X.Y version. -version = '1.3.1' +version = '1.4.beta' # The full version, including alpha/beta/rc tags. -release = '1.3.1' +release = '1.4.beta' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/src/cython/doc/cubical_complex_sum.rst b/src/cython/doc/cubical_complex_sum.rst index 4008a1fd..98e23849 100644 --- a/src/cython/doc/cubical_complex_sum.rst +++ b/src/cython/doc/cubical_complex_sum.rst @@ -1,5 +1,5 @@ ===================================== ===================================== ===================================== -:Author: Pawel Dlotko :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +:Author: Pawel Dlotko :Introduced in: GUDHI 1.3.0 :Copyright: GPL v3 ===================================== ===================================== ===================================== +---------------------------------------------+----------------------------------------------------------------------+ diff --git a/src/cython/doc/persistence_graphical_tools_ref.rst b/src/cython/doc/persistence_graphical_tools_ref.rst new file mode 100644 index 00000000..aa214edf --- /dev/null +++ b/src/cython/doc/persistence_graphical_tools_ref.rst @@ -0,0 +1,8 @@ +============================================ +Persistence graphical tools reference manual +============================================ + +.. automethod:: gudhi.__min_birth_max_death +.. automethod:: gudhi.show_palette_values +.. automethod:: gudhi.barcode_persistence +.. automethod:: gudhi.diagram_persistence
\ No newline at end of file diff --git a/src/cython/doc/persistence_graphical_tools_sum.rst b/src/cython/doc/persistence_graphical_tools_sum.rst new file mode 100644 index 00000000..a6260032 --- /dev/null +++ b/src/cython/doc/persistence_graphical_tools_sum.rst @@ -0,0 +1,13 @@ +===================================== ===================================== ===================================== +:Author: Vincent Rouvreau :Introduced in: GUDHI 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== +:Requires: Matplotlib Numpy +===================================== ===================================== ===================================== + ++---------------------------------------------+----------------------------------------------------------------------+ +| .. image:: | These graphical tools comes on top of persistence results and allows | +| img/graphical_tools_representation.png | the user to build easily barcode and persistence diagram. | +| | | ++---------------------------------------------+----------------------------------------------------------------------+ +| :doc:`persistence_graphical_tools_user` | * :doc:`persistence_graphical_tools_ref` | ++---------------------------------------------+----------------------------------------------------------------------+ 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) diff --git a/src/cython/doc/persistent_cohomology_sum.rst b/src/cython/doc/persistent_cohomology_sum.rst index 081399a5..b306b3d4 100644 --- a/src/cython/doc/persistent_cohomology_sum.rst +++ b/src/cython/doc/persistent_cohomology_sum.rst @@ -1,5 +1,5 @@ ===================================== ===================================== ===================================== -:Author: Clément Maria :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +:Author: Clément Maria :Introduced in: GUDHI 1.0.0 :Copyright: GPL v3 ===================================== ===================================== ===================================== +---------------------------------------------+----------------------------------------------------------------------+ diff --git a/src/cython/doc/pyplots/diagram_persistence.py b/src/cython/doc/pyplots/diagram_persistence.py index ceeeceb3..b006b0bf 100755 --- a/src/cython/doc/pyplots/diagram_persistence.py +++ b/src/cython/doc/pyplots/diagram_persistence.py @@ -1,6 +1,5 @@ import gudhi alpha_complex = gudhi.AlphaComplex(off_file='../tore3D_300.off') -alpha_complex.initialize_filtration() diag = alpha_complex.persistence() gudhi.diagram_persistence(diag) diff --git a/src/cython/doc/simplex_tree_sum.rst b/src/cython/doc/simplex_tree_sum.rst index ffdb2cf4..0f34888a 100644 --- a/src/cython/doc/simplex_tree_sum.rst +++ b/src/cython/doc/simplex_tree_sum.rst @@ -1,5 +1,5 @@ ===================================== ===================================== ===================================== -:Author: Clément Maria :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +:Author: Clément Maria :Introduced in: GUDHI 1.0.0 :Copyright: GPL v3 ===================================== ===================================== ===================================== +-------------------------------------------+----------------------------------------------------------------------+ diff --git a/src/cython/doc/witness_complex_sum.rst b/src/cython/doc/witness_complex_sum.rst index 0d65d420..005a5a41 100644 --- a/src/cython/doc/witness_complex_sum.rst +++ b/src/cython/doc/witness_complex_sum.rst @@ -1,5 +1,5 @@ ===================================== ===================================== ===================================== -:Author: Siargey Kachanovich :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +:Author: Siargey Kachanovich :Introduced in: GUDHI 1.3.0 :Copyright: GPL v3 ===================================== ===================================== ===================================== +---------------------------------------------+----------------------------------------------------------------------+ |