Fix after web review

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3189 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: fd42bab9b27a3c086adeaf75068c83a911ede000

1 files changed, 44 insertions, 56 deletions

diff --git a/src/Alpha_complex/utilities/alphacomplex.md b/src/Alpha_complex/utilities/alphacomplex.md
index 0e500e53..aace85d3 100644
--- a/src/Alpha_complex/utilities/alphacomplex.md
+++ b/src/Alpha_complex/utilities/alphacomplex.md
@@ -1,18 +1,47 @@
----

-layout: page

-title: "Alpha complex"

-meta_title: "alphacomplex"

-subheadline: ""

-teaser: ""

-permalink: "/alphacomplex/"

----

-{::comment}

-These flags above are here for web site generation, please let them.

-cf. https://gitlab.inria.fr/GUDHI/website

-Must be in conformity with _data/navigation.yml

-{:/comment}

 

 

+# Alpha complex #

+

+

+## alpha_complex_persistence ##

+

+This program computes the persistent homology with coefficient field Z/pZ of the dD alpha complex built from a dD point cloud.

+The output diagram contains one bar per line, written with the convention:

+

+```

+   p dim birth death

+```

+

+where `dim` is the dimension of the homological feature, `birth` and `death` are respectively the birth and death of the feature,

+and `p` is the characteristic of the field *Z/pZ* used for homology coefficients (`p` must be a prime number).

+

+**Usage**

+

+```

+   alpha_complex_persistence [options] <input OFF file>

+```

+

+where

+`<input OFF file>` is the path to the input point cloud in [nOFF ASCII format](http://www.geomview.org/docs/html/OFF.html).

+

+**Allowed options**

+

+* `-h [ --help ]` Produce help message

+* `-o [ --output-file ]` Name of file in which the persistence diagram is written. Default print in standard output.

+* `-r [ --max-alpha-square-value ]` (default = inf) Maximal alpha square value for the Alpha complex construction.

+* `-p [ --field-charac ]` (default = 11)     Characteristic p of the coefficient field Z/pZ for computing homology.

+* `-m [ --min-persistence ]` (default = 0) Minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.

+

+**Example**

+

+```

+   alpha_complex_persistence -r 32 -p 2 -m 0.45 ../../data/points/tore3D_300.off

+```

+

+N.B.:

+

+* Filtration values are alpha square values.

+

 

 ## alpha_complex_3d_persistence ##

 This program computes the persistent homology with coefficient field Z/pZ of the 3D alpha complex built from a 3D point cloud. The output diagram contains one bar per line, written with the convention:

@@ -107,7 +136,7 @@ where
 

 * `<input OFF file>` is the path to the input point cloud in [nOFF ASCII format](http://www.geomview.org/docs/html/OFF.html).

 * `<cuboid file>` is the path to the file describing the periodic domain. It must be in the format described

-[here](../doc/latest/fileformats.html#FileFormatsIsoCuboid).

+[here](/doc/latest/fileformats.html#FileFormatsIsoCuboid).

 

 **Allowed options**

 

@@ -125,46 +154,5 @@ periodic_alpha_complex_3d_persistence ../../data/points/grid_10_10_10_in_0_1.off
 

 N.B.:

 

-* Cuboid file must be in the format described [here](../doc/latest/fileformats.html#FileFormatsIsoCuboid).

-* Filtration values are alpha square values.

-

-

-

-## alpha_complex_persistence ##

-

-This program computes the persistent homology with coefficient field Z/pZ of the dD alpha complex built from a dD point cloud.

-The output diagram contains one bar per line, written with the convention:

-

-```

-   p dim birth death

-```

-

-where `dim` is the dimension of the homological feature, `birth` and `death` are respectively the birth and death of the feature,

-and `p` is the characteristic of the field *Z/pZ* used for homology coefficients (`p` must be a prime number).

-

-**Usage**

-

-```

-   alpha_complex_persistence [options] <input OFF file>

-```

-

-where

-`<input OFF file>` is the path to the input point cloud in [nOFF ASCII format](http://www.geomview.org/docs/html/OFF.html).

-

-**Allowed options**

-

-* `-h [ --help ]` Produce help message

-* `-o [ --output-file ]` Name of file in which the persistence diagram is written. Default print in standard output.

-* `-r [ --max-alpha-square-value ]` (default = inf) Maximal alpha square value for the Alpha complex construction.

-* `-p [ --field-charac ]` (default = 11)     Characteristic p of the coefficient field Z/pZ for computing homology.

-* `-m [ --min-persistence ]` (default = 0) Minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.

-

-**Example**

-

-```

-   alpha_complex_persistence -r 32 -p 2 -m 0.45 ../../data/points/tore3D_300.off

-```

-

-N.B.:

-

+* Cuboid file must be in the format described [here](/doc/latest/fileformats.html#FileFormatsIsoCuboid).

 * Filtration values are alpha square values.