Skip to content

Commit b772502

Browse files
committed
chore: better docstrings
1 parent dde27bd commit b772502

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

vesskel/thin.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ def lee94_thin(img):
1111
----------
1212
img : ndarray
1313
2D binary image or 3D binary volume (0=background, 1=foreground).
14-
verbose : bool, optional
15-
Passed through to the underlying implementation.
1614
1715
Returns
1816
-------

vesskel/thin_3d.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,23 @@ def _compute_thin_image(img):
402402

403403

404404
def thin_3d(img):
405-
"""Lee94 thinning algorithm for a 3D binary volume."""
405+
"""Lee94 thinning algorithm for a 3D binary volume.
406+
407+
Parameters
408+
----------
409+
img : ndarray
410+
3D binary volume (0=background, 1=foreground).
411+
412+
Returns
413+
-------
414+
ndarray
415+
Thinned binary volume with the same shape as img.
416+
417+
Raises
418+
------
419+
ValueError
420+
If input is not 3-dimensional.
421+
"""
406422
if img.ndim != 3:
407423
raise ValueError(f"Expected 3D input, got {img.ndim}D")
408424

0 commit comments

Comments
 (0)