diff options
Diffstat (limited to 'src/Bottleneck_distance/utilities/README')
| -rw-r--r-- | src/Bottleneck_distance/utilities/README | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/src/Bottleneck_distance/utilities/README b/src/Bottleneck_distance/utilities/README index 4c9b0735..cfdccf0b 100644 --- a/src/Bottleneck_distance/utilities/README +++ b/src/Bottleneck_distance/utilities/README @@ -1,19 +1,10 @@ # 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.
+## `bottleneck_read_file_example` ##
+This program computes the Bottleneck distance between two persistence diagram files.
Usage:
-`alpha_rips_persistence_bottleneck_distance [options] <OFF input file>`
-
-Allowed options:
+`bottleneck_read_file_example <file_1.pers> <file_2.pers> [<tolerance>]`
-* `-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.
\ No newline at end of file +<file_1.pers> and <file_2.pers> must be in the format described [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPers).
+<tolerance> is an error bound on the bottleneck distance (set by default to the smallest positive double value).
|