summaryrefslogtreecommitdiff
path: root/src/common/doc/file_formats.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/doc/file_formats.h')
-rw-r--r--src/common/doc/file_formats.h25
1 files changed, 25 insertions, 0 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