diff options
author | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-06-09 11:20:13 +0000 |
---|---|---|
committer | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-06-09 11:20:13 +0000 |
commit | 93c97a9a93b930a2f3c1c119d9e4d2567c54dacc (patch) | |
tree | 8d775aacc4daecfeb0a35ff27ee0aa9201545106 | |
parent | 4918b9c752a2d269678791dc4772ae9276539051 (diff) |
Create a new page for file formats
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2534 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: dc0d836b9df68a3f339dcbc6b8ff51577faf3d7b
-rw-r--r-- | src/common/doc/file_formats.h | 25 | ||||
-rw-r--r-- | src/common/doc/main_page.h | 23 |
2 files changed, 27 insertions, 21 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h new file mode 100644 index 00000000..1f7ba201 --- /dev/null +++ b/src/common/doc/file_formats.h @@ -0,0 +1,25 @@ +/*! \page fileformats File formats + + \tableofcontents + + \section 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` folder. + +*/
\ No newline at end of file diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index fba0a858..b7f93ed2 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -152,27 +152,7 @@ </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"> @@ -489,3 +469,4 @@ make doxygen * @example Witness_complex/example_witness_complex_sphere.cpp */ +#include "file_formats.h"
\ No newline at end of file |