summaryrefslogtreecommitdiff
path: root/src/cython/doc/fileformats.rst
diff options
context:
space:
mode:
authorVincent Rouvreau <VincentRouvreau@users.noreply.github.com>2019-06-06 11:16:38 +0200
committerGitHub <noreply@github.com>2019-06-06 11:16:38 +0200
commitb858862d63ffcdcaed0e0a4913f5d9d42bc0dcbb (patch)
tree9f09a820a819fe2886d7050c71cf41a4aa35a3d5 /src/cython/doc/fileformats.rst
parentb9ddc3b6f1501fc15e84a8bea5927adae6623e5a (diff)
parentef5fcf9e54e0c14f7c2e7eebb5c24fb91018606a (diff)
Merge pull request #66 from VincentRouvreau/small_fixes
Small fixes
Diffstat (limited to 'src/cython/doc/fileformats.rst')
-rw-r--r--src/cython/doc/fileformats.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/cython/doc/fileformats.rst b/src/cython/doc/fileformats.rst
index e205cc8b..345dfdba 100644
--- a/src/cython/doc/fileformats.rst
+++ b/src/cython/doc/fileformats.rst
@@ -5,6 +5,35 @@
File formats
############
+OFF file format
+***************
+
+OFF files must be conform to format described here:
+http://www.geomview.org/docs/html/OFF.html
+
+OFF files are mainly used as point cloud inputs. Here is an example of 7 points
+in a 3-dimensional space. As edges and faces are not used for point set, there
+is no need to specify them (just set their numbers to 0):
+
+.. literalinclude:: ../../data/points/alphacomplexdoc.off
+
+.. centered:: ../../points/alphacomplexdoc.off
+
+For dimensions bigger than 3, the dimension can be set like here::
+
+ # Dimension is no more 3
+ nOFF
+ # dimension 4 - 7 vertices - 0 face - 0 edge
+ 4 7 0 0
+ # Point set:
+ 1.0 1.0 0.0 0.0
+ 7.0 0.0 0.0 0.0
+ 4.0 6.0 0.0 0.0
+ 9.0 6.0 0.0 0.0
+ 0.0 14.0 0.0 0.0
+ 2.0 19.0 0.0 0.0
+ 9.0 17.0 0.0 0.0
+
Persistence Diagram
*******************