Skip to content

Commit

Permalink
docs: update neuron types tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
schlegelp committed Sep 19, 2024
1 parent a2bc5f3 commit 40e5848
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
Binary file added docs/_static/voxel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions docs/examples/plot_01_neurons_intro.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,12 @@
# [`VoxelNeurons`][navis.VoxelNeuron] represent neurons as either 3d image or x/y/z voxel coordinates
# typically obtained from e.g. light-level microscopy.
#
# [`navis.VoxelNeuron`][] consist of either a 3d `(N, M, K)` array (a "grid") or an 2d `(N, 3)`
# array of voxel coordinates. You will probably find yourself loading these data from image files
# (e.g. `.nrrd` via [`navis.read_nrrd()`][navis.read_nrrd]). That said we can also "voxelize"
# other neuron types to produce [`VoxelNeurons`][navis.VoxelNeuron]:
# ![voxels](../../../_static/voxel.png)
#
# [`navis.VoxelNeuron`][] consist of either a dense3d `(N, M, K)` array (a "grid") or a sparse 2d `(N, 3)`
# array of voxel coordinates (COO format). You will probably find yourself loading these
# data from image files (e.g. `.nrrd` via [`navis.read_nrrd()`][navis.read_nrrd]). That said we can
# also "voxelize" other neuron types to produce [`VoxelNeurons`][navis.VoxelNeuron]:

# Load an example mesh
m = navis.example_neurons(n=1, kind="mesh")
Expand Down

0 comments on commit 40e5848

Please sign in to comment.