cigvis.vispynodes.volume_slices module#

cigvis.vispynodes.volume_slices.volume_slices(volumes: ndarray | Dict | List, x_pos: List | int = None, y_pos: List | int = None, z_pos: List | int = None, preproc_funcs: Callable = None, cmaps: str | Colormap | List = 'grays', clims: List | Tuple = None, interpolation: str = 'linear', method: str = 'auto', texture_format=None) Dict#

Acquire a list of slices in the form of AxisAlignedImage. The list can be attached to a VisCanvas to visualize the volume in 3D interactively.

Parameters#

volumesarray-like, dict, or List[array-like]

input 3D volumes. A single volume may also be an axis source dict such as {'x': iline_source, 'y': xline_source, 'z': time_source}. Each source value may also be a spec such as {'data': time_source, 'axes': ('z', 'y', 'x')}.

x_posList or int

x postions

y_posList or int

y postions

z_posList or int

z positions

preproc_funcsCallable[[np.ndarray], np.ndarray]

A function to preprocess a slice

cmapsList[str or vispy.color.Colormap]

colormaps

climsList or Tuple

[vmin, vmax] for each volume

interpolationstr

interpolation methods for volumes

methodstr

Selects method of rendering image in case of non-linear transforms., see: https://vispy.org/api/vispy.scene.visuals.html#vispy.scene.visuals.Image

Returns#

visual_nodesDict[str, List[AxisAlignedImage]]

return a dict with keys ‘x’, ‘y’, ‘z’, each mapping to a list of AxisAlignedImage nodes