summaryrefslogtreecommitdiff
path: root/src/Bitmap_cubical_complex/utilities/README
blob: 393b2654bcc79e668cfe5a3c743bd6329de26318 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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`.