motion_plot

petpal.visualizations.qc_plots.motion_plot(framewise_displacement: numpy.ndarray, output_plot: str = None)

Plots the quantity of motion estimated by ants.motion_correction(). Takes the framewise displacement returned by ANTs, and plots this quantity against frame number.

Parameters:

• framewise_displacement (np.ndarray) – Total movement, or displacement, estimated between consecutive frames.

• output_plot (str) – File to which plot is saved. If None, do not write plot to file. Default value None.

Returns:

movement_plot (sns.lineplot) – Plot of total movement between frames.