laboneq.dsl.result
¶
laboneq.dsl.result.results
¶
Results
dataclass
¶
device_calibration: Calibration | None
property
¶
Get the device setup's calibration.
See also DeviceSetup.get_calibration.
experiment_calibration
property
¶
signal_map
property
¶
get_axis(handle)
¶
Returns the axes grids.
Returns the list, where each element represents an axis of the corresponding dimension of the result array returned by 'get'. Each element is either a 1D numpy array for a simple sweep, or a list of 1D numpy arrays for a parallel sweep. The length of each array matches the number of steps of the corresponding sweep, and the values are the sweep parameter values at each step.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handle |
str
|
The handle assigned to an 'acquire' event in the experiment definition. |
required |
Returns:
| Type | Description |
|---|---|
list[ArrayLike | list[ArrayLike]]
|
A list of axis grids. Each element may be either a 1D numpy array or a list of such |
list[ArrayLike | list[ArrayLike]]
|
arrays. |
Raises:
| Type | Description |
|---|---|
LabOneQException
|
No result is available for the provided handle. |
get_axis_name(handle)
¶
Returns the names of axes.
Returns the list of axis names, that correspond to the dimensions of the result returned by 'get'. Elements in the list are in the same order as the dimensions of the array returned by 'get'. Each element is either a string for a simple sweep, or a list of strings for a parallel sweep. Values are given by the 'axis_name' argument of the corresponding sweep parameter, or the 'uid' of the same parameter, if 'axis_name' is not specified.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handle |
str
|
The handle assigned to an 'acquire' event in the experiment definition. |
required |
Returns:
| Type | Description |
|---|---|
list[str | list[str]]
|
A list of axis names. Each element may be either a string or a list of strings. |
Raises:
| Type | Description |
|---|---|
LabOneQException
|
No result is available for the provided handle. |
get_data(handle)
¶
Returns the acquired result data.
Returns the result acquired for an 'acquire' event with the specific handle that was assigned to it in the experiment definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handle |
str
|
The handle assigned to an 'acquire' event in the experiment definition. |
required |
Returns:
| Type | Description |
|---|---|
ArrayLike
|
A multidimensional numpy array, where each dimension corresponds to a sweep |
ArrayLike
|
loop nesting level, the outermost sweep being the first dimension. |
Raises:
| Type | Description |
|---|---|
LabOneQException
|
No result is available for the provided handle. |
get_last_nt_step(handle)
¶
Returns the list of axis indices of the last measured near-time point.
Returns the list of axis indices that represent the last measured near-time point. Use this to retrieve the last recorded partial result from the 'data' array. 'None' means that no measurements were taken so far. The list only covers axes that correspond to the near-time sweeps / dimensions. All the elements of inner real-time sweeps that correspond to a single real-time execution step are read at once and filled entirely.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handle |
str
|
The handle assigned to an 'acquire' event in the experiment definition. |
required |
Returns:
| Type | Description |
|---|---|
list[int]
|
A list of axis indices. |
Raises:
| Type | Description |
|---|---|
LabOneQException
|
No result is available for the provided handle. |
get_result(handle)
¶
Returns the acquired result.
Returns the result acquired for an 'acquire' event with the specific handle that was assigned to it in the experiment definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
handle |
str
|
The handle assigned to an 'acquire' event in the experiment definition. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
result |
AcquiredResult
|
The acquire event result. |
Raises:
| Type | Description |
|---|---|
LabOneQException
|
No result is available for the provided handle. |