SplineCalibrationΒΆ

Class Arguments

Argument

Type

Default Value

calibration_points

TList(TList(TFloat))

input_unit

TStr

output_unit

TStr

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Inheritance diagram of atomiq.components.basics.calibration.SplineCalibration

Example Component Dictionary

   {
    "calibration_example": {
        "classname": "atomiq.components.basics.calibration.SplineCalibration",
        "arguments": {
            "calibration_points": "<mandatory parameter (TList(TList(TFloat)))>",
            "input_unit": "<mandatory parameter (TStr)>",
            "output_unit": "<mandatory parameter (TStr)>"
        }
    }
}

Class Description

class atomiq.components.basics.calibration.SplineCalibration(calibration_points, *args, **kwargs)

Bases: Calibration

Calibration via data points

Data points are interpolated with linear splines

Parameters:

calibration_points (TList(TList(TFloat))) -- List of tuples (x, y) containing the calibration data. The data must be ordered monotonously in x

transform(input_value, invert=False)

Transform a value according to the calibration

Parameters:
  • input_value (artiq.compiler.types.TMono('float', OrderedDict())) -- value to be transformed

  • invert (artiq.compiler.types.TMono('bool', OrderedDict()))

Returns:

transformed value

Return type:

TFloat