circuit_diagram
===============

.. py:module:: quantify_scheduler.schedules._visualization.circuit_diagram 

.. autoapi-nested-parse::

   Plotting functions used in the visualization backend of the sequencer.



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


Functions
~~~~~~~~~

.. autoapisummary::

   quantify_scheduler.schedules._visualization.circuit_diagram.gate_box
   quantify_scheduler.schedules._visualization.circuit_diagram.pulse_baseband
   quantify_scheduler.schedules._visualization.circuit_diagram.pulse_modulated
   quantify_scheduler.schedules._visualization.circuit_diagram.meter
   quantify_scheduler.schedules._visualization.circuit_diagram.acq_meter
   quantify_scheduler.schedules._visualization.circuit_diagram.acq_meter_text
   quantify_scheduler.schedules._visualization.circuit_diagram.cnot
   quantify_scheduler.schedules._visualization.circuit_diagram.cz
   quantify_scheduler.schedules._visualization.circuit_diagram.reset
   quantify_scheduler.schedules._visualization.circuit_diagram._locate_qubit_in_address
   quantify_scheduler.schedules._visualization.circuit_diagram.circuit_diagram_matplotlib



.. py:function:: gate_box(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   A box for a single gate containing a label.

   :param ax: The matplotlib Axes.
   :param time: The time of the gate.
   :param qubit_idxs: The qubit indices.
   :param text: The gate name.
   :param kw: Additional keyword arguments to be passed to drawing the gate box.


.. py:function:: pulse_baseband(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Adds a visual indicator for a Baseband pulse to the `matplotlib.axes.Axis`
   instance.

   :param ax: The matplotlib Axes.
   :param time: The time of the pulse.
   :param qubit_idxs: The qubit indices.
   :param text: The pulse name.
   :param kw: Additional keyword arguments to be passed to drawing the pulse.


.. py:function:: pulse_modulated(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Adds a visual indicator for a Modulated pulse to the `matplotlib.axes.Axis`
   instance.

   :param ax: The matplotlib Axes.
   :param time: The time of the pulse.
   :param qubit_idxs: The qubit indices.
   :param text: The pulse name.
   :param kw: Additional keyword arguments to be passed to drawing the pulse.


.. py:function:: meter(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   A simple meter to depict a measurement.

   :param ax: The matplotlib Axes.
   :param time: The time of the measurement.
   :param qubit_idxs: The qubit indices.
   :param text: The measurement name.
   :param kw: Additional keyword arguments to be passed to drawing the meter.


.. py:function:: acq_meter(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Variation of the meter to depict a acquisition.

   :param ax: The matplotlib Axes.
   :param time: The time of the measurement.
   :param qubit_idxs: The qubit indices.
   :param text: The measurement name.
   :param kw: Additional keyword arguments to be passed to drawing the acq meter.


.. py:function:: acq_meter_text(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Same as acq_meter, but also displays text.

   :param ax: The matplotlib Axes.
   :param time: The time of the measurement.
   :param qubit_idxs: The qubit indices.
   :param text: The measurement name.
   :param kw: Additional keyword arguments to be passed to drawing the acq meter.


.. py:function:: cnot(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Markers to denote a CNOT gate between two qubits.

   :param ax: The matplotlib Axes.
   :param time: The time of the CNOT.
   :param qubit_idxs: The qubit indices.
   :param text: The CNOT name.
   :param kw: Additional keyword arguments to be passed to drawing the CNOT.


.. py:function:: cz(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   Markers to denote a CZ gate between two qubits.

   :param ax: The matplotlib Axes.
   :param time: The time of the CZ.
   :param qubit_idxs: The qubit indices.
   :param text: The CZ name.
   :param kw: Additional keyword arguments to be passed to drawing the CZ.


.. py:function:: reset(ax: matplotlib.axes.Axes, time: float, qubit_idxs: List[int], text: str, **kw)

   A broken line to denote qubit initialization.

   :param ax: matplotlib axis object.
   :param time: x position to draw the reset on
   :param qubit_idxs: indices of the qubits that the reset is performed on.
   :param text: The reset name.
   :param kw: Additional keyword arguments to be passed to drawing the reset.


.. py:function:: _locate_qubit_in_address(qubit_map, address)

   Returns the name of a qubit in  a pulse address.


.. py:function:: circuit_diagram_matplotlib(schedule: quantify_scheduler.Schedule, figsize: Tuple[int, int] = None, ax: Optional[matplotlib.axes.Axes] = None) -> Tuple[matplotlib.figure.Figure, Union[matplotlib.axes.Axes, List[matplotlib.axes.Axes]]]

   Creates a circuit diagram visualization of a schedule using matplotlib.

   :param schedule: the schedule to render.
   :param figsize: matplotlib figsize.
   :param ax: Axis handle to use for plotting.

   :returns: * *fig* -- matplotlib figure object.
             * *ax* -- matplotlib axis object.