Cluster QCM-RF parameters#

QCM_RF.out0_lo_freq_cal_type_default()#

Sets/gets the Default automatic mixercalibration while setting local oscillatorfrequency for output 0.

Properties:

unit: Hz
value: <Enum: {‘off’, ‘lo only’, ‘lo and sidebands’}>

QCM_RF.out0_lo_freq()#

Please see QCoDeS for a description.

Properties:

unit: Hz
value: <Numbers 2000000000.0<=v<=18000000000.0>

QCM_RF.out1_lo_freq_cal_type_default()#

Sets/gets the Default automatic mixercalibration while setting local oscillatorfrequency for output 1.

Properties:

unit: Hz
value: <Enum: {‘off’, ‘lo only’, ‘lo and sidebands’}>

QCM_RF.out1_lo_freq()#

Please see QCoDeS for a description.

Properties:

unit: Hz
value: <Numbers 2000000000.0<=v<=18000000000.0>

QCM_RF.out0_lo_en()#

Sets/gets the local oscillator enable for output {i}.

Properties:

value: <Boolean>

QCM_RF.out1_lo_en()#

Sets/gets the local oscillator enable for output {i}.

Properties:

value: <Boolean>

QCM_RF.out0_att()#

Sets/gets output attenuation in a range of 0 dB to 60 dB with a resolution of 2dB per step.

Properties:

unit: dB
value: <Ints 0<=v<=60, Multiples of 2>

QCM_RF.out1_att()#

Sets/gets output attenuation in a range of 0 dB to 60 dB with a resolution of 2dB per step.

Properties:

unit: dB
value: <Ints 0<=v<=60, Multiples of 2>

QCM_RF.out0_offset_path0()#

Sets/gets output 0 offset for path 0.

Properties:

unit: mV
value: <Numbers -84.0<=v<=73.0>

QCM_RF.out0_offset_path1()#

Sets/gets output 0 offset for path 1.

Properties:

unit: mV
value: <Numbers -84.0<=v<=73.0>

QCM_RF.out1_offset_path0()#

Sets/gets output 0 offset for path 0.

Properties:

unit: mV
value: <Numbers -84.0<=v<=73.0>

QCM_RF.out1_offset_path1()#

Sets/gets output 0 offset for path 1.

Properties:

unit: mV
value: <Numbers -84.0<=v<=73.0>

QCM_RF.marker0_inv_en()#

Sets/gets output 0 marker invert enable

Properties:

value: <Boolean>

QCM_RF.marker1_inv_en()#

Sets/gets output 1 marker invert enable

Properties:

value: <Boolean>

QCM_RF.out0_latency()#

Gets the latency in output path 0. The output path can change depending on the filter configuration of the output.

Properties:

unit: s
value: None

QCM_RF.out0_fir_config()#

Sets/gets the configuration of FIR filter for output 0. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out0_exp0_config()#

Sets/gets configuration of exponential overshoot filter 0 for output 0. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out0_exp1_config()#

Sets/gets configuration of exponential overshoot filter 1 for output 0. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out0_exp2_config()#

Sets/gets configuration of exponential overshoot filter 2 for output 0. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out0_exp3_config()#

Sets/gets configuration of exponential overshoot filter 3 for output 0. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out1_latency()#

Gets the latency in output path 1. The output path can change depending on the filter configuration of the output.

Properties:

unit: s
value: None

QCM_RF.out1_fir_config()#

Sets/gets the configuration of FIR filter for output 1. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out1_exp0_config()#

Sets/gets configuration of exponential overshoot filter 0 for output 1. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out1_exp1_config()#

Sets/gets configuration of exponential overshoot filter 1 for output 1. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out1_exp2_config()#

Sets/gets configuration of exponential overshoot filter 2 for output 1. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.out1_exp3_config()#

Sets/gets configuration of exponential overshoot filter 3 for output 1. If ‘bypassed’, the filter is disabled. If ‘delay_comp’, the filter is bypassed, but the output is delayed as if it were applied.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker0_fir_config()#

Delay compensation config for the FIR filter on marker 0. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker0_exp0_config()#

Delay compensation config for the exponential overshoot filter 0 on marker 0. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker0_exp1_config()#

Delay compensation config for the exponential overshoot filter 1 on marker 0. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker0_exp2_config()#

Delay compensation config for the exponential overshoot filter 2 on marker 0. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker0_exp3_config()#

Delay compensation config for the exponential overshoot filter 3 on marker 0. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker1_fir_config()#

Delay compensation config for the FIR filter on marker 1. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker1_exp0_config()#

Delay compensation config for the exponential overshoot filter 0 on marker 1. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker1_exp1_config()#

Delay compensation config for the exponential overshoot filter 1 on marker 1. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker1_exp2_config()#

Delay compensation config for the exponential overshoot filter 2 on marker 1. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker1_exp3_config()#

Delay compensation config for the exponential overshoot filter 3 on marker 1. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker2_fir_config()#

Delay compensation config for the FIR filter on marker 2. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker2_exp0_config()#

Delay compensation config for the exponential overshoot filter 0 on marker 2. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker2_exp1_config()#

Delay compensation config for the exponential overshoot filter 1 on marker 2. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker2_exp2_config()#

Delay compensation config for the exponential overshoot filter 2 on marker 2. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker2_exp3_config()#

Delay compensation config for the exponential overshoot filter 3 on marker 2. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker3_fir_config()#

Delay compensation config for the FIR filter on marker 3. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker3_exp0_config()#

Delay compensation config for the exponential overshoot filter 0 on marker 3. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker3_exp1_config()#

Delay compensation config for the exponential overshoot filter 1 on marker 3. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker3_exp2_config()#

Delay compensation config for the exponential overshoot filter 2 on marker 3. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.marker3_exp3_config()#

Delay compensation config for the exponential overshoot filter 3 on marker 3. If ‘bypassed’, the marker is not delayed. If ‘enabled’, the marker is delayed.

Properties:

value: <Enum: {‘bypassed’, ‘delay_comp’}>

QCM_RF.present()#

Sets/gets module present status for slot {} in the Cluster.

Properties:

value: <Boolean>

QCM_RF.connected()#

Gets module connected status for slot {} in the Cluster.

Properties:

value: <Boolean>

QCM_RF.arm_sequencer(sequencer: int | None = None) → None#

Prepare the indexed sequencer to start by putting it in the armed state. If no sequencer index is given, all sequencers are armed. Any sequencer that was already running is stopped and rearmed. If an invalid sequencer index is given, an error is set in system error.

Parameters:: sequencer (Optional[int]) – Sequencer index.
Raises:: RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster.arm_sequencer using functools.partial to set the slot index. The docstring above is of Cluster.arm_sequencer:

QCM_RF.clear_sequencer_flags(sequencer: int | None = None) → None#

Clear flags.

Parameters:: sequencer (int) – Sequencer index.

Note

This method calls Cluster.clear_sequencer_flags using functools.partial to set the slot index. The docstring above is of Cluster.clear_sequencer_flags:

QCM_RF.connect_sequencer(sequencer: int, *connections: str) → None#

Makes new connections between the indexed sequencer and some inputs and/or outputs. This will fail if a requested connection already existed, or if the connection could not be made due to a conflict with an existing connection (hardware constraints). In such a case, the channel map will not be affected.

Parameters:

sequencer (int) – Sequencer index
*connections (str) – Zero or more connections to make, each specified using a string. The string should have the format <direction><channel> or <direction><I-channel>_<Q-channel>. <direction> must be in to make a connection between an input and the acquisition path, out to make a connection from the waveform generator to an output, or io to do both. The channels must be integer channel indices. If only one channel is specified, the sequencer operates in real mode; if two channels are specified, it operates in complex mode.

Raises:

RuntimeError – If the connection command could not be completed due to a conflict.
ValueError – If parsing of a connection fails.

Note

This method calls Cluster.connect_sequencer using functools.partial to set the slot index. The docstring above is of Cluster.connect_sequencer:

QCM_RF.delete_acquisition_data(sequencer: int, name: str = '', all: bool = False) → None#

Delete data from an acquisition specified by name in the acquisition list of indexed sequencer or delete data in all acquisitions if all is True.

Parameters:

sequencer (int) – Sequencer index.
name (str) – Weight name
all (bool) – All acquisition data

Raises:

NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.delete_acquisition_data using functools.partial to set the slot index. The docstring above is of Cluster.delete_acquisition_data:

QCM_RF.delete_dummy_binned_acquisition_data(sequencer: int | None = None, acq_index_name: str | None = None) → None#

Delete all dummy binned acquisition data for the dummy.

Parameters:

sequencer (Optional[int]) – Sequencer.
acq_index_name (Optional[str]) – Acquisition index name.

Note

This method calls Cluster.delete_dummy_binned_acquisition_data using functools.partial to set the slot index. The docstring above is of Cluster.delete_dummy_binned_acquisition_data:

QCM_RF.delete_dummy_scope_acquisition_data(sequencer: int | None) → None#

Delete dummy scope acquisition data for the dummy.

Parameters:: sequencer (Union[int, None]) – Sequencer.

Note

This method calls Cluster.delete_dummy_scope_acquisition_data using functools.partial to set the slot index. The docstring above is of Cluster.delete_dummy_scope_acquisition_data:

QCM_RF.disconnect_inputs() → None#: Disconnects all inputs from the acquisition paths of the sequencers.

Note

This method calls Cluster.disconnect_inputs using functools.partial to set the slot index. The docstring above is of Cluster.disconnect_inputs:

QCM_RF.disconnect_outputs() → None#: Disconnects all outputs from the waveform generator paths of the sequencers.

Note

This method calls Cluster.disconnect_outputs using functools.partial to set the slot index. The docstring above is of Cluster.disconnect_outputs:

QCM_RF.get_acquisition_status(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02, check_seq_state: bool = True) → bool#

Return acquisition binning completion status of the indexed sequencer. If an invalid sequencer is given, an error is set in system error. If the timeout is set to zero, the function returns the status immediately. If a positive non-zero timeout is set, the function blocks until the acquisition binning completes. If the acquisition hasn’t completed before the timeout expires, a TimeoutError is thrown. Note that when sequencer state checking is enabled, the sequencer state is checked using get_sequencer_status with the selected timeout period first and then the acquisition status is checked with the same timeout period. This means that the total timeout period is two times the set timeout period.

Parameters:

sequencer (int) – Sequencer index.
timeout (int) – Timeout in minutes.
timeout_poll_res (float) – Timeout polling resolution in seconds.
check_seq_state (bool) – Check if sequencer is done before checking acquisition status.

Returns:

Indicates the acquisition binning completion status (False = uncompleted, True = completed).

Return type:

bool

Raises:

TimeoutError – Timeout
NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.get_acquisition_status using functools.partial to set the slot index. The docstring above is of Cluster.get_acquisition_status:

QCM_RF.get_acquisitions(sequencer: int, *, as_numpy: bool = False) → dict#

Get all acquisitions in acquisition lists of indexed sequencer. The acquisition scope and bin data is normalized to a range of -1.0 to 1.0 taking both the bit widths of the processing path and average count into consideration. For the binned integration results, the integration length is not handled during normalization and therefore these values have to be divided by their respective integration lengths. The returned dictionary is structured as follows:

name: acquisition name
- index: acquisition index used by the sequencer Q1ASM program to refer
  to the acquisition.
- acquisition: acquisition dictionary
  scope: Scope data
  
  path0: input path 0
  
  data: acquisition samples in a range of 1.0 to -1.0.
  
  out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).
  
  avg_cnt: number of averages.
  
  path1: input path 1
  
  data: acquisition samples in a range of 1.0 to -1.0.
  
  out-of-range: out-of-range indication for the entire acquisition (False = in-range, True = out-of-range).
  
  avg_cnt: number of averages.
  
  bins: bin data
  
  integration: integration data
  
  path_0: input path 0 integration result bin list
  
  path_1: input path 1 integration result bin list
  
  threshold: threshold result bin list
  
  valid: list of valid indications per bin
  
  avg_cnt: list of number of averages per bin

Parameters:

sequencer (int) – Sequencer index.
as_numpy (bool) – Whether to return path, threshold and avg_cnt data as NumPy arrays instead of Python lists.

Returns:

Dictionary with acquisitions.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.get_acquisitions using functools.partial to set the slot index. The docstring above is of Cluster.get_acquisitions:

QCM_RF.get_assembler_log() → str#

Get assembler log.

Returns:

Assembler log.

Return type:

str

Raises:

Exception – Invalid input parameter type.
Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster.get_assembler_log using functools.partial to set the slot index. The docstring above is of Cluster.get_assembler_log:

QCM_RF.get_assembler_status() → bool#

Get assembler status. Refer to the assembler log to get more information regarding the assembler result.

Returns:

Assembler status (False = failed, True = success).

Return type:

bool

Raises:

Exception – Invalid input parameter type.
Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster.get_assembler_status using functools.partial to set the slot index. The docstring above is of Cluster.get_assembler_status:

QCM_RF.get_scope_data(io_channel: int) → Any#

Returns the QTM I/O channel scope data for the given slot and channel acquired since the previous call.

Parameters:: io_channel (int) – I/O channel you want to get the data for.
Returns:: The acquired data. Empty if no data acquired since last call.
Return type:: Any
Raises:: NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.get_scope_data using functools.partial to set the slot index. The docstring above is of Cluster.get_scope_data:

QCM_RF.get_sequencer_status(sequencer: int, timeout: int = 0, timeout_poll_res: float = 0.02) → qblox_instruments.native.definitions.SequencerStatus#

Get the sequencer status. If an invalid sequencer index is given, an error is set in system error. If the timeout is set to zero, the function returns the state immediately. If a positive non-zero timeout is set, the function blocks until the sequencer completes. If the sequencer hasn’t stopped before the timeout expires, a TimeoutError is thrown.

Parameters:

sequencer (int) – Sequencer index.
timeout (int) – Timeout in minutes.
timeout_poll_res (float) – Timeout polling resolution in seconds.

Returns:

Tuple containing sequencer status and corresponding flags.

Return type:

SequencerStatus

Raises:

TimeoutError – Timeout

Note

This method calls Cluster.get_sequencer_status using functools.partial to set the slot index. The docstring above is of Cluster.get_sequencer_status:

QCM_RF.get_waveforms(sequencer: int, *, as_numpy: bool = False) → dict#

Get all waveforms in the AWG waveform list of indexed sequencer. The returned dictionary is structured as follows:

name: waveform name.
- data: waveform samples in a range of 1.0 to -1.0.
- index: waveform index used by the sequencer Q1ASM program to refer
  to the waveform.

Parameters:

sequencer (int) – Sequencer index.
as_numpy (bool) – Whether to return data as NumPy arrays instead of Python lists.

Returns:

Dictionary with waveforms.

Return type:

dict

Note

This method calls Cluster.get_waveforms using functools.partial to set the slot index. The docstring above is of Cluster.get_waveforms:

QCM_RF.get_weights(sequencer: int, *, as_numpy: bool = False) → dict#

Get all weights in the acquisition weight lists of indexed sequencer. The returned dictionary is structured as follows:

-name : weight name.

data: weight samples in a range of 1.0 to -1.0.

index: weight index used by the sequencer Q1ASM program to refer
to the weight.

Parameters:

sequencer (int) – Sequencer index.
as_numpy (bool) – Whether to return data as NumPy arrays instead of Python lists.

Returns:

Dictionary with weights.

Return type:

dict

Raises:

NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.get_weights using functools.partial to set the slot index. The docstring above is of Cluster.get_weights:

QCM_RF.out0_lo_cal() → None#

Run LO Calibration Algorithm

Parameters:

output (int) – output that will be affected by the calibration

Return type:

None

Raises:

Exception – Invalid input parameter type.
Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster._run_mixer_lo_calib using functools.partial to set the slot index. The docstring above is of Cluster._run_mixer_lo_calib:

QCM_RF.out1_lo_cal() → None#

Run LO Calibration Algorithm

Parameters:

output (int) – output that will be affected by the calibration

Return type:

None

Raises:

Exception – Invalid input parameter type.
Exception – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster._run_mixer_lo_calib using functools.partial to set the slot index. The docstring above is of Cluster._run_mixer_lo_calib:

QCM_RF.reset_duc_phase_dac(*args, **kwargs) → None#

QCM_RF.scope_trigger_arm() → None#

Arms the external scope trigger logic on a QTM, such that it will send a trigger to scope acquisition blocks in the I/O channels when the trigger condition is satisfied.

Raises:: NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.scope_trigger_arm using functools.partial to set the slot index. The docstring above is of Cluster.scope_trigger_arm:

QCM_RF.set_dac_current(*args, **kwargs) → None#

QCM_RF.set_decoder_mode(*args, **kwargs) → None#

QCM_RF.set_dummy_binned_acquisition_data(sequencer: int, acq_index_name: str, data: collections.abc.Iterable[Optional[qblox_instruments.ieee488_2.dummy_transport.DummyBinnedAcquisitionData]]) → None#

Set dummy binned acquisition data for the dummy.

Parameters:

sequencer (int) – Sequencer.
acq_index_name (str) – Acquisition index name.
data (Iterable[Union[DummyBinnedAcquisitionData, None]]) – Dummy data for the binned acquisition. An iterable of all the bin values.

Note

This method calls Cluster.set_dummy_binned_acquisition_data using functools.partial to set the slot index. The docstring above is of Cluster.set_dummy_binned_acquisition_data:

QCM_RF.set_dummy_scope_acquisition_data(sequencer: int | None, data: qblox_instruments.ieee488_2.dummy_transport.DummyScopeAcquisitionData) → None#

Set dummy scope acquisition data for the dummy.

Parameters:

sequencer (Union[int, None]) – Sequencer.
data (DummyScopeAcquisitionData) – Dummy data for the scope acquisition.

Note

This method calls Cluster.set_dummy_scope_acquisition_data using functools.partial to set the slot index. The docstring above is of Cluster.set_dummy_scope_acquisition_data:

QCM_RF.set_inv_sync_filter(*args, **kwargs) → None#

QCM_RF.set_mixer_settings_coarse_delay_dac(*args, **kwargs) → None#

QCM_RF.set_mixer_settings_freq_dac(*args, **kwargs) → None#

QCM_RF.set_qsm_outputs_to_zero() → None#

Resets the output for all channels to zero.

Return type:: None
Raises:: Exception – Invalid input parameter type.

Note

This method calls Cluster.set_qsm_outputs_to_zero using functools.partial to set the slot index. The docstring above is of Cluster.set_qsm_outputs_to_zero:

QCM_RF.set_rfdc_nyquist_zone(*args, **kwargs) → None#

QCM_RF.set_safe_voltage_range(min_voltage: float, max_voltage: float) → None#

Set the safe voltage range for all the channels of the current module.

Parameters:

min_voltage (float) – The desired minimum voltage in volts.
max_voltage (float) – The desired maximum voltage in volts.

QCM_RF.start_sequencer(sequencer: int | None = None) → None#

Start the indexed sequencer, thereby putting it in the running state. If an invalid sequencer index is given or the indexed sequencer was not yet armed, an error is set in system error. If no sequencer index is given, all armed sequencers are started and any sequencer not in the armed state is ignored. However, if no sequencer index is given and no sequencers are armed, and error is set in system error.

Parameters:: sequencer (Optional[int]) – Sequencer index.
Raises:: RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster.start_sequencer using functools.partial to set the slot index. The docstring above is of Cluster.start_sequencer:

QCM_RF.stop_sequencer(sequencer: int | None = None) → None#

Stop the indexed sequencer, thereby putting it in the stopped state. If an invalid sequencer index is given, an error is set in system error. If no sequencer index is given, all sequencers are stopped.

Parameters:: sequencer (Optional[int]) – Sequencer index.
Raises:: RuntimeError – An error is reported in system error and debug <= 1. All errors are read from system error and listed in the exception.

Note

This method calls Cluster.stop_sequencer using functools.partial to set the slot index. The docstring above is of Cluster.stop_sequencer:

QCM_RF.store_scope_acquisition(sequencer: int, name: str) → None#

After an acquisition has completed, store the scope acquisition results in the acquisition specified by name of the indexed sequencers. If an invalid sequencer index is given an error is set in system error. To get access to the acquisition results, the sequencer will be stopped when calling this function.

Parameters:

sequencer (int) – Sequencer index.
name (str) – Acquisition name.

Raises:

NotImplementedError – Functionality not available on this module.

Note

This method calls Cluster.store_scope_acquisition using functools.partial to set the slot index. The docstring above is of Cluster.store_scope_acquisition:

QCM_RF.toggle_all_lo(enable: bool) → None#

Turn ON or OFF all local oscillators present on this module.

Parameters:: enable (bool) – Turn ON if True, OFF if False.
Raises:: TypeError – If called on a non-RF module.

QCM_RF.update_sequence(sequencer: int, erase_existing: bool = False, **sequence_args: typing_extensions.Unpack[qblox_instruments.types.Sequence]) → None#

Update sequencer program, AWG waveforms, acquisition weights and/or acquisitions from a series of keyword arguments. By default, the update is cumulative i.e. existing waveforms/weights/acquisitions are kept on the sequencer and new ones are added (as long as indexes or names aren’t reused).

For example:

sequencer.update_sequence(
    waveforms={"wave0": {"index": 0, "data": [0.0, 0.1, 0.2, 0.3]}},
    weights={"weight0": {"index": 0, "data": [0.0, 0.1, 0.2, 0.3]}},
    erase_existing=False
)

will add one waveform and one weight to the sequencer, without either removing currently uploaded waveforms and weights, or clearing program or acquisitions.

If the erase_existing parameter is passed, then the update is destructive i.e. existing program/waveforms/weights/acquisitions will be completely overwritten with the new ones.

For example:

 sequencer.update_sequence(
     program="play 0,0,100\nstop",
     acquisitions={"acq0": {"index": 0, "num_bins": 1}},
     erase_existing=True
)

will completely replace the program and the acquisitions on the sequencer, but will not touch currently uploaded waveforms and weights.

Parameters:

sequencer (int) – Sequencer index.
erase_existing (bool) – Whether existing waveforms/weights/acquisitions should be erased before adding new ones.
**sequence_args (Unpack[Sequence]) – Sequence dictionary in keyword arguments format.

Raises:

JsonSchemaValueException – Invalid JSON object.

Note

This method calls Cluster.update_sequence using functools.partial to set the slot index. The docstring above is of Cluster.update_sequence: