diff options
Diffstat (limited to 'src/Rips_complex/utilities/README')
| -rw-r--r-- | src/Rips_complex/utilities/README | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/Rips_complex/utilities/README b/src/Rips_complex/utilities/README index ca10424d..4d20c806 100644 --- a/src/Rips_complex/utilities/README +++ b/src/Rips_complex/utilities/README @@ -3,9 +3,9 @@ ## `rips_persistence` ## 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` +`p dim birth death` -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). +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** `rips_persistence [options] <OFF input file>` @@ -19,6 +19,8 @@ where `dim` is the dimension of the homological feature, `b` and `d` are respect * `-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. +Beware: this program may use a lot of RAM and take a lot of time if `max-edge-length` is set to a large value. + **Example 1 with Z/2Z coefficients** `rips_persistence ../../data/points/tore3D_1307.off -r 0.25 -m 0.5 -d 3 -p 2` @@ -46,7 +48,12 @@ outputs: ## `rips_distance_matrix_persistence` ## -Same as `rips_persistence` but taking a distance matrix as input. +Same as `rips_persistence` but taking a distance matrix as input.
+
+**Usage** +`rips_persistence [options] <CSV input file>`
+where
+`<CSV input file>` is the path to the file containing a distance matrix. Can be square or lower triangular matrix. Separator is ';'. **Example** `rips_distance_matrix_persistence data/distance_matrix/full_square_distance_matrix.csv -r 15 -d 3 -p 3 -m 0` |