Add calibration result plotting functions

.github/workflows/on-pull-request.yml

@@ -17,7 +17,7 @@ jobs:
 
       - name: Setup pip Cache
         id: cache-pip
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: pip
@@ -31,7 +31,7 @@ jobs:
 
       - name: Setup venv Cache
         id: cache-python
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: .venv
           key:  poetry-${{ hashFiles('poetry.lock') }}

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 ### Added
+- Octave tools Calibration Result Plotter
 - two-qubit rb - Added feature to plot the two qubit state distribution.
 
 ### Fixed
@@ -26,7 +27,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - wirer - Fixed bug in the visualizer for LF-FEM and MW-FEM.
 - macros/long_wait - Fix issue with `threshold_for_looping` not enforced to be an integer.
 - simulator - Recast connection ports in `create_simulator_controller_connections` to be `int`, instead of `np.int64`.
-- config/waveform_tools - Allow to set the detuning of a DRAG waveform even when the alpha parameter is 0. 
+- config/waveform_tools - Allow to set the detuning of a DRAG waveform even when the alpha parameter is 0.
 - bakery - Fix error when waveform samples type was subclass of int/float (e.g. numpy.float64).
 
 ### Deprecated
@@ -117,7 +118,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - simulator - ``create_simulator_controller_connections`` now creates the connections with a different algorithm that uses all available optical connections.
 - simulator - ``create_simulator_controller_connections`` order of input parameters has changed.
 - External_frameworks/qcodes - Fixed the unit of phase
-- External_frameworks/qcodes - Added a flag to allow for the phase to remain wrapped 
+- External_frameworks/qcodes - Added a flag to allow for the phase to remain wrapped
 - results - Add a warning when timeout is reached in ``wait_until_job_is_paused``.
 
 ### Deprecated
@@ -134,7 +135,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### Added
 - External_frameworks/qcodes - Added ``update_readout_length()`` to update locally the readout length of a given readout element and operation.
-- External_frameworks/qcodes - Added ``update_qm()`` to update the quantum machine (close and re-open it) in case the config has been updated. 
+- External_frameworks/qcodes - Added ``update_qm()`` to update the quantum machine (close and re-open it) in case the config has been updated.
 - External_frameworks/qcodes - Added ``live_plotting()`` to fetch and plot the OPX results while the program is running.
 - Unit - Added `volts2dBm` and `dBm2volts`.
 
@@ -177,7 +178,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Config.helper_tools - Added the function `transform_negative_delays()` to adjust a config containing negative delays by offsetting all delays by the most negative one.
 
 ### Fixed
-- Fixed the loops library to support `qm-qua` 1.1.0  
+- Fixed the loops library to support `qm-qua` 1.1.0
 
 ## [0.13.2] - 2023-02-23
 ### Added
@@ -210,9 +211,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [0.12.0] - 2022-08-29
 ### Changed
-- **Breaking change!** - Waveform tools - Added a missing 2$\pi$ factor into `detuning` parameter in `drag_gaussian_pulse_waveforms` and `drag_cosine_pulse_waveforms`. 
+- **Breaking change!** - Waveform tools - Added a missing 2$\pi$ factor into `detuning` parameter in `drag_gaussian_pulse_waveforms` and `drag_cosine_pulse_waveforms`.
   This will produce different results compared to previous versions, to get the same results, divide the `detuning` parameter by 2pi. Both `detuning`, `delta`, and `anharmonicity` are now expected in`Hz` rather than `rad`; a 2$\pi$ multiplication occurs in the built-in function.
-- Waveform tools - Renamed argument `delta` to `anharmonicity` in `drag_gaussian_pulse_waveforms` and `drag_cosine_pulse_waveforms`. 
+- Waveform tools - Renamed argument `delta` to `anharmonicity` in `drag_gaussian_pulse_waveforms` and `drag_cosine_pulse_waveforms`.
   `delta` is still accepted but will be deprecated in future versions.
 - ConfigBuilder - renamed arguments (backward compatible) in Element and MeasureElement classes.
 - ConfigBuilder - renamed AnalogOutputPort attribute channel_weights to crosstalk
@@ -286,7 +287,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Interactive plotlib - Support for 2d plot, better data manipulation and better fits
 - Waveform tools - Added the waveform tool package, currently including scripts for creating Gaussian and Cosine DRAG waveforms
-- Control Panel - VNA Mode - This module allows to configure the OPX as a VNA for a given element (readout resonator for instance) and 
+- Control Panel - VNA Mode - This module allows to configure the OPX as a VNA for a given element (readout resonator for instance) and
 operation (readout pulse for instance) already defined in the configuration.
 
 ## [0.7.2] - 2022-03-15
@@ -296,12 +297,12 @@ operation (readout pulse for instance) already defined in the configuration.
 ## [0.7.1] - 2022-03-13
 ### Fixed
 - Interactive Plotting Toolbox - Fixed several small issues when loading a figure
-- Integration Weights Tool - When compressing and plotting integration weights, the correct label is shown. 
+- Integration Weights Tool - When compressing and plotting integration weights, the correct label is shown.
 - Set minimum version of docutils dependency to 0.14
 - Fix config builder GUI imports
 ### Added
-- Interactive Plotting Toolbox - Added default markers when fitting 
-- Interactive Plotting Toolbox - Improved example and added a demo video 
+- Interactive Plotting Toolbox - Added default markers when fitting
+- Interactive Plotting Toolbox - Improved example and added a demo video
 - readme for config builder GUI
 
 ## [0.7.0] - 2022-02-10
@@ -317,7 +318,7 @@ operation (readout pulse for instance) already defined in the configuration.
 
 ## [0.6.4] - 2022-01-25
 ### Fixed
-- Bakery - Using "delete_samples()" did not update the element internal time tracking. 
+- Bakery - Using "delete_samples()" did not update the element internal time tracking.
 
 ## [0.6.3] - 2022-01-24
 ### Added

qualang_tools/octave_tools/README.md

@@ -2,8 +2,8 @@
 This library includes tools to improve the users Octave experience.
 
 ## get_calibration_parameters_from_db
-This function will look into the calibration database and return the correction parameters (offsets and correction 
-matrix) corresponding to a given set of intermediate frequency, Octave LO frequency and gain. 
+This function will look into the calibration database and return the correction parameters (offsets and correction
+matrix) corresponding to a given set of intermediate frequency, Octave LO frequency and gain.
 
 The correction parameters are returned in the format of a dictionary:
 ```
@@ -18,7 +18,7 @@ If no calibration parameters are found in the database, the function will either
 
 
 ### Usage example
- 
+
 ```python
 from qualang_tools.octave_tools import get_calibration_parameters_from_db
 
@@ -35,14 +35,14 @@ qm.octave.set_lo_frequency("qubit", 5e9)
 qm.octave.set_rf_output_gain("qubit", -7)
 # Get the correction parameters corresponding to the desired parameters:
 param_qubit = get_calibration_parameters_from_db(
-    path_to_database="", config=config, element="qubit", 
-    LO=5e9, IF=50e6, gain=-7, 
+    path_to_database="", config=config, element="qubit",
+    LO=5e9, IF=50e6, gain=-7,
     verbose_level=1)
 ```
 
 ## set_correction_parameters_to_opx
-This function will look into the calibration database and update the correction parameters in Python, (offsets and 
-correction matrix) corresponding to a given set of intermediate frequency, Octave LO frequency and gain. 
+This function will look into the calibration database and update the correction parameters in Python, (offsets and
+correction matrix) corresponding to a given set of intermediate frequency, Octave LO frequency and gain.
 
 The goal to give the user the ability to easily update the correction parameters while sweeping the LO frequency
 in Python for instance.
@@ -82,7 +82,7 @@ qm = qmm.open_qm(config)
 # Set the Octave gain
 qm.octave.set_rf_output_gain("qubit", 0)
 # Loop over the LO frequencies
-for i in range(len(lo_frequencies)):  
+for i in range(len(lo_frequencies)):
     # Set the frequency and gain of the LO source
     qm.octave.set_lo_frequency("qubit", lo_frequencies[i])
     # Update the correction parameters
@@ -111,7 +111,7 @@ provided ```IF_list```. For instance, if a list of 100 intermediate frequencies
     to 10, then only 10 correction parameters will be returned for the returned equally spaced intermediate frequencies.
 
 The goal is to perform a wide frequency sweep (scan the LO frequency in Python and the IF in QUA) and update the
-mixer correction parameters for each LO frequency and a few intermediate frequencies, given by ```nb_of_updates```, 
+mixer correction parameters for each LO frequency and a few intermediate frequencies, given by ```nb_of_updates```,
 in QUA.
 
 If the flag ```calibrate``` is set to True (the opened Quantum Machine needs to be provided), then the specified element will be calibrated at the given frequencies
@@ -141,7 +141,7 @@ f_max_external = 5.5e9 - f_max
 df_external = f_max - f_min
 lo_frequencies = np.arange(f_min_external, f_max_external + df_external / 2, df_external)
 
-# Get the list of intermediate frequencies at which the correction matrix will 
+# Get the list of intermediate frequencies at which the correction matrix will
 # be updated in QUA and the corresponding correction matrix elements
 IFs, c00, c01, c10, c11, offset_I, offset_Q = get_correction_for_each_LO_and_IF(
     path_to_database="",
@@ -185,9 +185,9 @@ with program() as LO_sweep_prog:
                             )
                 # Play the pulse
                 ...
-                
+
 # Loop over the LO frequencies
-for i in range(len(lo_frequencies)):  
+for i in range(len(lo_frequencies)):
     # Set the frequency and gain of the LO source
     qm.octave.set_lo_frequency("qubit", lo_frequencies[i])
     # Resume the QUA program (escape the 'pause' statement)
@@ -199,7 +199,7 @@ for i in range(len(lo_frequencies)):
 ```
 
 ## calibrate_several_frequencies
-Calibrate a given element for a set of LO and intermediate frequencies. 
+Calibrate a given element for a set of LO and intermediate frequencies.
 Each set of correction parameters will be saved in the calibration database.
 
 ### Usage example
@@ -231,3 +231,90 @@ octave_calibration_tool(
     intermediate_frequencies=intermediate_frequencies
 )
 ```
+
+# CalibrationResultPlotter
+
+## show_lo_leakage_calibration_result()
+Plot the calibration data for the LO leakage.
+The resulting plot illustrates the LO leakage signal as a function of the `I_dc` and `Q_dc` DC offsets, including an initial coarse scan and a finer zoom-in scan on the minimum. Additionally, a third plot displays the fit error of the fine scan.
+
+### Usage example:
+
+```python
+from qualang_tools.octave_tools.calibration_result_plotter import CalibrationResultPlotter
+
+# Open the qmm and qm
+qmm = QuantumMachinesManager()
+qm = qmm.open_qm(config)
+
+# Calibrate the desired set of LO frequency and IF
+calibration_output = qm.calibrate_element("resonator", {6e9: (100e6,)})
+
+plotter = CalibrationResultPlotter(calibration_output)
+
+fig = plotter.show_lo_leakage_calibration_result()
+```
+
+### Outputs:
+
+![image](https://github.com/user-attachments/assets/8b051dcd-9786-4637-8610-f10e9bc7b9d0)
+
+
+**IMPORTANT NOTE**: The colorbar represents the power seen at the OPX inputs when routing the signal internally through the Octave down-conversion chain. The actual power out of the Octave RF output may vary up to 10 dBm, but the suppression in dB unit will be correct in any case.
+
+## show_image_rejection_calibration_result()
+Plot the calibration data for the image sideband.
+The produced plot shows the image sideband signal as a function of the `dc_gain` and `dc_phase` parameters for an initial coarse scan and a finer zoom-in scan on the minimum. A third plot shows the fit error of the fine scan.
+
+### Usage example:
+
+```python
+from qualang_tools.octave_tools.calibration_result_plotter import CalibrationResultPlotter
+
+# Open the qmm and qm
+qmm = QuantumMachinesManager()
+qm = qmm.open_qm(config)
+
+# Calibrate the desired set of LO frequency and IF
+calibration_output = qm.calibrate_element("resonator", {6e9: (100e6,)})
+
+plotter = CalibrationResultPlotter(calibration_output)
+
+fig = plotter.show_image_rejection_calibration_result()
+```
+
+### Outputs:
+
+![image](https://github.com/user-attachments/assets/d33c2e5f-bb12-4582-9559-a9cb774aa831)
+
+
+**IMPORTANT NOTE**: The colorbar represents the power seen at the OPX inputs when routing the signal internally through the Octave down-conversion chain. The actual power out of the Octave RF output may vary up to 10 dBm, but the suppression in dB unit will be correct in any case.
+
+## get_lo_leakage_rejection() and get_image_rejection()
+Returns the LO leakage and image sideband suppression in dB after calibration compared to no calibration at all.
+
+### Usage example:
+```python
+from qualang_tools.octave_tools.calibration_result_plotter import CalibrationResultPlotter
+
+# Open the qmm and qm
+qmm = QuantumMachinesManager()
+qm = qmm.open_qm(config)
+
+# Calibrate the desired set of LO frequency and IF
+calibration_output = qm.calibrate_element("resonator", {6e9: (100e6,)})
+
+plotter = CalibrationResultPlotter(calibration_output)
+
+lo_rejection = plotter.get_lo_leakage_rejection()
+image_rejection = plotter.get_image_rejection()
+
+print(f'The calibration achieved an LO leakage suppression of {lo_rejection:.2f} dB and an image sideband suppression of {image_rejection:.2f} dB.')
+```
+
+### Outputs:
+
+
+```
+The calibration achieved an LO leakeage suppression of -27.23 dB and an image sideband suppression of -42.27 dB.
+```

qualang_tools/octave_tools/__init__.py

@@ -1,13 +1,15 @@
+from qualang_tools.octave_tools.calibration_result_plotter import CalibrationResultPlotter
 from qualang_tools.octave_tools.octave_tools import (
     get_calibration_parameters_from_db,
-    set_correction_parameters_to_opx,
     get_correction_for_each_LO_and_IF,
     octave_calibration_tool,
+    set_correction_parameters_to_opx,
 )
 
 __all__ = [
     "get_calibration_parameters_from_db",
     "set_correction_parameters_to_opx",
     "get_correction_for_each_LO_and_IF",
     "octave_calibration_tool",
+    "CalibrationResultPlotter",
 ]