def test_write_integration_weights(mock_connection, readout):
waveforms = Waveforms()
waveforms[0] = np.ones(1000)
waveforms[1] = np.ones(1000, dtype=np.complex128)
waveforms[2] = (np.ones(1000), np.ones(1000))
waveforms_long = Waveforms()
waveforms_long[1000] = np.zeros(1000)
with patch(
"zhinst.toolkit.driver.nodes.readout.deviceutils", autospec=True
) as deviceutils:
readout.write_integration_weights(waveforms)
complex_wave = np.empty(1000, dtype=np.complex128)
complex_wave.real = np.ones(1000)
complex_wave.imag = np.ones(1000)
assert (
deviceutils.configure_weighted_integration.call_args[0][0]
== mock_connection.return_value
)
assert deviceutils.configure_weighted_integration.call_args[0][1] == "DEV1234"
assert deviceutils.configure_weighted_integration.call_args[0][2] == 0
assert np.allclose(
deviceutils.configure_weighted_integration.call_args[1]["weights"][1],
np.ones(1000, dtype=np.complex128),
)
assert np.allclose(
deviceutils.configure_weighted_integration.call_args[1]["weights"][2],
complex_wave,
)
assert (
deviceutils.configure_weighted_integration.call_args[1]["integration_delay"]
== 0.0
)
assert (
deviceutils.configure_weighted_integration.call_args[1]["clear_existing"]
== True
)
readout.write_integration_weights(waveforms, integration_delay=0.5)
assert (
deviceutils.configure_weighted_integration.call_args[1]["integration_delay"]
== 0.5
)
readout.write_integration_weights(waveforms, clear_existing=False)
assert (
deviceutils.configure_weighted_integration.call_args[1]["clear_existing"]
== False
)
readout.write_integration_weights({0: np.ones(1000)}, clear_existing=True)
assert all(
deviceutils.configure_weighted_integration.call_args[1]["weights"][0]
== np.ones(1000)
)
with pytest.raises(RuntimeError) as e_info:
readout.write_integration_weights(waveforms_long)
def write_to_waveform_memory(
self, waveforms: Waveforms, indexes: list = None, validate: bool = True
) -> None:
"""Writes waveforms to the waveform memory.
The waveforms must already be assigned in the sequencer program.
Args:
waveforms: Waveforms that should be uploaded.
indexes: Specify a list of indexes that should be uploaded. If
nothing is specified all available indexes in waveforms will
be uploaded. (default = None)
validate: Enable sanity check preformed by toolkit, based on the
waveform descriptors on the device. Can be disabled for e.g.
speed optimizations. Does not affect the checks happen in LabOne
and or the firmware. (default = True)
Raises:
IndexError: The index of a waveform exceeds the one on the device
and `validate` is True.
RuntimeError: One of the waveforms index points to a
filler(placeholder) and `validate` is True.
"""
waveform_info = None
num_waveforms = None
if validate:
waveform_info = json.loads(self.waveform.descriptors()).get("waveforms", [])
num_waveforms = len(waveform_info)
with create_or_append_set_transaction(self._root):
for waveform_index in waveforms.keys():
if indexes and waveform_index not in indexes:
continue
if num_waveforms is not None and waveform_index >= num_waveforms:
raise IndexError(
f"There are {num_waveforms} waveforms defined on the device "
"but the passed waveforms specified one with index "
f"{waveform_index}."
)
if (
waveform_info
and "__filler" in waveform_info[waveform_index]["name"]
):
raise RuntimeError(
f"The waveform at index {waveform_index} is only "
"a filler and can not be overwritten"
)
self.root.transaction.add(
self.waveform.waves[waveform_index],
waveforms.get_raw_vector(
waveform_index,
target_length=int(waveform_info[waveform_index]["length"])
if waveform_info
else None,
),
)
def read_integration_weights(self, slots: t.List[int] = None) -> Waveforms:
"""Read integration weights from the waveform memory.
Args:
slots: List of weight slots to read from the device. If not specified
all available weights will be downloaded.
Returns:
Mutable mapping of the downloaded weights.
"""
nodes = []
if slots is not None:
for slot in slots:
nodes.append(
self.integration.weights[slot].wave.node_info.path)
else:
nodes.append(self.integration.weights["*"].wave.node_info.path)
nodes_str = ",".join(nodes)
weights_raw = self._daq_server.get(nodes_str,
settingsonly=False,
flat=True)
weights = Waveforms()
for slot, weight in enumerate(weights_raw.values()):
weights[slot] = weight[0]["vector"]
return weights
def read_from_waveform_memory(self,
slots: t.List[int] = None) -> Waveforms:
"""Read pulses from the waveform memory.
Args:
slots: List of waveform indexes to read from the device. If not
specified all assigned waveforms will be downloaded.
Returns:
Mutable mapping of the downloaded waveforms.
"""
nodes = []
if slots is not None:
for slot in slots:
nodes.append(self.waveforms[slot].wave.node_info.path)
else:
nodes.append(self.waveforms["*"].wave.node_info.path)
nodes_str = ",".join(nodes)
waveforms_raw = self._daq_server.get(nodes_str,
settingsonly=False,
flat=True)
waveforms = Waveforms()
for slot, waveform in enumerate(waveforms_raw.values()):
waveforms[slot] = waveform[0]["vector"]
return waveforms
def read_from_waveform_memory(self, indexes: t.List[int] = None) -> Waveforms:
"""Read waveforms to the waveform memory.
Args:
indexes: List of waveform indexes to read from the device. If not
specified all assigned waveforms will be downloaded.
Returns:
Waveform object with the downloaded waveforms.
"""
nodes = [self.waveform.descriptors.node_info.path]
if indexes is not None:
for index in indexes:
nodes.append(self.waveform.node_info.path + f"/waves/{index}")
else:
nodes.append(self.waveform.waves["*"].node_info.path)
nodes_str = ",".join(nodes)
waveforms_raw = self._session.daq_server.get(
nodes_str, settingsonly=False, flat=True
)
waveform_info = json.loads(
waveforms_raw.pop(self.waveform.descriptors.node_info.path)[0]["vector"]
).get("waveforms", [])
waveforms = Waveforms()
for node, waveform in waveforms_raw.items():
slot = int(node[-1])
if "__filler" not in waveform_info[slot]["name"]:
waveforms.assign_native_awg_waveform(
slot,
waveform[0]["vector"],
channels=int(waveform_info[slot].get("channels", 1)),
markers_present=bool(
int(waveform_info[slot].get("marker_bits")[0])
),
)
return waveforms
def test_assign():
waveform = Waveforms()
wave = np.ones(1008)
waveform[0] = (wave,)
assert all(waveform[0][0] == wave)
waveform[1] = (wave, -wave)
assert all(waveform[1][0] == wave)
assert all(waveform[1][1] == -wave)
waveform[2] = (wave, wave, -wave)
assert all(waveform[2][0] == wave)
assert all(waveform[2][1] == wave)
assert all(waveform[2][2] == -wave)
waveform[3] = (0.5 * wave, None, wave)
assert all(waveform[3][0] == 0.5 * wave)
assert waveform[3][1] == None
assert all(waveform[3][2] == wave)
waveform[4] = (np.ones(1008, dtype=np.complex128), wave)
assert all(waveform[4][0] == np.ones(1008, dtype=np.complex128))
assert all(waveform[4][1] == wave)
waveform[6] = (Wave(-wave, "w1", 1), Wave(wave, "w2", 2), wave)
assert all(waveform[6][0] == -wave)
assert waveform[6][0].name == "w1"
assert waveform[6][0].output == 1
assert all(waveform[6][1] == wave)
assert waveform[6][1].name == "w2"
assert waveform[6][1].output == 2
assert all(waveform[6][2] == wave)
waveform[7] = (Wave(wave, "w", 1), wave)
assert all(waveform[7][0] == wave)
assert waveform[7][0].name == "w"
assert waveform[7][0].output == 1
assert all(waveform[2][1] == wave)
assert waveform[7][1].name == None
assert waveform[7][1].output == None
assert waveform[7][2] == None
waveform[8] = (Wave(wave, "test", 3), wave, -wave)
assert all(waveform[8][0] == wave)
assert waveform[8][0].name == "test"
assert waveform[8][0].output == 3
assert all(waveform[8][1] == wave)
assert waveform[8][1].name == None
assert waveform[8][1].output == None
assert all(waveform[8][2] == -wave)
def test_get_raw_vector():
waveform = Waveforms()
waveform[0] = (np.ones(1008), np.ones(1008))
waveform[1] = (np.ones(1008), np.ones(1008), np.ones(1008))
waveform[2] = np.ones(1008, dtype=np.complex128)
waveform[3] = (np.ones(1008, dtype=np.complex128), np.ones(1008))
# non complex
result0 = waveform.get_raw_vector(0)
assert len(result0) == 2016
result1 = waveform.get_raw_vector(1)
assert len(result1) == 3024
assert result0[0] == result1[0]
assert result0[1] == result1[1]
assert result1[2] == 1
result2 = waveform.get_raw_vector(2)
assert len(result2) == 2016
assert result0[0] == result2[0]
assert result2[1] == 0
assert result0[2] == result2[2]
result3 = waveform.get_raw_vector(3)
assert len(result3) == 3024
assert result0[0] == result3[0]
assert result3[1] == 0
assert result3[2] == 1
# complex
result0 = waveform.get_raw_vector(0, complex_output=True)
assert len(result0) == 1008
assert result0.dtype == np.complex128
with pytest.warns(RuntimeWarning):
result1 = waveform.get_raw_vector(1, complex_output=True)
assert len(result1) == 1008
assert all(result0 == result1)
result2 = waveform.get_raw_vector(2, complex_output=True)
assert all(result2 == np.ones(1008, dtype=np.complex128))
with pytest.warns(RuntimeWarning):
result3 = waveform.get_raw_vector(3, complex_output=True)
assert all(result3 == np.ones(1008, dtype=np.complex128))
# invalid length
with pytest.raises(ValueError):
waveform.get_raw_vector(0, target_length=1000)
with pytest.raises(ValueError):
waveform.get_raw_vector(0, target_length=2000)
def test_dict_behavior():
waveform = Waveforms()
wave1 = 1.0 * np.ones(1008)
wave1_short = 1.0 * np.ones(500)
wave2 = -1.0 * np.ones(1008)
wave3 = -0.5 * np.ones(1008)
marker = 0.0 * np.ones(1008)
with pytest.raises(TypeError) as e_info:
waveform[0] = 1
with pytest.raises(RuntimeError) as e_info:
waveform[0] = (wave1, wave2, wave3, marker)
# "standart" waveform
waveform[0] = (wave1, wave2)
assert all(waveform[0][0] == wave1)
assert all(waveform[0][1] == wave2)
assert waveform[0][2] == None
assert len(waveform.get_raw_vector(0)) == 1008 * 2
# replace wave
waveform[0] = (wave1, wave3)
assert all(waveform[0][0] == wave1)
assert all(waveform[0][1] == wave3)
assert waveform[0][2] == None
# replace wave
waveform.assign_waveform(0, wave1, wave2)
assert all(waveform[0][0] == wave1)
assert all(waveform[0][1] == wave2)
assert waveform[0][2] == None
# delete wave
assert 0 in waveform.keys()
del waveform[0]
assert 0 not in waveform.keys()
# iter
waveform[0] = (wave1, wave3)
waveform[2] = (wave1, wave3)
waveform[10] = (wave1, wave3)
assert len(waveform) == 3
num_elements = 0
for _, element in waveform.items():
assert all(element[0] == wave1)
assert all(element[1] == wave3)
num_elements += 1
assert num_elements == len(waveform)
# "standart" waveform with marker
waveform[1] = (wave1, wave2, marker)
assert all(waveform[1][0] == wave1)
assert all(waveform[1][1] == wave2)
assert all(waveform[1][2] == marker)
assert len(waveform.get_raw_vector(1)) == 1008 * 3
# unequal length
with pytest.raises(RuntimeError) as e_info:
waveform[10] = (wave1_short, wave2)
with pytest.raises(RuntimeError) as e_info:
waveform[10] = (wave1, wave2, wave1_short)
# invalid inputs
with pytest.raises(RuntimeError) as e_info:
waveform[10] = (0, 0, 0)
# complex values
waveform[10] = np.ones(1008, dtype=np.complex128)
waveform[10] = (np.ones(1008, dtype=np.complex128), marker)
waveform[10] = (np.ones(1008, dtype=np.complex128), None, marker)
with pytest.raises(RuntimeError) as e_info:
waveform[10] = (np.ones(1008, dtype=np.complex128), wave2, None)
def test_sequence_snippet():
waveform = Waveforms()
waveform[0] = (Wave(np.ones(1008), "w1", 3), Wave(np.ones(1008), "w2", 2))
waveform[3] = (Wave(np.ones(252), "w3"), np.ones(252), 1 * np.ones(252))
waveform[1] = (np.ones(504), np.ones(504), 15 * np.ones(504))
waveform[5] = (np.ones(252),)
result = waveform.get_sequence_snippet()
assert (
result
== """\
wave w1 = placeholder(1008, false, false);
wave w2 = placeholder(1008, false, false);
assignWaveIndex(1, 2, w1, 2, w2, 0);
assignWaveIndex(placeholder(504, true, true), placeholder(504, true, true), 1);
wave w3 = placeholder(252, true, false);
assignWaveIndex(w3, placeholder(252, false, false), 3);
assignWaveIndex(placeholder(252, false, false), 5);"""
)
waveform = Waveforms()
waveform.assign_waveform(
0,
Wave(np.ones(1008), name="w1", output=OutputType.OUT1 | OutputType.OUT2),
Wave(np.ones(1008), name="w2", output=OutputType.OUT1 | OutputType.OUT2),
np.ones(1008),
)
waveform.assign_waveform(
3,
np.ones(1008),
np.ones(1008),
np.ones(1008),
)
waveform.assign_waveform(
5,
np.ones(1008),
np.ones(1008),
)
waveform.assign_waveform(
4,
Wave(np.ones(1008), name="test1", output=OutputType.OUT2),
Wave(np.ones(1008), name="test2", output=OutputType.OUT1),
)
waveform[2] = (np.ones(1008, dtype=np.complex128), None, 15 * np.ones(1008))
waveform[1] = (
Wave(
np.ones(1008, dtype=np.complex128),
name=["comp1", "comp2"],
output=[OutputType.OUT2, OutputType.OUT1 | OutputType.OUT2],
),
)
result = waveform.get_sequence_snippet()
assert (
result
== """\
wave w1 = placeholder(1008, true, false);
wave w2 = placeholder(1008, false, false);
assignWaveIndex(1, 2, w1, 1, 2, w2, 0);
wave comp1 = placeholder(1008, false, false);
wave comp2 = placeholder(1008, false, false);
assignWaveIndex(2, comp1, 1, 2, comp2, 1);
assignWaveIndex(placeholder(1008, true, true), placeholder(1008, true, true), 2);
assignWaveIndex(placeholder(1008, true, false), placeholder(1008, false, false), 3);
wave test1 = placeholder(1008, false, false);
wave test2 = placeholder(1008, false, false);
assignWaveIndex(2, test1, 1, test2, 4);
assignWaveIndex(placeholder(1008, false, false), placeholder(1008, false, false), 5);"""
)