Dimension¶
Bases: object
Dimension class manages the parameters of a dimension (within a multi-dimensional acquisition).
This class defines a dimension for a multi-dimensional acquisition sequence, managing the list of sub-devices involved and their parameters.
__init__(*args)
¶
Overload 1:
Default constructor.
Initializes a new instance of the Dimension class.
|
Overload 2:
Constructor with name.
Initializes a new instance of the Dimension class with a specific name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
string
|
The name of the dimension | Overload 3: Constructor with name and device list. Initializes a new instance of the Dimension class with a name and a list of associated sub-devices. |
required |
subDeviceIdList
|
list[SubDeviceId]
|
The list of associated sub-devices |
required |
fromXML(xml)
¶
Load from XML.
Populates the dimension information from an XML node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml
|
XMLNode
|
The XML node containing dimension information |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
If an error occurs |
toXML(xmlParent)
¶
Save to XML.
Exports the dimension information to an XML node attached to the parent XML node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xmlParent
|
XMLNode
|
The parent XML node |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
If an error occurs |
addSubDevice(subDeviceId)
¶
Add a sub-device to the dimension.
Associates a sub-device with this dimension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subDeviceId
|
SubDeviceId
|
The sub-device ID of the sub-device to add to the dimension |
required |
addDimensionParam(param)
¶
Add parameters to the dimension.
Adds parameters to this dimension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
param
|
DimensionParam
|
The parameters to add to the dimension |
required |
getName()
¶
Get the name of the dimension.
Retrieves the name of the dimension.
Returns:
| Type | Description |
|---|---|
str
|
The name of the dimension |
getDimensionParams()
¶
Get parameters of the dimension.
Retrieves the list of parameters defined for this dimension.
Returns:
| Type | Description |
|---|---|
list[DimensionParam]
|
The list of parameters of the dimension |
subDeviceIdList()
¶
Get the sub-device ID list of the dimension.
Retrieves the list of sub-device IDs associated with this dimension.
Returns:
| Type | Description |
|---|---|
list[SubDeviceId]
|
The list of sub-device IDs of the dimension |