summaryrefslogtreecommitdiff
path: root/src/Alpha_complex
diff options
context:
space:
mode:
authorcjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-11-22 15:44:09 +0000
committercjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-11-22 15:44:09 +0000
commitf23c94a1f79b5157d2468c9a1eea50b04873c638 (patch)
tree09cc8e2d43a10c0a821775979d5358345b5c6aee /src/Alpha_complex
parentd8ffa0a560d22b3bb78d87a8f8e3c18811c9dbda (diff)
Part of the doc disappeared during the homogenization...
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/add_utils_in_gudhi_v2@2939 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 1381b0362d36dbd1ed67c180f5488b05f4784624
Diffstat (limited to 'src/Alpha_complex')
-rw-r--r--src/Alpha_complex/utilities/README23
1 files changed, 14 insertions, 9 deletions
diff --git a/src/Alpha_complex/utilities/README b/src/Alpha_complex/utilities/README
index c3dd170b..cc3b2524 100644
--- a/src/Alpha_complex/utilities/README
+++ b/src/Alpha_complex/utilities/README
@@ -8,9 +8,12 @@ This program computes the persistent homology with coefficient field Z/pZ of the
where `dim` is the dimension of the homological feature, `b` and `d` 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_3d_persistence [options] <OFF input file>`
+`alpha_complex_3d_persistence [options] <input OFF file>`
+where
+`<input OFF file>` is the path to the input point cloud in OFF format.
**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.
* `-p [ --field-charac ]` (default=11) Characteristic p of the coefficient field Z/pZ for computing homology.
@@ -50,9 +53,13 @@ Same as `alpha_complex_3d_persistence`, but using exact computation. It is slowe
Same as `alpha_complex_3d_persistence`, but using weighted points.
**Usage**
-`weighted_alpha_complex_3d_persistence [options] <OFF input file> <weights input file>`
+`weighted_alpha_complex_3d_persistence [options] <input OFF file> <weights input file>`
+where
+`<input OFF file>` is the path to the input point cloud in OFF format.
+`<input weights file>` is the path to the file containing the weights of the points (one value per line).
**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.
* `-p [ --field-charac ]` (default=11) Characteristic p of the coefficient field Z/pZ for computing homology.
@@ -80,17 +87,13 @@ and [Regular triangulation](https://doc.cgal.org/latest/Triangulation_3/index.ht
Same as `alpha_complex_3d_persistence`, but using periodic alpha shape 3d.
**Usage**
-`periodic_alpha_complex_3d_persistence <input OFF file> <cuboid file> <p> <min_persistence>`
+`periodic_alpha_complex_3d_persistence [options] <input OFF file> <cuboid file>`
where
`<input OFF file>` is the path to the input point cloud in OFF format.
`<cuboid file>` is the path to the file describing the periodic domain. It must be in the format described [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsIsoCuboid).
-`<p>` is the characteristic p of the coefficient field *Z/pZ* for computing homology. It must be a stricly positive integer.
-`<min_persistence>` is the minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.
-
-**Usage**
-`./periodic_alpha_complex_3d_persistence [options] input-file cuboid-file`
**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.
* `-p [ --field-charac ]` (default=11) Characteristic p of the coefficient field Z/pZ for computing homology.
@@ -137,7 +140,9 @@ This program computes the persistent homology with coefficient field Z/pZ of the
where `dim` is the dimension of the homological feature, `b` and `d` 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] <OFF input file>`
+`alpha_complex_persistence [options] <input OFF file>`
+where
+`<input OFF file>` is the path to the input point cloud in OFF format.
**Allowed options**