summaryrefslogtreecommitdiff
path: root/src/common/doc
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-11 20:31:22 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-11 20:31:22 +0000
commitc2ee3f09c901eb3cefa8635ae69564be99d73e90 (patch)
tree718acdc021246eee993164220826f0b6cdcc8488 /src/common/doc
parentde09c3d3a8c86b1538f66c674f6f9819abec16cc (diff)
parentff75dab4aa40bcea9400f861bbdf1bd133f892d1 (diff)
Merge last trunk modifications
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/graph_expansion_with_blocker_oracle@2661 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 2625074cdd2104ead455753c2f2fb8583be89478
Diffstat (limited to 'src/common/doc')
-rw-r--r--src/common/doc/file_formats.h19
1 files changed, 12 insertions, 7 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
index c145b271..d715aa4d 100644
--- a/src/common/doc/file_formats.h
+++ b/src/common/doc/file_formats.h
@@ -2,7 +2,7 @@
* (Geometric Understanding in Higher Dimensions) is a generic C++
* library for computational topology.
*
-* Author(s): Clément Jamin
+* Author(s): Clément Jamin
*
* Copyright (C) 2017 INRIA
*
@@ -26,7 +26,7 @@
namespace Gudhi {
/*! \page fileformats File formats
-
+
\tableofcontents
\section FileFormatsPers Persistence Diagram
@@ -34,20 +34,25 @@ namespace Gudhi {
Such a file, whose extension is usually `.pers`, contains a list of persistence intervals.<br>
Lines starting with `#` are ignored (comments).<br>
Other lines might contain 2, 3 or 4 values (the number of values on each line must be the same for all lines):
- \code{.unparsed}
+ \verbatim
[[field] dimension] birth death
- \endcode
+ \endverbatim
Here is a simple sample file:
- \code{.unparsed}
- # Beautiful persistence diagram
+ \verbatim
+ # Persistence diagram example
2 2.7 3.7
2 9.6 14.
+ # Some comments
3 34.2 34.974
4 3. inf
- \endcode
+ \endverbatim
Other sample files can be found in the `data/persistence_diagram` folder.
+
+ Such files can be generated with `Gudhi::persistent_cohomology::Persistent_cohomology::output_diagram()` and read with
+ `Gudhi::read_persistence_intervals_and_dimension()`, `Gudhi::read_persistence_intervals_grouped_by_dimension()` or
+ `Gudhi::read_persistence_intervals_in_dimension()`.
*/
} // namespace Gudhi