search

meyerls / pc-skeletor

Skeletonization of 3D Point Clouds
MIT License
151 stars 18 forks source link

Define down_sample in the Skeletonizer docstring #4

Closed FranzEricSchneider closed 1 year ago

FranzEricSchneider commented 1 year ago

I tried checking out the Skeletonizer help text in order to find out what down_sample does, but had to search in the source code to find out so I added an explanation in the docstring. Thanks for the useful library!

What the help text is currently:

In [5]: skeletor.Skeletonizer?
Init signature:
skeletor.Skeletonizer(
    point_cloud: [<class 'open3d.cpu.pybind.geometry.PointCloud'>, <class 'str'>],
    debug: bool,
    down_sample: float = 0.005,
)
Docstring:     
1. Laplacian based contraction.
    Paper: https://taiya.github.io/pubs/cao2010cloudcontr.pdf
    Code: https://github.com/taiya/cloudcontr
2. Source:
    Paper: https://www.cs.sfu.ca/~haoz/pubs/huang_sig13_l1skel.pdf
    Code: https://github.com/HongqiangWei/L1-Skeleton
Init docstring:
:param point_cloud:
:param debug:
:param down_sample:
File:           /usr/local/lib/python3.8/dist-packages/pc_skeletor/skeletor.py
Type:           type