summaryrefslogtreecommitdiff
path: root/cython/cython/subsampling.pyx
diff options
context:
space:
mode:
authorGard Spreemann <gspreemann@gmail.com>2018-09-05 12:52:26 +0200
committerGard Spreemann <gspreemann@gmail.com>2018-09-05 12:52:26 +0200
commitef5c01b599c6a6b23b1f3e92736ec67a6e62b55f (patch)
tree593f9ca6e7b661645f27243619652953b11e8a4f /cython/cython/subsampling.pyx
parentc524232f734de875d69e2f190f01a6c976024368 (diff)
GUDHI 2.3.0 as released by upstream in a tarball.upstream/2.3.0upstream/latest
Diffstat (limited to 'cython/cython/subsampling.pyx')
-rw-r--r--cython/cython/subsampling.pyx8
1 files changed, 5 insertions, 3 deletions
diff --git a/cython/cython/subsampling.pyx b/cython/cython/subsampling.pyx
index ac09b7a3..e9d61a37 100644
--- a/cython/cython/subsampling.pyx
+++ b/cython/cython/subsampling.pyx
@@ -112,7 +112,8 @@ def pick_n_random_points(points=None, off_file='', nb_points=0):
return subsampling_n_random_points(points, nb_points)
def sparsify_point_set(points=None, off_file='', min_squared_dist=0.0):
- """Subsample a point set by picking random vertices.
+ """Outputs a subset of the input points so that the squared distance
+ between any two points is greater than or equal to min_squared_dist.
:param points: The input point set.
:type points: vector[vector[double]].
@@ -122,8 +123,9 @@ def sparsify_point_set(points=None, off_file='', min_squared_dist=0.0):
:param off_file: An OFF file style name.
:type off_file: string
- :param min_squared_dist: Number of points of the subsample.
- :type min_squared_dist: unsigned.
+ :param min_squared_dist: Minimum squared distance separating the output \
+ points.
+ :type min_squared_dist: float.
:returns: The subsample point set.
:rtype: vector[vector[double]]
"""