Skip to content

Commit

Permalink
mention potential issues with picking
Browse files Browse the repository at this point in the history
  • Loading branch information
ffreyer committed Jan 11, 2024
1 parent 0ccdd53 commit e528631
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/reference/plots/voxel.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,13 @@ chunk.val[30:34, :, :] .= NaN # or p.args[end].val
Makie.local_update(p, 30:34, :, :)
f
```
\end{examplefigure}
\end{examplefigure}



#### Picking Voxels

The `pick` function is able to pick individual voxels in a voxel plot.
The returned index is a flat index into the array passed to `voxels`, i.e. `plt.args[end][][idx]` will return the relevant data.
One important thing to note here is that the returned index is a `UInt32` internally and thus has limited range.
Very large voxel plots (~4.3 billion voxels or 2048 x 2048 x 1024) can reach this limit and trigger an integer overflow.

0 comments on commit e528631

Please sign in to comment.