list index out of range error when running do0d to acquire measurement

[paniash]

Hi,

I'm trying to replicate the tutorial mentioned in the documentation but end up running into an error when running the following command:

do0d(dso.ch4.trace, do_plot=True)

---------------------------------------------------------------------------
IndexError                                Traceback (most recent call last)
Cell In[10], line 1
----> 1 do0d(dso.ch4.trace, do_plot=True)

File /usr/lib/python3.11/contextlib.py:81, in ContextDecorator.__call__.<locals>.inner(*args, **kwds)
     78 @wraps(func)
     79 def inner(*args, **kwds):
     80     with self._recreate_cm():
---> 81         return func(*args, **kwds)

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/dond/do_0d.py:83, in do0d(write_period, measurement_name, exp, do_plot, use_threads, log_info, *param_meas)
     77     LOG.exception(
     78         f"Could not detect shape of {measured_parameters} "
     79         f"falling back to unknown shape."
     80     )
     81     shapes = None
---> 83 _register_parameters(meas, param_meas, shapes=shapes)
     84 _set_write_period(meas, write_period)
     86 with meas.run() as datasaver:

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/dond/do_nd_utils.py:61, in _register_parameters(meas, param_meas, setpoints, shapes)
     56 real_parameters = [
     57     param for param in param_meas if isinstance(param, ParameterBase)
     58 ]
     60 for parameter in real_parameters:
---> 61     meas.register_parameter(parameter, setpoints=setpoints)
     63 if shapes is not None:
     64     parameter_names = [param.full_name for param in real_parameters]

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/measurements.py:937, in Measurement.register_parameter(self, parameter, setpoints, basis, paramtype)
    935     self._register_arrayparameter(parameter, setpoints, basis, paramtype)
    936 elif isinstance(parameter, ParameterWithSetpoints):
--> 937     self._register_parameter_with_setpoints(
    938         parameter, setpoints, basis, paramtype
    939     )
    940 elif isinstance(parameter, MultiParameter):
    941     self._register_multiparameter(
    942         parameter,
    943         setpoints,
    944         basis,
    945         paramtype,
    946     )

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/measurements.py:1122, in Measurement._register_parameter_with_setpoints(self, parameter, setpoints, basis, paramtype)
   1117 """
   1118 Register an ParameterWithSetpoints and the setpoints belonging to the
   1119 Parameter
   1120 """
   1121 my_setpoints = list(setpoints) if setpoints else []
-> 1122 for sp in parameter.setpoints:
   1123     if not isinstance(sp, Parameter):
   1124         raise RuntimeError(
   1125             "The setpoints of a "
   1126             "ParameterWithSetpoints "
   1127             "must be a Parameter"
   1128         )

File ~/Downloads/git-repos/qcodes-drivers/keysight/DSOX4104A.py:126, in DSOTraceParam.setpoints(self)
    124     cache_setpoints = root_instrument.cache_setpoints()
    125     if not cache_setpoints:
--> 126         self.update_setpoints()
    127     return (instrument.time_axis,)
    128 elif isinstance(instrument, KeysightInfiniiumFunction):

File ~/Downloads/git-repos/qcodes-drivers/keysight/DSOX4104A.py:186, in DSOTraceParam.update_setpoints(self, preamble)
    184 self._yincrement = float(preamble[7])
    185 self._yoffset = float(preamble[8])
--> 186 self._unit = int(preamble[21])
    187 instrument.time_axis.points = int(preamble[2])
    188 instrument.time_axis.xorigin = float(preamble[5])

IndexError: list index out of range

Any help would be appreciated!

[jenshnielsen]

I don't think this is specific to do0d. What happens when you call do0d here is that it calls get on the parameter that you supply and store the result. I would expect that if you call so.ch4.trace.get() you will see the same error. It looks like the problem here is that you expect to take the unit out of the 21 element of a list but the list is shorter than that self._unit = int(preamble[21])

[paniash]

I do indeed get the same error when running dso.ch4.trace.get(). In that case, how do I extract the length of the list to ensure this error is mitigated?

[paniash]

Ok, so changing the line to self._unit = int(preamble[9]) spits out the following:

---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
Cell In[7], line 1
----> 1 dso.ch4.trace.get()

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/parameters/parameter_base.py:675, in ParameterBase._wrap_get.<locals>.get_wrapper(*args, **kwargs)
    673 except Exception as e:
    674     e.args = e.args + (f"getting {self}",)
--> 675     raise e

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/parameters/parameter_base.py:667, in ParameterBase._wrap_get.<locals>.get_wrapper(*args, **kwargs)
    664 value = self._from_raw_value_to_value(raw_value)
    666 if self._validate_on_get:
--> 667     self.validate(value)
    669 self.cache._update_with(value=value, raw_value=raw_value)
    671 return value

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/parameters/parameter_with_setpoints.py:154, in ParameterWithSetpoints.validate(self, value)
    152 if isinstance(self.vals, Arrays):
    153     self.validate_consistent_shape()
--> 154 super().validate(value)

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/parameters/parameter_base.py:804, in ParameterBase.validate(self, value)
    802 for validator in reversed(self._vals):
    803     if validator is not None:
--> 804         validator.validate(value, self._validate_context)

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/validators/validators.py:946, in Arrays.validate(self, value, context)
    944     shape = self.shape
    945     if np.shape(value) != shape:
--> 946         raise ValueError(
    947             f"{value!r} does not have expected shape {shape},"
    948             f" it has shape {np.shape(value)}; {context}"
    949         )
    951 # Only check if max is not inf as it can be expensive for large arrays
    952 if self._max_value != (float("inf")) and self._max_value is not None:

ValueError: ('array([1.31134517, 1.31134517, 1.55711609, 1.55679718, 1.30964434,\n       1.31113257, 1.31134517, 1.31134517, 1.18091225, 1.31134517,\n       1.20249162, 1.33823965, 1.31113257, 1.31155778, 1.31187668,\n       1.23533903, 1.31134517, 1.20270422, 1.33823965, 1.39277273,\n       1.31198299, 1.50247671, 1.23533903, 1.31134517, 1.20270422,\n       1.33823965, 1.39277273, 1.31198299, 1.50247671, 1.23533903,\n       1.31134517, 1.20270422, 1.44709321, 1.33834596, 1.36577195,\n       1.33909007, 1.23533903, 1.31134517, 1.20281052, 1.3912845 ,\n       1.41998612, 1.33855856, 1.50247671, 1.23533903, 1.31134517,\n       1.20281052, 1.33685772, 1.31113257, 1.31155778, 1.31187668,\n       1.23533903, 1.31134517, 1.20270422, 1.33685772, 1.39277273,\n       1.31198299, 1.50247671, 1.23533903, 1.31134517, 1.20270422,\n       1.33685772, 1.31113257, 1.31155778, 1.31187668, 1.23533903,\n       1.31134517, 1.20270422, 1.3912845 , 1.41998612, 1.33855856,\n       1.50247671, 1.23533903, 1.31134517, 1.20281052, 1.4743066 ,\n       1.52883968, 1.39298534, 1.44773102, 1.23533903, 1.31134517,\n       1.20281052, 1.33823965, 1.44719951, 1.31166408, 1.44815623,\n       1.23533903, 1.31134517, 1.20270422, 1.33823965, 1.52883968,\n       1.31208929, 1.36672867, 1.23533903, 1.31134517, 1.20270422,\n       1.33823965, 1.50162629, 1.31134517, 1.42104915, 1.23533903,\n       1.31134517, 1.20270422, 1.52873338, 1.44719951, 1.42019873,\n       1.52915859, 1.23533903, 1.31134517, 1.20281052, 1.33685772,\n       1.50162629, 1.31134517, 1.42104915, 1.23533903, 1.31134517,\n       1.20281052, 1.33685772, 1.44719951, 1.31166408, 1.44815623,\n       1.23533903, 1.31134517, 1.20270422, 1.36407111, 1.50162629,\n       1.33877117, 1.42051763, 1.23533903, 1.31134517, 1.20270422,\n       1.3912845 , 1.44719951, 1.33930268, 1.47536962, 1.23533903,\n       1.31134517, 1.20270422, 1.41849789, 1.36555935, 1.36630346,\n       1.55626567, 1.23533903, 1.31134517, 1.20270422, 1.41849789,\n       1.44719951, 1.36672867, 1.47483811, 1.23533903, 1.31134517,\n       1.20270422, 1.41849789, 1.41998612, 1.36598455, 1.52915859,\n       1.23533903, 1.31134517, 1.20270422, 1.3912845 , 1.55605307,\n       1.33866486, 1.36672867, 1.23533903, 1.31134517, 1.20270422,\n       1.36407111, 1.52883968, 1.33951528, 1.36619716, 1.23533903,\n       1.31134517, 1.20270422, 1.33685772, 1.52883968, 1.31208929,\n       1.36672867, 1.23533903, 1.31134517, 1.20270422, 1.33685772,\n       1.31113257, 1.31155778, 1.31187668, 1.23533903, 1.31134517,\n       1.20270422, 1.33685772, 1.50162629, 1.31134517, 1.42104915,\n       1.23533903, 1.31134517, 1.20281052, 1.39266643, 1.41998612,\n       1.33855856, 1.50247671, 1.23533903, 1.31134517, 1.20281052,\n       1.44709321, 1.33834596, 1.36577195, 1.33909007, 1.23533903,\n       1.31134517, 1.20281052, 1.44709321, 1.33834596, 1.36577195,\n       1.33909007, 1.23533903, 1.31134517, 1.20281052, 1.39266643,\n       1.41998612, 1.33855856, 1.50247671, 1.23533903, 1.31134517,\n       1.20281052, 1.39266643, 1.41998612, 1.33855856, 1.50247671,\n       1.23533903, 1.31134517, 1.20281052, 1.30964434, 1.31113257,\n       1.31134517, 1.31134517, 1.18091225, 1.31134517, 1.20249162,\n       1.3912845 , 1.41998612, 1.33855856, 1.50247671, 1.23533903,\n       1.31134517, 1.20281052, 1.47292467, 1.52883968, 1.39298534,\n       1.44773102, 1.23533903, 1.31134517, 1.20281052, 1.33685772,\n       1.31113257, 1.31155778, 1.31187668, 1.23533903, 1.31134517,\n       1.20270422, 1.33685772, 1.39277273, 1.31198299, 1.50247671,\n       1.23533903, 1.31134517, 1.20270422, 1.33685772, 1.50162629,\n       1.31134517, 1.42104915, 1.23533903, 1.31134517, 1.20270422,\n       1.33685772, 1.52883968, 1.31208929, 1.36672867, 1.23533903,\n       1.31134517, 1.20270422, 1.33685772, 1.50162629, 1.31134517,\n       1.42104915, 1.23533903, 1.31134517, 1.20270422, 1.33685772,\n       1.31113257, 1.31155778, 1.31187668, 1.23533903, 1.31134517,\n       1.20270422, 1.33685772, 1.50162629, 1.31134517, 1.42104915,\n       1.23533903, 1.31134517, 1.20281052, 1.33823965, 1.31113257,\n       1.31155778, 1.31187668, 1.23533903, 1.31134517, 1.20270422,\n       1.36545304, 1.31113257, 1.33898377, 1.31134517, 1.23533903,\n       1.31134517, 1.20270422, 1.36545304, 1.50162629, 1.33877117,\n       1.42051763, 1.23533903, 1.31134517, 1.20270422, 1.39266643,\n       1.31113257, 1.33919638, 1.33909007, 1.23533903, 1.31134517,\n       1.20270422, 1.36545304, 1.50162629, 1.33877117, 1.42051763,\n       1.23533903, 1.31134517, 1.20270422, 1.36545304, 1.36555935,\n       1.33866486, 1.55626567, 1.23533903, 1.31134517, 1.20270422,\n       1.33823965, 1.44719951, 1.31166408, 1.44815623, 1.23533903,\n       1.31134517, 1.20270422, 1.4743066 , 1.52883968, 1.39298534,\n       1.44773102, 1.23533903, 1.31134517, 1.20281052, 1.33823965,\n       1.50162629, 1.31134517, 1.42104915, 1.23533903, 1.31134517,\n       1.20281052, 1.3912845 , 1.41998612, 1.33855856, 1.50247671,\n       1.23533903, 1.31134517, 1.20281052, 1.52735145, 1.44719951,\n       1.42019873, 1.52915859, 1.23533903, 1.31134517, 1.20281052,\n       1.33685772, 1.33834596, 1.31230189, 1.55679718, 1.23533903,\n       1.31134517, 1.20270422, 1.33685772, 1.50162629, 1.31134517,\n       1.42104915, 1.23533903, 1.31134517, 1.20270422, 1.36407111,\n       1.44719951, 1.33909007, 1.47483811, 1.23533903, 1.31134517,\n       1.20270422, 1.3912845 , 1.36555935, 1.33887747, 1.55679718,\n       1.23533903, 1.31134517, 1.20270422, 1.3912845 , 1.50162629,\n       1.33898377, 1.42104915, 1.23533903, 1.31134517, 1.20270422,\n       1.3912845 , 1.55605307, 1.33866486, 1.36672867, 1.23533903,\n       1.31134517, 1.20270422, 1.3912845 , 1.50162629, 1.33898377,\n       1.42104915, 1.23533903, 1.31134517, 1.20270422, 1.3912845 ,\n       1.31113257, 1.33919638, 1.33909007, 1.23533903, 1.31134517,\n       1.20270422, 1.36407111, 1.36555935, 1.33866486, 1.55626567,\n       1.23533903, 1.31134517, 1.20270422, 1.33685772, 1.44719951,\n       1.31166408, 1.44815623, 1.23533903, 1.31134517, 1.20270422,\n       1.33685772, 1.31113257, 1.31155778, 1.31187668, 1.23533903,\n       1.31134517, 1.20270422, 1.52735145, 1.44719951, 1.42019873,\n       1.52915859, 1.23533903, 1.31134517, 1.20281052, 1.33685772,\n       1.31113257, 1.31155778, 1.31187668, 1.23533903, 1.31134517,\n       1.20270422, 1.33685772, 1.39277273, 1.31198299, 1.50247671,\n       1.23533903, 1.31134517, 1.20270422, 1.33685772, 1.50162629,\n       1.31134517, 1.42104915, 1.23533903, 1.31134517, 1.20270422,\n       1.33685772, 1.50162629, 1.31134517, 1.42104915, 1.23533903,\n       1.31134517, 1.20270422, 1.33685772, 1.31113257, 1.31155778,\n       1.31187668, 1.23533903, 1.31134517, 1.20270422, 1.33685772,\n       1.50162629, 1.31134517, 1.42104915, 1.23533903, 1.31134517,\n       1.20281052, 1.52873338, 1.44719951, 1.42019873, 1.52915859,\n       1.23533903, 1.31134517, 1.20281052, 1.33823965, 1.52883968,\n       1.31208929, 1.36672867, 1.23533903, 1.31134517, 1.20270422,\n       1.33823965, 1.52883968, 1.31208929, 1.36672867, 1.23533903,\n       1.31134517, 1.20270422, 1.33823965, 1.33834596, 1.31230189,\n       1.55679718, 1.23533903, 1.31134517, 1.20270422, 1.33685772,\n       1.50162629, 1.31134517, 1.42104915, 1.23533903, 1.31134517,\n       1.20281052, 1.33685772, 1.52883968, 1.31208929, 1.36672867,\n       1.23533903, 1.31134517, 1.20270422, 1.3912845 , 1.41998612,\n       1.33855856, 1.50247671, 1.23533903, 1.31134517, 1.20270422,\n       1.3912845 , 1.55605307, 1.33866486, 1.36672867, 1.23533903,\n       1.31134517, 1.20270422, 1.3912845 , 1.41998612, 1.33855856,\n       1.50247671, 1.23533903, 1.31134517, 1.20270422, 1.36407111,\n       1.31113257, 1.33898377, 1.31134517, 1.23533903, 1.31134517,\n       1.20270422, 1.33685772, 1.50162629, 1.31134517, 1.42104915,\n       1.23533903, 1.31134517, 1.20281052, 1.33823965, 1.50162629,\n       1.31134517, 1.42104915, 1.23533903, 1.31134517, 1.20270422,\n       1.36545304, 1.52883968, 1.33951528, 1.36619716, 1.23533903,\n       1.31134517, 1.20270422, 1.39266643, 1.41998612, 1.33855856,\n       1.50247671, 1.23533903, 1.31134517, 1.20270422, 1.36545304,\n       1.52883968, 1.33951528, 1.36619716, 1.23533903, 1.31134517,\n       1.20270422, 1.36545304, 1.31113257, 1.33898377, 1.31134517,\n       1.23533903, 1.31134517, 1.20270422, 1.33823965, 1.31113257,\n       1.31155778, 1.31187668, 1.23533903, 1.31134517, 1.20270422,\n       1.33823965, 1.50162629, 1.31134517, 1.42104915, 1.23533903,\n       1.31134517, 1.20281052, 1.3912845 , 1.41998612, 1.33855856,\n       1.50247671, 1.23533903, 1.31134517, 1.20281052, 1.33685772,\n       1.50162629, 1.31134517, 1.42104915, 1.23533903, 1.31134517]) does not have expected shape (250,), it has shape (640,); Parameter: DSO_chan4.trace', 'getting DSO_chan4_trace')

[paniash]

I ended up adding a parameter to the driver

        # Set number of points for waveform
        self.waveform_points = Parameter(
            name="waveform_points",
            instrument=self,
            label="No. of points for waveform",
            get_cmd=":WAV:POIN?",
            set_cmd=":WAV:POIN {}",
            vals=vals.Numbers(),
            get_parser=int,
        )

And did the following to replicate the tutorial:

nPoints = 5000
dso.acquire_points(nPoints)
dso.sample_rate(nPoints/dso.timebase_range())
dso.acquire_interpolate(0)

dso.run()

# Modified addition from here onwards
dso.waveform_points(2500)
dso.ch4.trace.get()

I get no errors and get an array as the output.

However, when running do0d(dso.ch4.trace, do_plot=True) I get the following error:

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
Cell In[8], line 1
----> 1 do0d(dso.ch4.trace, do_plot=True)

File /usr/lib/python3.11/contextlib.py:81, in ContextDecorator.__call__.<locals>.inner(*args, **kwds)
     78 @wraps(func)
     79 def inner(*args, **kwds):
     80     with self._recreate_cm():
---> 81         return func(*args, **kwds)

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/dond/do_0d.py:83, in do0d(write_period, measurement_name, exp, do_plot, use_threads, log_info, *param_meas)
     77     LOG.exception(
     78         f"Could not detect shape of {measured_parameters} "
     79         f"falling back to unknown shape."
     80     )
     81     shapes = None
---> 83 _register_parameters(meas, param_meas, shapes=shapes)
     84 _set_write_period(meas, write_period)
     86 with meas.run() as datasaver:

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/dond/do_nd_utils.py:61, in _register_parameters(meas, param_meas, setpoints, shapes)
     56 real_parameters = [
     57     param for param in param_meas if isinstance(param, ParameterBase)
     58 ]
     60 for parameter in real_parameters:
---> 61     meas.register_parameter(parameter, setpoints=setpoints)
     63 if shapes is not None:
     64     parameter_names = [param.full_name for param in real_parameters]

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/measurements.py:937, in Measurement.register_parameter(self, parameter, setpoints, basis, paramtype)
    935     self._register_arrayparameter(parameter, setpoints, basis, paramtype)
    936 elif isinstance(parameter, ParameterWithSetpoints):
--> 937     self._register_parameter_with_setpoints(
    938         parameter, setpoints, basis, paramtype
    939     )
    940 elif isinstance(parameter, MultiParameter):
    941     self._register_multiparameter(
    942         parameter,
    943         setpoints,
    944         basis,
    945         paramtype,
    946     )

File ~/Downloads/git-repos/qcodes-drivers/new-qcodes/lib/python3.11/site-packages/qcodes/dataset/measurements.py:1147, in Measurement._register_parameter_with_setpoints(self, parameter, setpoints, basis, paramtype)
   1133     self._register_parameter(
   1134         name=spname,
   1135         paramtype=paramtype,
   (...)
   1139         basis=None,
   1140     )
   1142     my_setpoints.append(spname)
   1144 self._register_parameter(
   1145     parameter.register_name,
   1146     parameter.label,
-> 1147     parameter.unit,
   1148     my_setpoints,
   1149     basis,
   1150     paramtype,
   1151 )

File ~/Downloads/git-repos/qcodes-drivers/keysight/DSOX4104A.py:153, in DSOTraceParam.unit(self)
    151     return "''"
    152 elif self._unit != 0:
--> 153     return self.UNIT_MAP[self._unit]
    154 elif self.instrument is not None:
    155     self.instrument.write(f":WAV:SOUR {self._channel}")

KeyError: 32768

[paniash]

@jenshnielsen Any ideas on what error this pertains to?

[jenshnielsen]

I am not familiar with this driver but the error is that self._unit is not a key in self.UNIT_MAP I cannot say if that is due to UNIT_MAP missing a value or _unit having the wrong value

[paniash]

It's a slightly modified version of the Infiniium driver. Here's the driver.

I'm having difficulty reading out the waveform from the scope, perhaps has to do with the different scope compared to the Infiniium scope. I'd be grateful if you could provide some pointers as to how I can get it to work.

[jenshnielsen]

ITs a but hard to see what is going on. You should check the return value here self._unit = int(preamble[-1]) if that is a value in your unit_map. As far as I can see that is the only place self._unit is set