From 03f7d661f8b5d34320a075a826c0bfeafa16633f Mon Sep 17 00:00:00 2001
From: cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Thu, 1 Jun 2017 14:55:10 +0000
Subject: Doc for "pers" file format

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2500 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 2da948fefffcb1961961e3111c89f400f23b65d3
---
 src/common/doc/main_page.h | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h
index bd4615f5..fba0a858 100644
--- a/src/common/doc/main_page.h
+++ b/src/common/doc/main_page.h
@@ -152,6 +152,27 @@
 </table>
  
  \section Toolbox Toolbox
+ \subsection FileFormats File Formats
+ \subsubsection FileFormatsPers Persistence Diagram
+
+ 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}
+   [[field] dimension] birth death
+ \endcode
+
+ Here is a simple sample file:
+ \code{.unparsed}
+   # Beautiful persistence diagram
+   2 2.7 3.7
+   2 9.6 14.
+   3 34.2 34.974
+   4 3. inf
+ \endcode
+
+ Other sample files can be found in the `data/persistence_diagram`.
+
  \subsection BottleneckDistanceToolbox Bottleneck distance
  \image html "perturb_pd.png" "Bottleneck distance is the length of the longest edge"
 <table border="0">
-- 
cgit v1.2.3