diff options
author | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-06-01 14:55:10 +0000 |
---|---|---|
committer | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-06-01 14:55:10 +0000 |
commit | 03f7d661f8b5d34320a075a826c0bfeafa16633f (patch) | |
tree | 3850d15e140228e09491fd75d227ec9e499d4edf | |
parent | 8493f7a38001930329ec6204e6b3e8dff1c67df1 (diff) |
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
-rw-r--r-- | src/common/doc/main_page.h | 21 |
1 files changed, 21 insertions, 0 deletions
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"> |