summaryrefslogtreecommitdiff
path: root/src/common/utilities/README
diff options
context:
space:
mode:
authorcjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-31 09:25:27 +0000
committercjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-31 09:25:27 +0000
commitbbe2c8670f84862dcc2b791f66cd1a668e295a81 (patch)
tree683d40ca5117da61ea1e0fab617378deb84d2368 /src/common/utilities/README
parent6d4b5ec65b863abb5b183635a0e64341c19e7b4b (diff)
parent7035590cdfd71eb7454d638f3b479d62a0ebadf4 (diff)
Merge from trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2482 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 5487cc3f399d42f736ec008f40c4082d51e3f683
Diffstat (limited to 'src/common/utilities/README')
-rw-r--r--src/common/utilities/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/common/utilities/README b/src/common/utilities/README
new file mode 100644
index 00000000..dc841521
--- /dev/null
+++ b/src/common/utilities/README
@@ -0,0 +1,19 @@
+======================= off_file_from_shape_generator ==================================
+
+Example of use :
+
+*** on|in sphere|cube|curve|torus|klein generator
+
+./off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2
+
+ => generates a 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 a 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 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
+
+!! Warning: hypegenerator on cube is not available !!