Skip to content

Commit

Permalink
docs: describe voxel_graph parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
william-silversmith committed Dec 19, 2023
1 parent adc03de commit 05be05c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions python/edt.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,13 @@ def edt(
C order, otherwise if 'C' or 'F' is specified, it will copy it
into that layout.
parallel: number of threads to use (only applies to 2D and 3D)
voxel_graph: A numpy array where each voxel contains a bitfield that
represents a directed graph of the allowed directions for transit
between voxels. If a connection is allowed, the respective direction
is set to 1 else it set to 0.
See https://github.com/seung-lab/connected-components-3d/blob/master/cc3d.pyx#L743-L783
for details.
Returns: EDT of data
"""
Expand Down

0 comments on commit 05be05c

Please sign in to comment.