protocol_manager.tools.mri_sequence_plot
========================================

.. py:module:: protocol_manager.tools.mri_sequence_plot

.. autoapi-nested-parse::

   Utility function to create a sequence plot with plotly.



Classes
-------

.. autoapisummary::

   protocol_manager.tools.mri_sequence_plot.TraceData


Functions
---------

.. autoapisummary::

   protocol_manager.tools.mri_sequence_plot.get_sequence_plot
   protocol_manager.tools.mri_sequence_plot.generate_plotly_figure


Module Contents
---------------

.. py:class:: TraceData

   Bases: :py:obj:`pydantic.BaseModel`


   Numpy model for trace data.


   .. py:attribute:: x
      :type:  list[float]


   .. py:attribute:: y
      :type:  list[float]


   .. py:attribute:: name
      :type:  str


.. py:function:: get_sequence_plot(seq: pypulseq.Sequence, time_range: tuple[float, float] = (0.0, np.inf), time_factor=1000.0) -> list[TraceData]

   Compute a sequence dictionary from pulseq sequence object.

   :param seq: pypulseq sequence object
   :param time_range: time span of the sequence plot, by default (0., np.inf)
   :param optional: time span of the sequence plot, by default (0., np.inf)
   :param time_factor: time prefix, by default 1e3
   :param optional: time prefix, by default 1e3

   :rtype: list of plot data models


.. py:function:: generate_plotly_figure(traces: list[TraceData])

   Generate plotly figure of traces.

   :param traces: List of trace data

   :rtype: Plotly figure