SigmoidCalibration#
Class Arguments
Argument |
Type |
Default Value |
---|---|---|
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
Example Component Dictionary
{
"calibration_example": {
"classname": "atomiq.components.basics.calibration.SigmoidCalibration",
"arguments": {
"input_unit": "<mandatory parameter (TStr)>",
"output_unit": "<mandatory parameter (TStr)>"
}
}
}
Class Description
- class atomiq.components.basics.calibration.SigmoidCalibration(*args, A, k, x_offset=0, y_offset=0, **kwargs)
Bases:
Calibration
Sigmoid calibration
` output = A / ( 1 + e^k*(input - x_offset)) + y_offset `
- Parameters:
input_unit -- Unit of the input
output_unit -- Unit of the output
A (TFloat) -- Amplitude of the sigmoid
k (TFloat) -- stretching of the sigmoid
x_offset (TFloat) -- offset on the x axis
y_offset (TFloat) -- offset on the y axis
- transform(input_value)
Transform a value according to the calibration
- Parameters:
input_value (TFloat) -- value to be transformed
- Returns:
transformed value
- Return type:
TFloat