pymerlin.plot.reg_animation

pymerlin.plot.reg_animation(reg_out, images, out_name='animation.gif', slice_pos=None, tnav=None, t0=0, max_d=None, max_r=None, vmax=1, nrot=0)[source]

Animation of registration results

Parameters

  • reg_out (str) – File name to pickle file

  • images (np.array) – Array of images to display (nx,ny,nz,nt)

  • out_name (str, optional) – Output suffix .gif or .mp4. Defaults to ‘animation.gif’.

  • slice_pos (array, optional) – Slice positions. Defaults to center slices.

  • tnav (float, optional) – Navigator duration to display x-axis with time. Defaults to None.

  • t0 (int, optional) – Starting time. Defaults to 0.

  • max_d (float, optional) – Limit of translation plot. Defaults to None.

  • max_r (float, optional) – Limit of translation plot. Defaults to None.

  • vmax (float, optional) – Maximum display range (0-1). Defaults to 1

Raises

TypeError – If number of navigator images in images is not the same as number of registration objects in pickle file.