Make use of generic parameters in some instruments #7822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

jenshnielsen merged 29 commits into microsoft:main from jenshnielsen:generic_parameter_instruments

Feb 3, 2026

docs/changes/newsfragments/7822.improved_driver

-Original file line number
+Diff line change
@@ -0,0 +1,16 @@
+    Several instrument drivers now make better use of the newly added generic datatype and instrument arguments to ParameterBase and subclasses.
+    - AlazarTech ATS: ``TraceParameter`` now uses generic type parameters.
+    - CopperMountain M5xxx: ``FrequencySweepMagPhase``, ``PointMagPhase``, and ``PointIQ`` now use generic type parameters. Removed unnecessary ``assert isinstance`` calls. Fixed timeout handling when timeout is ``None``.
+    - Keysight 344xxA: ``Keysight344xxATrigger``, ``Keysight344xxASample``, ``Keysight344xxADisplay`` and ``TimeTrace`` now use generic type parameters. Refactored ``_acquire_time_trace`` to use explicit context managers instead of a list of parameter settings. ..  gitleaks:allow
+    - Keysight B1500: Added ``MeasurementModeDict`` TypedDict. ``IVSweepMeasurement`` corrected instrument type and now uses generic type parameters. ``KeysightB1500Module`` now uses generic type parameters.
+    - Keysight B1517A: ``KeysightB1500IVSweeper``, ``_ParameterWithStatus``, ``_SpotMeasurementVoltageParameter``, and ``_SpotMeasurementCurrentParameter`` now use generic type parameters. Removed unnecessary ``cast`` calls.  ..  gitleaks:allow
+    - Keysight B1520A: ``KeysightB1500CVSweeper`` and ``KeysightB1500CVSweepMeasurement`` now use generic type parameters. Added ``root_instrument`` property to ``KeysightB1500CVSweepMeasurement``.   ..  gitleaks:allow
+    - Keysight B1500 sampling measurement: ``SamplingMeasurement`` now uses generic type parameters and has a ``root_instrument`` property. Fixed timeout handling when timeout is ``None``.
+    - Keysight B1500 message builder: Improved type annotations using ``ParamSpec`` and ``TypeVar``. Made ``CommandList`` generic.
+    - Keysight KtM960x: ``Measure`` parameter now uses generic type parameters.
+    - Keysight N9030B: ``FrequencyAxis``, ``Trace``, ``KeysightN9030BSpectrumAnalyzerMode``, and ``KeysightN9030BPhaseNoiseMode`` now use generic type parameters. Replaced ``assert`` statements with proper error handling.
+    - QuantumDesign DynaCool: Improved type annotation for ``_pick_one`` method. Removed unnecessary ``cast`` call.
+    - Rohde & Schwarz ZNB: ``FixedFrequencyTraceIQ``, ``FixedFrequencyPointIQ``, ``FixedFrequencyPointMagPhase``, ``FrequencySweepMagPhase``, ``FrequencySweepDBPhase``, and ``FrequencySweep`` now use generic type parameters. Removed unnecessary ``assert isinstance`` calls.
+    - Tektronix DPO7200xx: ``TektronixDPOMeasurementParameter`` now uses generic type parameters. Removed unnecessary ``cast`` call.
+    - Yokogawa GS200: ``source_mode`` and ``current_limit`` parameters now use generic type parameters. Replaced if-else statements with match statements for source mode handling.

src/qcodes/instrument/visa.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ @@
     import logging
     import warnings
     from importlib.resources import as_file, files
-    from typing import TYPE_CHECKING, Any, Literal, TypedDict
+    from typing import TYPE_CHECKING, Any, Literal, Self, TypedDict
     from weakref import finalize
     import pyvisa
@@ Expand All / @@ -26,6 +26,8 @@ @@
         from typing_extensions import Unpack
+        from qcodes.parameters.parameter import Parameter
     VISA_LOGGER = ".".join((InstrumentBase.__module__, "com", "visa"))
     log = logging.getLogger(__name__)
@@ Expand Down Expand Up / @@ -153,7 +155,7 @@ def __init__( @@
             super().__init__(name, **kwargs)
             self.visa_log = get_instrument_logger(self, VISA_LOGGER)
-            self.add_parameter(
+            self.timeout: Parameter[float | None, Self] = self.add_parameter(
                 "timeout",
                 get_cmd=self._get_visa_timeout,
                 set_cmd=self._set_visa_timeout,
@@ Expand Down @@

src/qcodes/instrument_drivers/AlazarTech/utils.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,15 +5,19 @@ @@
     :mod:`.AlazarTech.helpers` module).
     """
-    from typing import TYPE_CHECKING, Any, cast
+    from typing import TYPE_CHECKING, Any, Generic
     from qcodes.parameters import Parameter, ParamRawDataType
+    from qcodes.parameters.parameter_base import ParameterDataTypeVar
     if TYPE_CHECKING:
-        from .ATS import AlazarTechATS
+        # ruff does not detect that this is used as a generic parameter below
+        from .ATS import AlazarTechATS  # noqa: F401
-    class TraceParameter(Parameter):
+    class TraceParameter(
+        Parameter[ParameterDataTypeVar, "AlazarTechATS"], Generic[ParameterDataTypeVar]
+    ):
         """
         A parameter that keeps track of if its value has been synced to
         the ``Instrument``. To achieve that, this parameter sets
@@ Expand All / @@ -38,6 +42,5 @@ def synced_to_card(self) -> bool: @@
             return self._synced_to_card
         def set_raw(self, value: ParamRawDataType) -> None:
-            instrument = cast("AlazarTechATS", self.instrument)
-            instrument._parameters_synced = False
+            self.instrument._parameters_synced = False
             self._synced_to_card = False

src/qcodes/instrument_drivers/CopperMountain/_M5xxx.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,6 +1,7 @@
  
    from typing import TYPE_CHECKING, Any, Literal

    import numpy as np

    from numpy.typing import NDArray

    from qcodes.instrument import VisaInstrument, VisaInstrumentKWArgs

    from qcodes.parameters import (

    @@ -13,7 +14,6 @@
  
    from qcodes.validators import Bool, Enum, Ints, Numbers

    if TYPE_CHECKING:

        from numpy.typing import NDArray

        from typing_extensions import Unpack

    @@ -544,8 +544,10 @@ def get_s_parameters(
  
                s22 magnitude [dB], s22 phase [rad]

            """

            timeout = self.timeout()

            current_timeout = timeout if timeout is not None else float("inf")

            with self.timeout.set_to(max(self.timeout(), expected_measurement_duration)):

            with self.timeout.set_to(max(current_timeout, expected_measurement_duration)):

                self.write("CALC1:PAR:COUN 4")  # 4 trace

                self.write("CALC1:PAR1:DEF S11")  # Choose S11 for trace 1

                self.write("CALC1:PAR2:DEF S12")  # Choose S12 for trace 2

    @@ -622,7 +624,9 @@ def _db(data: "NDArray") -> "NDArray":
  
            return 20.0 * np.log10(np.abs(data))

    class FrequencySweepMagPhase(MultiParameter):

    class FrequencySweepMagPhase(

        MultiParameter[tuple[NDArray, NDArray], CopperMountainM5xxx]

    ):

        """

        Sweep that returns magnitude and phase.

        """

    @@ -696,17 +700,19 @@ def set_sweep(self, start: float, stop: float, number_of_points: int) -> None:
  
            self.setpoints = ((f,), (f,))

            self.shapes = ((number_of_points,), (number_of_points,))

        def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:

        def get_raw(self) -> tuple[NDArray, NDArray]:

            """Gets data from instrument

            Returns:

                Tuple[ParamRawDataType, ...]: magnitude, phase

            """

            assert isinstance(self.instrument, CopperMountainM5xxx)

            timeout = self.instrument.timeout()

            current_timeout = timeout if timeout is not None else float("inf")

            with self.instrument.timeout.set_to(

                max(self.instrument.timeout(), self.expected_measurement_duration)

                max(current_timeout, self.expected_measurement_duration)

            ):

                self.instrument.write("CALC1:PAR:COUN 1")  # 1 trace

                self.instrument.write(f"CALC1:PAR1:DEF {self.name}")

    @@ -728,7 +734,9 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
            return self.instrument._db(sxx), np.angle(sxx)

    class PointMagPhase(MultiParameter):

    class PointMagPhase(

        MultiParameter[tuple[np.floating, np.floating], CopperMountainM5xxx]

    ):

        """

        Returns the average Sxx of a frequency sweep.

        Work around for a CW mode where only one point is read.

    @@ -738,7 +746,7 @@ class PointMagPhase(MultiParameter):
  
        def __init__(

            self,

            name: str,

            instrument: VisaInstrument,

            instrument: CopperMountainM5xxx,

            expected_measurement_duration: float = 600,

            **kwargs: Any,

        ) -> None:

    @@ -785,8 +793,6 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
                Tuple[ParamRawDataType, ...]: magnitude, phase

            """

            assert isinstance(self.instrument, CopperMountainM5xxx)

            # check that number_of_points, start and stop fullfill requirements if point_check_sweep_first is True.

            if self.instrument.point_check_sweep_first():

                if self.instrument.number_of_points() != 2:

    @@ -799,8 +805,11 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
                        "Please adjust start or stop."

                    )

            timeout = self.instrument.timeout()

            current_timeout = timeout if timeout is not None else float("inf")

            with self.instrument.timeout.set_to(

                max(self.instrument.timeout(), self.expected_measurement_duration)

                max(current_timeout, self.expected_measurement_duration)

            ):

                self.instrument.write("CALC1:PAR:COUN 1")  # 1 trace

                self.instrument.write(f"CALC1:PAR1:DEF {self.name[-3:]}")

    @@ -825,7 +834,7 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
            return 20 * np.log10(abs(sxx_mean)), (np.angle(sxx_mean))

    class PointIQ(MultiParameter):

    class PointIQ(MultiParameter[tuple[np.floating, np.floating], CopperMountainM5xxx]):

        """

        Returns the average Sxx of a frequency sweep, in terms of I and Q.

        Work around for a CW mode where only one point is read.

    @@ -835,7 +844,7 @@ class PointIQ(MultiParameter):
  
        def __init__(

            self,

            name: str,

            instrument: VisaInstrument,

            instrument: CopperMountainM5xxx,

            expected_measurement_duration: float = 600,

            **kwargs: Any,

        ) -> None:

    @@ -882,8 +891,6 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
                Tuple[ParamRawDataType, ...]: I, Q

            """

            assert isinstance(self.instrument, CopperMountainM5xxx)

            # check that number_of_points, start and stop fullfill requirements if point_check_sweep_first is True.

            if self.instrument.point_check_sweep_first():

                if self.instrument.number_of_points() != 2:

    @@ -895,8 +902,11 @@ def get_raw(self) -> tuple[ParamRawDataType, ParamRawDataType]:
  
                        f"Stop-start is not 1 Hz but {self.instrument.stop() - self.instrument.start()} Hz. Please adjust start or stop."

                    )

            timeout = self.instrument.timeout()

            current_timeout = timeout if timeout is not None else float("inf")

            with self.instrument.timeout.set_to(

                max(self.instrument.timeout(), self.expected_measurement_duration)

                max(current_timeout, self.expected_measurement_duration)

            ):

                self.instrument.write("CALC1:PAR:COUN 1")  # 1 trace

                self.instrument.write(f"CALC1:PAR1:DEF {self.name[-3:]}")

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make use of generic parameters in some instruments #7822

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!