diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-21 08:38:45 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-21 08:38:45 +0000 |
commit | 36784120de86410bfbe51c563910df0d8718e2e9 (patch) | |
tree | c165cd33bc07e3134ce1473408ed91afb60e6e79 /src/Bottleneck_distance/example/README | |
parent | dc231e43e7d741e5e477de23140bf3b8982489ab (diff) | |
parent | c0c455e0afca340c70c5516ab19e0c44d961211e (diff) |
Merge add_utils_in_gudhi_v2 branch in trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2925 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 7e7153337bed2b1641bb80c6c532d07f526f5b10
Diffstat (limited to 'src/Bottleneck_distance/example/README')
-rw-r--r-- | src/Bottleneck_distance/example/README | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/example/README b/src/Bottleneck_distance/example/README new file mode 100644 index 00000000..0e314608 --- /dev/null +++ b/src/Bottleneck_distance/example/README @@ -0,0 +1,19 @@ +# Bottleneck_distance #
+
+## `alpha_rips_persistence_bottleneck_distance` ##
+This program computes the persistent homology with coefficient field Z/pZ of a Rips complex defined on a set of input points. The output diagram contains one bar per line, written with the convention:
+
+`p dim b d`
+
+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.
+
+Usage:
+`alpha_rips_persistence_bottleneck_distance [options] <OFF input file>`
+
+Allowed options:
+
+* `-h [ --help ]` Produce help message
+* `-r [ --max-edge-length ]` (default = inf) Maximal length of an edge for the Rips complex construction.`
+* `-d [ --cpx-dimension ]` (default = 1) Maximal dimension of the Rips complex we want to compute.`
+* `-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.
|