Skip to content

Commit 7af51d5

Browse files
docs: describe how the function will modify the skeletons
1 parent 23f2daa commit 7af51d5

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

kimimaro/utility.py

+15
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,21 @@ def cross_sectional_area(
5858
vectors will be smoothed with a rolling average. This
5959
is useful since there can be high frequency
6060
oscillations in the skeleton.
61+
62+
This function will add the following attributes to
63+
each skeleton provided.
64+
65+
skel.cross_sectional_area: float32 array of cross
66+
sectional area per a vertex.
67+
68+
skel.cross_sectional_area_contacts: uint8 array
69+
where non-zero entries indicate that the image
70+
border was contacted during the cross section
71+
computation, indicating a possible underestimate.
72+
73+
The first six bits are a bitfield xxyyzz that
74+
tell you which image faces were touched and
75+
alternate from low (0) to high (size-1).
6176
"""
6277
prop = {
6378
"id": "cross_sectional_area",

0 commit comments

Comments
 (0)