spyrit.misc.disp.save_field_video

spyrit.misc.disp.save_field_video(def_field, out_path, n_frames, step=5, fps=30, figsize=(6, 6), dpi=200, scale=1, fs=16, amp_max=0, box_color='blue', box_linewidth=2)[source]

Save deformation field as a quiver video.

Args:

def_field (DeformationField): Deformation field object (see the spyrit.core.warp module).

out_path (Path-like): Path-like to save the output video (mp4).

n_frames (int): Number of frames in the output video.

step (int): Step size for quiver grid (spatial subsampling).

fps (int): Frames per second for the output video.

figsize (tuple): Figure size for the quiver plot (width, height).

dpi (int): Output DPI for the saved video/frames.

scale (float): Quiver scale parameter for scaling the length of arrows.

amp_max (int, optional): Number of pixels inset from each border to draw a blue box (e.g. the SPC FOV). If 0, no box is drawn.

box_color (str, optional): matplotlib color for the box edge.

box_linewidth (float, optional): width of the box edge line.