quantify_scheduler.backends.corrections

Pulse and acquisition corrections for hardware compilation.

Module Contents

Classes

LatencyCorrections

A datastructure containing the information required to correct for latencies

Functions

distortion_correct_pulse(...)

Sample pulse and apply filter function to the sample to distortion correct it.

apply_distortion_corrections(→ quantify_scheduler.Schedule)

Apply distortion corrections to operations in the schedule.

Attributes

logger

logger[source]
class LatencyCorrections[source]

Bases: quantify_scheduler.structure.DataStructure

A datastructure containing the information required to correct for latencies on signals specified by port-clock combinations.

Note, if the port-clock combination of a signal is not specified in the latency corrections, no correction will be applied.

Parameters

latencies – A dictionary specifying the latencies to be corrected for. Keys are port-clocks combinations specifying the signal for which latency should be corrected, e.g., port=q0:mw and clock=q0.01 will have the string "q0:mw-q0.01" as a key. Values are latencies of the signal to be corrected for in seconds, e.g., if a signal has a latency of 120e-9, the signal will be shifted by -120 ns to correct for this latency.

latencies :Dict[str, float][source]
distortion_correct_pulse(pulse_data: Dict[str, Any], sampling_rate: int, filter_func_name: str, input_var_name: str, kwargs_dict: Dict[str, Any], clipping_values: Optional[Tuple[float]] = None) quantify_scheduler.operations.pulse_library.NumericalPulse[source]

Sample pulse and apply filter function to the sample to distortion correct it.

Parameters
  • pulse_data – Definition of the pulse.

  • sampling_rate – The sampling rate used to generate the time axis values.

  • filter_func_name – The filter function path of the dynamically loaded filter function. Example: "scipy.signal.lfilter".

  • input_var_name – The input variable name of the dynamically loaded filter function, most likely: "x".

  • kwargs_dict – Dictionary containing kwargs for the dynamically loaded filter function. Example: {"b": [0.0, 0.5, 1.0], "a": 1}.

  • clipping_values – Min and max value to which the corrected pulse will be clipped, depending on allowed output values for the instrument.

Returns

The sampled, distortion corrected pulse wrapped in a NumericalPulse.

apply_distortion_corrections(schedule: quantify_scheduler.Schedule, hardware_cfg: Dict[str, Any]) quantify_scheduler.Schedule[source]

Apply distortion corrections to operations in the schedule. Defined via the hardware configuration file, example:

"distortion_corrections": {
    "q0:fl-cl0.baseband": {
        "filter_func": "scipy.signal.lfilter",
        "input_var_name": "x",
        "kwargs": {
            "b": [0.0, 0.5, 1.0],
            "a": [1]
        },
        "clipping_values": [-2.5, 2.5]
    }
}

Clipping values are the boundaries to which the corrected pulses will be clipped, upon exceeding, these are optional to supply.

For pulses in need of correcting (indicated by their port-clock combination) we are only replacing the dict in "pulse_info" associated to that specific pulse. This means that we can have a combination of corrected (i.e., pre-sampled) and uncorrected pulses in the same operation.

Note that we are not updating the "operation_repr" key, used to reference the operation from the schedulable.

Parameters
  • schedule – The schedule that contains operations that are to be distortion corrected.

  • hardware_cfg – The hardware configuration of the setup.

Returns

The schedule with distortion corrected operations.

Raises
  • KeyError – when elements are missing in distortion correction config for a port-clock combination.

  • KeyError – when clipping values are supplied but not two values exactly, min and max.