diff options
Diffstat (limited to 'src/Rips_complex/utilities/README')
| -rw-r--r-- | src/Rips_complex/utilities/README | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/src/Rips_complex/utilities/README b/src/Rips_complex/utilities/README index 4d20c806..40fc58ba 100644 --- a/src/Rips_complex/utilities/README +++ b/src/Rips_complex/utilities/README @@ -72,3 +72,39 @@ The complex contains 46 simplices 3 1 11 12.0416 3 1 6.32456 6.7082 ``` + + + + +## `rips_persistence` ## +This program computes the persistent homology with coefficient field *Z/pZ* +of a sparse (1+epsilon)-approximation of the 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 (`p` must be a prime number). + +**Usage** +`sparse_rips_persistence [options] <OFF input 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. +* `-e [ --approximation ]` (default = .5) Epsilon, where the sparse Rips complex is a (1+epsilon)-approximation of the Rips complex. +* `-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. + +**Example with Z/2Z coefficients** +`rips_persistence ../../data/points/tore3D_1307.off -e .5 -m .1 -d 3 -p 2` + +outputs: +``` +The complex contains 16742034 simplices + and has dimension 3 +2 0 0 inf +2 1 0.0521735 0.645093 +2 2 0.0691677 0.289148 +2 1 0.0491747 0.265232 +``` |