diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2019-09-10 11:23:03 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-10 11:23:03 +0200 |
| commit | 9d5ddcac38d43c9df813c0ca4a37b7dc48c68913 (patch) | |
| tree | d6e893623f5c621a2bd356bc053d7c0d71aa9234 /src/python/doc/alpha_complex_sum.inc | |
| parent | f510a7e607b46ba8cc118cd787ff9b0b8bff091f (diff) | |
| parent | 2a313b489f1412f7e9d65681cea622d88828cba3 (diff) | |
Merge pull request #91 from VincentRouvreau/split_gudhi_python_in_modules
Split gudhi python in modules
Diffstat (limited to 'src/python/doc/alpha_complex_sum.inc')
| -rw-r--r-- | src/python/doc/alpha_complex_sum.inc | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/python/doc/alpha_complex_sum.inc b/src/python/doc/alpha_complex_sum.inc new file mode 100644 index 00000000..c5ba9dc7 --- /dev/null +++ b/src/python/doc/alpha_complex_sum.inc @@ -0,0 +1,20 @@ +.. table:: + :widths: 30 50 20 + + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | .. figure:: | Alpha complex is a simplicial complex constructed from the finite | :Author: Vincent Rouvreau | + | ../../doc/Alpha_complex/alpha_complex_representation.png | cells of a Delaunay Triangulation. | | + | :alt: Alpha complex representation | | :Introduced in: GUDHI 2.0.0 | + | :figclass: align-center | The filtration value of each simplex is computed as the square of the | | + | | circumradius of the simplex if the circumsphere is empty (the simplex | :Copyright: MIT (`GPL v3 </licensing/>`_) | + | | is then said to be Gabriel), and as the minimum of the filtration | | + | | values of the codimension 1 cofaces that make it not Gabriel | :Requires: `Eigen <installation.html#eigen>`__ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 | + | | otherwise. All simplices that have a filtration value strictly | | + | | greater than a given alpha squared value are not inserted into the | | + | | complex. | | + | | | | + | | This package requires having CGAL version 4.7 or higher (4.8.1 is | | + | | advised for better performance). | | + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | * :doc:`alpha_complex_user` | * :doc:`alpha_complex_ref` | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |