summaryrefslogtreecommitdiff
path: root/src/Bitmap_cubical_complex/utilities/README
blob: 1d6b34ff10d1d5539f5a645ec3627b220d69942f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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 the "Input Format" section of the [User Manual](http://gudhi.gforge.inria.fr/doc/latest/group__cubical__complex.html) 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`