summaryrefslogtreecommitdiff
path: root/utilities/Bitmap_cubical_complex/cubicalcomplex.md
diff options
context:
space:
mode:
authorGard Spreemann <gspreemann@gmail.com>2018-02-02 14:05:27 +0100
committerGard Spreemann <gspreemann@gmail.com>2018-02-02 14:05:27 +0100
commitdf9caafd97960a610906a79cf40ba52e40c6cf48 (patch)
treea9c0b0330239e6438510432b0ba78f35799224d9 /utilities/Bitmap_cubical_complex/cubicalcomplex.md
parent5bb200877fac0090032b9d56b782d2ae361efa9b (diff)
parent8e51c74d8855a641c006765ee246402e218828f3 (diff)
Merge branch 'dfsg/latest' into debian/sid
Diffstat (limited to 'utilities/Bitmap_cubical_complex/cubicalcomplex.md')
-rw-r--r--utilities/Bitmap_cubical_complex/cubicalcomplex.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/utilities/Bitmap_cubical_complex/cubicalcomplex.md b/utilities/Bitmap_cubical_complex/cubicalcomplex.md
new file mode 100644
index 00000000..6e1b2578
--- /dev/null
+++ b/utilities/Bitmap_cubical_complex/cubicalcomplex.md
@@ -0,0 +1,29 @@
+
+
+# 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](/doc/latest/fileformats.html#FileFormatsPerseus) for a description of the file format.
+
+**Example**
+
+```
+ cubical_complex_persistence data/bitmap/CubicalTwoSphere.txt
+```
+
+* Creates 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`.
+
+## periodic_cubical_complex_persistence ##
+
+Same as above, but with periodic boundary conditions.
+
+**Example**
+
+```
+ periodic_cubical_complex_persistence data/bitmap/3d_torus.txt
+```
+
+* Creates 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`.