Tutorial 5. Plot monitor#

See also

The complete source code of this tutorial can be found in

Tutorial 5. Plot monitor.ipynb

In this tutorial we dive into the capabilities of the plot monitor. We will create a fictional device and showcase how the plot monitor can be used. Enjoy!

Hide code cell content
import numpy as np
from IPython.core.interactiveshell import InteractiveShell
from qcodes import Instrument, ManualParameter

from quantify_core.data.handling import (
    get_tuids_containing,
    set_datadir,
    default_datadir,
)
from quantify_core.measurement import MeasurementControl
from quantify_core.visualization.pyqt_plotmon import PlotMonitor_pyqt

rng = np.random.default_rng(seed=555555)  # random number generator

# Display any variable or statement on its own line
InteractiveShell.ast_node_interactivity = "all"

Before instantiating any instruments or starting a measurement we change the directory in which the experiments are saved using the set_datadir() [get_datadir()] functions.


⚠️ Warning!

We recommend always setting the directory at the start of the python kernel and stick to a single common data directory for all notebooks/experiments within your measurement setup/PC.

The cell below sets a default data directory (~/quantify-data on Linux/macOS or $env:USERPROFILE\\quantify-data on Windows) for tutorial purposes. Change it to your desired data directory. The utilities to find/search/extract data only work if all the experiment containers are located within the same directory.


set_datadir(default_datadir())
Data will be saved in:
/root/quantify-data

QCoDeS drivers for our instruments#

class Device(Instrument):
    """A dummy instrument."""

    def __init__(self, name: str):
        super().__init__(name=name)

        self.add_parameter(name="amp_0", unit="A", parameter_class=ManualParameter)
        self.add_parameter(name="amp_1", unit="A", parameter_class=ManualParameter)
        self.add_parameter(name="offset", unit="A", parameter_class=ManualParameter)

        self.add_parameter(
            name="adc", label="ADC input", unit="V", get_cmd=self._get_dac_value
        )

    def _get_dac_value(self):
        s1 = np.exp(-3 * self.amp_0()) * np.sin(self.amp_0() * 2 * np.pi * 3)
        s2 = np.cos(self.amp_1() * 2 * np.pi * 2)
        return s1 + s2 + rng.uniform(0, 0.2) + self.offset()

Instantiate the instruments#

meas_ctrl = MeasurementControl("meas_ctrl")
plotmon = PlotMonitor_pyqt("PlotMonitor")
meas_ctrl.instr_plotmon(plotmon.name)
device = Device("Device")

Overview#

There are 3 parameters in the PlotMonitor_pyqt that control the datasets being displayed.

Two main parameters determine the datasets being displayed: tuids and tuids_extra.

plotmon.tuids()
plotmon.tuids_extra()
[]
[]

The interface is the same for both. The parameters accept a list of tuids or an empty list to reset.

### Example of loading datasets onto the plot
#plotmon.tuids(["20201124-184709-137-8a5112", "20201124-184716-237-918bee"])
#plotmon.tuids_extra(["20201124-184722-988-0463d4", "20201124-184729-618-85970f"])

The difference is that the MeasurementControl uses tuids and overrides them when running measurements.

Note

All the datasets must have matching data variables (settables and gettables).

The third relevant parameter is the tuids_max_num. It accepts an integer that determines the maximum number of datasets that will be stored in tuids when the MeasurementControl is running.

plotmon.tuids_max_num()
3

Note

This parameter has no effect when setting the tuids manually.

Usage examples#

# set initial values to emulate the instrument state
device.amp_0(0.0)
device.amp_1(0.0)
device.offset(0.0)

n_pnts = 50

meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/f95e96431d3e0035bd699a8c6e209dcd220a8352aed5db6b5f156a1c05d36209.png
n_pnts = 20

meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/d1acbfef2a0691fa800cb21badc28333f7db2b301ea88722d4c8287fdf6be1f3.png
n_pnts = 30

meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/8a39df34c0bc9b4ad634a44f75f61148cdd14f95751a09f06080fd3d40b0294e.png

Now the oldest dataset will vanish from the plot:

# Now the oldest dataset will vanish from the plot

n_pnts = 40

meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/a5e74d258a72f79a35a779796b2f8745441309cddc27c3673529e38b936b54d3.png

We can accumulate more datasets on the plot if we want to:

# We can accumulate more datasets on the plot if we want to
plotmon.tuids_max_num(4)
n_pnts = 40

meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/7c8e03160a082f6b154c4bd15aeab90d517b9f4662838ce34b16ce75e52a72f0.png

Or we can disable the accumulation and plot a single dataset:

# Or we can disable the accumulation and plot a single dataset
plotmon.tuids_max_num(1)

plotmon.main_QtPlot
../_images/14e816d3d167f97e76684f3e066c2104d53c628238769578e2ad9b72d716a4fb.png

This can also be reset:

# This can also be reset with
plotmon.tuids([])

plotmon.main_QtPlot  # The plotting window will vanish, it is supposed to
../_images/fabf04168e56bbb0f5186f5950510ed6a80473057a98bf96209bf8df36593f5c.png

For now, we will allow two datasets on the plot monitor.

# For now we will allow two datasets on the plot monitor
plotmon.tuids_max_num(2)

Now let’s imagine that something strange is happening with our setup…

# Now let's imagine that something strange is happening with our setup
device.offset(1.5)

n_pnts = 40
meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan problem")
Starting iterative measurement...
plotmon.main_QtPlot
../_images/fa9dace49f135057bf32e2ffa9147155cb431975b061807678c3961359b3975c.png

We would like to compare if the current behavior matches for example what we got a few minutes ago:

# We would like to compare if the current behavior matches for example
# what we got a few minutes ago

reference_tuids = sorted(get_tuids_containing("ADC"))[-3:-1]

plotmon.tuids_extra(reference_tuids)
plotmon.main_QtPlot
../_images/fd9b899639797fab5cbea2807d59284d958179d41198ac00eb93fafbefa993e4.png

OK… that cable was not connected in the right place…

device.offset(0.0)  # OK... that cable was not connected in the right place...

# Now let's run again our experiments while we compare it to the previous one in realtime

n_pnts = 30
meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")

n_pnts = 40
meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")
Starting iterative measurement...
Starting iterative measurement...
plotmon.main_QtPlot
../_images/62c9941b678d40cc5c0095df76160298444f3bb3dce378c0e6a6acf027990af5.png

We do not need the reference datasets anymore

# We do not need the reference datasets anymore
plotmon.tuids_extra([])
plotmon.main_QtPlot
../_images/b82810cc972d58669d1c77ff4ba901b6dbe182f6c334ac22c346f1f0945ded91.png
# Note: both plotmon.tuids_extra and plotmon.tuids can be used
# but keep in mind that meas_ctrl also uses the plotmon.tuids

tuids = get_tuids_containing("problem")[0:1]
tuids
plotmon.tuids(tuids)

n_pnts = 40
meas_ctrl.settables(device.amp_0)
meas_ctrl.setpoints(np.linspace(0, 1, n_pnts))
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan")

plotmon.main_QtPlot
['20240722-041008-236-4a1929']
Starting iterative measurement...
../_images/26f17dc831163140bcfce0b139f4e281b51801d28f77e62714aa984cfa60a29f.png

When we have 2D plots only the first dataset from plotmon.tuids or plotmon.tuids_extra will be plotted in the secondary window, in that order of priority.

# When we have 2D plots only the first dataset from plotmon.tuids or
# plotmon.tuids_extra, in that order of priority, will be plotted in the
# secondary window

meas_ctrl.settables([device.amp_0, device.amp_1])
meas_ctrl.setpoints_grid([np.linspace(0, 1, 20), np.linspace(0, 0.5, 15)])
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan 2D")
reference_tuid_2D = dset.attrs["tuid"]
Starting iterative measurement...
plotmon.main_QtPlot
plotmon.secondary_QtPlot
../_images/c66da20ba1ea31f09d59205d5f8a540e71a014a2f5e490b0be37aac56b393d23.png ../_images/06aed89c3d92ba2b5d4388275aef051c03edd3a9145f2ad6cfc69b1440be6ace.png

Note

The secondary window displays the last dataset with a 2D structure, and it remains persistent until replaced by a new dataset with a 2D structure.

Mind that the data on the secondary window does not always display data corresponding to the same dataset as the main window.

We still have the persistence of the previous dataset on the main window:

meas_ctrl.settables([device.amp_0, device.amp_1])
meas_ctrl.setpoints_grid([np.linspace(0, 1, 20), np.linspace(0, 0.5, 15)])
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan 2D")
Starting iterative measurement...
plotmon.main_QtPlot
plotmon.secondary_QtPlot
../_images/ca28bebfb605b086f5f7db65e474b3c11e6672a5e17b0a3506c416e506caf7fa.png ../_images/df362a70c2cf6f131be1f5525de5da8e5e65e9db396944ba3c29005d515c3f8e.png

We can still have a permanent dataset as a reference in the main window:

device.offset(2.03)
plotmon.tuids_extra([reference_tuid_2D])

meas_ctrl.settables([device.amp_0, device.amp_1])
meas_ctrl.setpoints_grid([np.linspace(0, 1, 20), np.linspace(0, 0.5, 15)])
meas_ctrl.gettables(device.adc)
dset = meas_ctrl.run("ADC scan 2D")
Starting iterative measurement...
plotmon.main_QtPlot
plotmon.secondary_QtPlot
../_images/d3a816164db8188634499200b7616bb995c9d09e12824b2a5c59d89df19cbde7.png ../_images/24d10c8f9e068e57285083c11cfef65d2bf30a835883b944db0106f6f49651fb.png

But if we want to see the 2D plot we need to reset plotmon.tuids.

plotmon.tuids([])
plotmon.tuids_extra([reference_tuid_2D])
plotmon.main_QtPlot
plotmon.secondary_QtPlot
../_images/c19e5e44fa2b541c0972c4f7e40eb657bc25f8956ce3ef570ab7b038d3f8e68b.png ../_images/06aed89c3d92ba2b5d4388275aef051c03edd3a9145f2ad6cfc69b1440be6ace.png
plotmon.tuids()
[]

Now your life will never be the same again ;)