diff options
author | Gard Spreemann <gspreemann@gmail.com> | 2017-10-09 10:47:31 +0200 |
---|---|---|
committer | Gard Spreemann <gspreemann@gmail.com> | 2017-10-09 10:47:31 +0200 |
commit | 673b6bb63befd7e591e52c13f43e5db53e5b29bd (patch) | |
tree | 3f15d96ef39bf0c6cf656d176ff1c437cacf5988 /cython/doc/fileformats.rst | |
parent | 9466ce44e348487fc04a1fda493ed659ae92b775 (diff) | |
parent | 866f6ce614e9c09c97fed12c8c0c2c9fb84fad3f (diff) |
Merge tag 'upstream/2.0.1' into dfsg/latest
Upstream's 2.0.1 release.
Diffstat (limited to 'cython/doc/fileformats.rst')
-rw-r--r-- | cython/doc/fileformats.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/cython/doc/fileformats.rst b/cython/doc/fileformats.rst new file mode 100644 index 00000000..156ef4e4 --- /dev/null +++ b/cython/doc/fileformats.rst @@ -0,0 +1,33 @@ +File formats +############ + +Persistence Diagram +******************* + +Such a file, whose extension is usually ``.pers``, contains a list of +persistence intervals. + +Lines starting with ``#`` are ignored (comments). + +Other lines might contain 2, 3 or 4 values (the number of values on each line +must be the same for all lines):: + + [[field] dimension] birth death + +Here is a simple sample file:: + + # Persistence diagram example + 2 2.7 3.7 + 2 9.6 14. + # Some comments + 3 34.2 34.974 + 4 3. inf + +Other sample files can be found in the data/persistence_diagram folder. + +Such files can be generated with +:meth:`gudhi.SimplexTree.write_persistence_diagram`, read with +:meth:`gudhi.read_persistence_intervals_grouped_by_dimension`, or +:meth:`gudhi.read_persistence_intervals_in_dimension` and displayed with +:meth:`gudhi.plot_persistence_barcode` or +:meth:`gudhi.plot_persistence_diagram`. |