summaryrefslogtreecommitdiff
path: root/src/common
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-01-29 16:31:18 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-01-29 16:31:18 +0000
commitc2d46e0e6cfea1927875219bd5e03962cef7b010 (patch)
tree02e557494e9af34ecb761656e0dd713be03a0327 /src/common
parent81b06fad98ac4210c5b1d04dddeed628a8e0accb (diff)
Fix doc issue for utilities part on the web site
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3176 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 3bafd9e13a5646ca93023144705d3ac7ed7c9b3a
Diffstat (limited to 'src/common')
-rw-r--r--src/common/utilities/README46
1 files changed, 35 insertions, 11 deletions
diff --git a/src/common/utilities/README b/src/common/utilities/README
index 18fa8cc4..f39c63b8 100644
--- a/src/common/utilities/README
+++ b/src/common/utilities/README
@@ -1,19 +1,43 @@
-# Pointset generator #
+---
+layout: page
+title: "Pointset generator"
+meta_title: "pointsetgenerator"
+subheadline: ""
+teaser: ""
+permalink: "/pointsetgenerator/"
+---
+{::comment}
+These flags above are here for web site generation, please let them.
+cf. https://gitlab.inria.fr/GUDHI/website
+Must be in conformity with _data/navigation.yml
+{:/comment}
-## `off_file_from_shape_generator` ##
+## off_file_from_shape_generator ##
Generates a pointset and save it in an OFF file. Command-line is:
-`off_file_from_shape_generator on|in sphere|cube|curve|torus|klein <filename> <num_points> <dimension> <parameter1> <parameter2>...`
+
+```
+off_file_from_shape_generator on|in sphere|cube|curve|torus|klein <filename> <num_points> <dimension> <parameter1> <parameter2>...
+```
Warning: "on cube" generator is not available!
-Examples:
+**Examples**
+
+```
+off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2
+```
+
+* Generates an onSphere.off file with 1000 points randomized on a sphere of dimension 3 and radius 15.2.
+
+```
+off_file_from_shape_generator in sphere inSphere.off 100 2
+```
+
+* Generates an inSphere.off file with 100 points randomized in a sphere of dimension 2 (circle) and radius 1.0 (default).
-* Generate an onSphere.off file with 1000 points randomized on a sphere of dimension 3 and radius 15.2:
-`off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2`
-
-* Generate an inSphere.off file with 100 points randomized in a sphere of dimension 2 (circle) and radius 1.0 (default):
-`off_file_from_shape_generator in sphere inSphere.off 100 2`
+```
+off_file_from_shape_generator in cube inCube.off 10000 3 5.8
+```
-* Generates a inCube.off file with 10000 points randomized in a cube of dimension 3 and side 5.8:
-`off_file_from_shape_generator in cube inCube.off 10000 3 5.8`
+* Generates a inCube.off file with 10000 points randomized in a cube of dimension 3 and side 5.8.