openlifu.xdc.element.Element¶
- class openlifu.xdc.element.Element(index: "Annotated[int, OpenLIFUFieldData('Element index', 'Element index')]" = 0, position: "Annotated[np.ndarray, OpenLIFUFieldData('Position', 'Position of the element in 3D space')]" = <factory>, orientation: "Annotated[np.ndarray, OpenLIFUFieldData('Orientation', 'Orientation of the element in 3D space')]" = <factory>, size: "Annotated[np.ndarray, OpenLIFUFieldData('Size', 'Size of the element in 2D')]" = <factory>, sensitivity: "Annotated[float | List[tuple[float, float]], OpenLIFUFieldData('Sensitivity', 'Sensitivity of the element (Pa/V), scalar or list of (frequency, value) tuples')]" = 1.0, pin: "Annotated[int, OpenLIFUFieldData('Pin', 'Channel pin to which the element is connected')]" = -1, units: "Annotated[str, OpenLIFUFieldData('Units', 'Spatial units')]" = 'mm')[source]¶
Bases:
object- index: Annotated[int, OpenLIFUFieldData(name='Element index', description='Element index')] = 0¶
Element index to identify the element in the array.
- orientation: Annotated[ndarray, OpenLIFUFieldData(name='Orientation', description='Orientation of the element in 3D space')]¶
Orientation of the element in 3D space as a numpy array around the [y, x’, z’’] axes [az, el, roll] in radians.
- pin: Annotated[int, OpenLIFUFieldData(name='Pin', description='Channel pin to which the element is connected')] = -1¶
Channel pin to which the element is connected. 1-(64*number of modules).
- position: Annotated[ndarray, OpenLIFUFieldData(name='Position', description='Position of the element in 3D space')]¶
Position of the element in 3D space as a numpy array [x, y, z].
- sensitivity: Annotated[float | List[tuple[float, float]], OpenLIFUFieldData(name='Sensitivity', description='Sensitivity of the element (Pa/V), scalar or list of (frequency, value) tuples')] = 1.0¶
Sensitivity of the element (Pa/V)
- size: Annotated[ndarray, OpenLIFUFieldData(name='Size', description='Size of the element in 2D')]¶
Size of the element in 2D as a numpy array [width, length].
- units: Annotated[str, OpenLIFUFieldData(name='Units', description='Spatial units')] = 'mm'¶
Spatial units of the element specification.