mdreg.plot.animation

mdreg.plot.animation(array, path=None, filename='animation', vmin=None, vmax=None, title='', interval=250, show=True, verbose=0)

Produce an animation of a 3D image.

Parameters:

• array (numpy.array | zarr.Array) – The 3D image to animate.

• path (str, optional) – The path to save the animation. The default is None.

• filename (str, optional) – The filename of the animation. The default is ‘animation’.

• vmin (float, optional) – The minimum value for the colormap. The default is None.

• vmax (float, optional) – The maximum value for the colormap. The default is None.

• title (str, optional) – The title of the animation to be rendered on the figure. The default is ‘’.

• interval (int, optional) – The interval between frames. The default is 250ms.

• show (bool, optional) – Whether to display the animation. The default is False.

• verbose (int, optional) – Set to 1 to show progress bars. Default is 0 (no progress bars).