diff options
Diffstat (limited to 'src/Bitmap_cubical_complex/utilities/README')
| -rw-r--r-- | src/Bitmap_cubical_complex/utilities/README | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/Bitmap_cubical_complex/utilities/README b/src/Bitmap_cubical_complex/utilities/README new file mode 100644 index 00000000..ddff7034 --- /dev/null +++ b/src/Bitmap_cubical_complex/utilities/README @@ -0,0 +1,18 @@ +# Bitmap_cubical_complex #
+
+## `cubical_complex_persistence` ##
+This program computes persistent homology, by using the Bitmap_cubical_complex class, of cubical complexes provided in text files in Perseus style. See [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPerseus) for a description of the file format.
+
+Example:
+
+* Create a Cubical Complex from the Perseus style file `CubicalTwoSphere.txt`, computes Persistence cohomology from it and writes the results in a persistence file `CubicalTwoSphere.txt_persistence`:
+`cubical_complex_persistence data/bitmap/CubicalTwoSphere.txt`
+
+## `periodic_cubical_complex_persistence` ##
+
+Same as above, but with periodic boundary conditions.
+
+Example:
+
+* Create a Periodical Cubical Complex from the Perseus style file `3d_torus.txt`, computes Persistence cohomology from it and writes the results in a persistence file `3d_torus.txt_persistence`:
+`periodic_cubical_complex_persistence data/bitmap/3d_torus.txt`
|