Skip to content

Commit

Permalink
docs: show how to use cross_section on the front page
Browse files Browse the repository at this point in the history
  • Loading branch information
william-silversmith committed Feb 10, 2024
1 parent 5414a44 commit 55649e6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ area, contact_warning = xs3d.cross_sectional_area(
return_contact=True
)

# Returns the cross section as a float32 image
# where each voxel represents its contribution
# to the cross sectional area
image = xs3d.cross_section(
binary_image, vertex,
normal, resolution,
)


```

When using skeletons (one dimensional stick figure representations) to create electrophysiological compartment simulations of neurons, some additional information is required for accuracy. The caliber of the neurite changes over the length of the cell.
Expand Down

0 comments on commit 55649e6

Please sign in to comment.