diff options
author | Gard Spreemann <gspr@nonempty.org> | 2019-09-25 14:53:36 +0200 |
---|---|---|
committer | Gard Spreemann <gspr@nonempty.org> | 2019-09-25 14:53:36 +0200 |
commit | 70ad5fc411b0e0a3d590ad281fc97d488994062b (patch) | |
tree | b0ddd84d7ee935936787eee2b75f78f2e21c41f0 /src/Bottleneck_distance/example/README | |
parent | b50046e487ab42cdef19b02128a9f498d6a36482 (diff) | |
parent | 5ccee32ec2ba38743c6b96867db3e1b5151e45e4 (diff) |
Merge branch 'dfsg/latest' into debian/sid
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..01bcd74a --- /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 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.
+
+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.
|