motion_plot
==========================================

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

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

   :param framewise_displacement: Total movement, or displacement,
                                  estimated between consecutive frames.
   :type framewise_displacement: np.ndarray
   :param output_plot: File to which plot is saved. If `None`, do not write
                       plot to file. Default value `None`.
   :type output_plot: str

   :returns: *movement_plot (sns.lineplot)* -- Plot of total movement between frames.