diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:34:16 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:34:16 +0000 |
| commit | c50ac9a8e5d1f506cc79b9c1e623228fffd545bf (patch) | |
| tree | 894e41f3f685000c95b54456bbdb935daaf1084d /src/Bitmap_cubical_complex/utilities/cubicalcomplex.md | |
| parent | c2d46e0e6cfea1927875219bd5e03962cef7b010 (diff) | |
Rename README files for web site generation conformity
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3177 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 632b264790c30accb42e731c4a4f6744a2f7ba11
Diffstat (limited to 'src/Bitmap_cubical_complex/utilities/cubicalcomplex.md')
| -rw-r--r-- | src/Bitmap_cubical_complex/utilities/cubicalcomplex.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/src/Bitmap_cubical_complex/utilities/cubicalcomplex.md b/src/Bitmap_cubical_complex/utilities/cubicalcomplex.md new file mode 100644 index 00000000..393b2654 --- /dev/null +++ b/src/Bitmap_cubical_complex/utilities/cubicalcomplex.md @@ -0,0 +1,40 @@ +---
+layout: page
+title: "Bitmap cubical complex"
+meta_title: "cubicalcomplex"
+subheadline: ""
+teaser: ""
+permalink: "/cubicalcomplex/"
+---
+{::comment}
+These flags above are here for web site generation, please let them.
+cf. https://gitlab.inria.fr/GUDHI/website
+Must be in conformity with _data/navigation.yml
+{:/comment}
+
+
+## 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**
+
+```
+ 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`.
|