Skip to content

Commit

Permalink
docs: describe how the function will modify the skeletons
Browse files Browse the repository at this point in the history
  • Loading branch information
william-silversmith committed Feb 8, 2024
1 parent 23f2daa commit 7af51d5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions kimimaro/utility.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,21 @@ def cross_sectional_area(
vectors will be smoothed with a rolling average. This
is useful since there can be high frequency
oscillations in the skeleton.
This function will add the following attributes to
each skeleton provided.
skel.cross_sectional_area: float32 array of cross
sectional area per a vertex.
skel.cross_sectional_area_contacts: uint8 array
where non-zero entries indicate that the image
border was contacted during the cross section
computation, indicating a possible underestimate.
The first six bits are a bitfield xxyyzz that
tell you which image faces were touched and
alternate from low (0) to high (size-1).
"""
prop = {
"id": "cross_sectional_area",
Expand Down

0 comments on commit 7af51d5

Please sign in to comment.