hyperslicer(arr, cmap=None, norm=None, aspect=None, interpolation=None, alpha=None, vmin=None, vmax=None, origin=None, extent=None, autoscale_cmap=True, filternorm=True, filterrad=4.0, resample=None, url=None, ax=None, slider_formats=None, title=None, force_ipywidgets=False, play_buttons=False, play_button_pos='right', is_color_image=False, controls=None, display_controls=True, **kwargs)[source]

View slices from a hyperstack of images selected by sliders.

  • arr (array like) – Hyperstack of images. The last 2 or 3 dimensions will be treated as individiual images.

  • cmap (str or ~matplotlib.colors.Colormap) – The Colormap instance or registered colormap name used to map scalar data to colors. This parameter is ignored for RGB(A) data. forwarded to matplotlib

  • norm (~matplotlib.colors.Normalize, optional) – The .Normalize instance used to scale scalar data to the [0, 1] range before mapping to colors using cmap. By default, a linear scaling mapping the lowest value to 0 and the highest to 1 is used. This parameter is ignored for RGB(A) data. forwarded to matplotlib

  • autoscale_cmap (bool) – If True rescale the colormap for every function update. Will not update if vmin and vmax are provided or if the returned image is RGB(A) like. forwarded to matplotlib

  • aspect ({‘equal’, ‘auto’} or float) – forwarded to matplotlib interpolation : str forwarded to matplotlib

  • ax (matplotlib axis, optional) – if None a new figure and axis will be created

  • slider_formats (None, string, or dict) – If None a default value of decimal points will be used. Uses the new {} style formatting

  • title (None or string) – If a string then you can have it update automatically using string formatting of the names of the parameters. i.e. to include the current value of tau: title=’the value of tau is: {tau:.2f}’

  • force_ipywidgets (boolean) – If True ipywidgets will always be used, even if not using the ipympl backend.

    If False the function will try to detect if it is ok to use ipywidgets If ipywidgets are not used the function will fall back on matplotlib widgets

    play_buttonsbool or dict or list(str), optional

    Whether to attach an ipywidgets.Play widget to any sliders that get created. If a boolean it will apply to all kwargs, if a dictionary you choose which sliders you want to attach play buttons too. If a list of strings use the names of the parameters that you want to have sliders left’ or ‘right’. Whether to position the play widget(s) to the left or right of the slider(s)

  • is_color_image (boolean) – If True, will treat the last 3 dimensions as comprising a color images and will only set up sliders for the first arr.ndim - 3 dimensions.

  • controls (mpl_interactions.controller.Controls) – An existing controls object if you want to tie multiple plot elements to the same set of controls

  • display_controls (boolean) – Whether the controls should display themselve on creation. Ignored if controls is specified.