Measurement Details Class
- Updated2022-07-11
- 1 minute(s) read
Measurement Details Class
MeasurementDetails is a data class that contains information about a specific measurement taken during the test run.
If a low_limit or high_limit parameter is provided, the low_limit, high_limit, nominal_value, and result fields are included in the data log.
The Result field value is set to Pass if the provided value is within the thresholds set by low_limit and high_limit. If either a low_limit or high_limit is not provided, a single‑sided comparison is performed. If both low_limit and high_limit are not provided, no comparison is performed and the nominal_value field is excluded from the data log.
MeasurementDetails( name="Distortion", spec_id="DIST1", value=distortion, unit="%" )
Parameter | Required? | Data Type | Description |
---|---|---|---|
name | Yes | String | Name of the measurement. |
spec_id | Yes | String | Spec ID associated with the measurement. |
value | Yes | Float | Value of the measurement. |
unit | Yes | String | Unit of measure for the data. |
high_limit | No | Float | Expected upper limit set for the measurement. By default, high_limit is set to None. |
low_limit | No | Float | Expected lower limit set for the measurement. By default, low_limit is set to None. |
nominal_value | No | Float | Expected nominal value set for the measurement. By default, nominal_value is set to None. |