openstb.simulator.system.transducer

Classes:

Name	Description
GenericTransducer	A generic transducer.

GenericTransducer

GenericTransducer(position, orientation, beampattern=None)

Bases: Transducer

A generic transducer.

Parameters:

Name	Type	Description	Default
position	ArrayLike	The position of the transducer relative to the system origin.	required
orientation	ArrayLike | QArray	The orientation of the transducer boresight relative to the x axis of the system.	required
beampattern	PluginOrSpec[Distortion] | None	The distortion model of the beampattern.	None

Source code in openstb/simulator/system/transducer.py

def __init__(
    self,
    position: ArrayLike,
    orientation: ArrayLike | quaternionic.QArray,
    beampattern: PluginOrSpec[Distortion] | None = None,
):
    """
    Parameters
    ----------
    position
        The position of the transducer relative to the system origin.
    orientation
        The orientation of the transducer boresight relative to the x axis of the
        system.
    beampattern
        The distortion model of the beampattern.

    """
    self._position = np.array(position, dtype=float)
    if self._position.shape != (3,):
        raise ValueError(_("position should be a 3-element vector"))

    try:
        self._orientation = quaternionic.array(orientation)
    except ValueError:
        raise ValueError(_("transducer orientation must be a valid quaternion"))
    if self._orientation.shape != (4,):
        raise ValueError(_("transducer orientation must be a single quaternion"))

    if beampattern is None:
        self._distortion = []
    else:
        self._distortion = [distortion(beampattern)]