diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-08-06 15:59:47 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-08-06 15:59:47 +0000 |
| commit | 5b379171cdbf289bdf4f6c6f9b1e674a5ea5c6c3 (patch) | |
| tree | 2982313cd808c7313c16b23188a18a5b9d8500f7 /src/cython | |
| parent | 56f95db1b23194b98a2e822d68a9e83ab214cd3d (diff) | |
Fix issue #15 : [python - subsampling] sparsify_point_set wrong documentation
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3742 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: fcb4ba73cb1c4527a9f772bb9412f5e15c4eafaa
Diffstat (limited to 'src/cython')
| -rw-r--r-- | src/cython/cython/subsampling.pyx | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/cython/cython/subsampling.pyx b/src/cython/cython/subsampling.pyx index ac09b7a3..e9d61a37 100644 --- a/src/cython/cython/subsampling.pyx +++ b/src/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]] """ |