treble_tsdk.core.receiver

Classes

Receiver

ReceiverProperties

ReceiverType

Available receiver types.

TraceIgnore

class treble_tsdk.core.receiver.Receiver
__init__(x: float, y: float, z: float, receiver_type: ReceiverType, label: str, receiver_properties: ReceiverProperties | None = None, id: str | None = None, order_number: int | None = None, tags: list[str] = [], sub_receivers: list[dict | ReceiverDto] | None = None, metadata: dict[str, str] | ObjectMetadata | None = None, parent_source_id: str | None = None)

Represents a simulation Receiver.

Parameters:

  • x (float) – X position of receiver in meters.

  • y (float) – Y position of receiver in meters.

  • z (float) – Z position of receiver in meters.

  • receiver_type (ReceiverType) – Type of receiver.

  • label (str) – Receiver label.

  • receiver_properties (ReceiverProperties) – Optional, additional receiver properties.

classmethod make_mono(location: Point3d | list[float] | None = None, label: str = '', receiver_properties: ReceiverProperties | None = None, tags: list[str] = [], **kwargs)

Shortcut for creating a mono receiver.

Parameters:

  • location (Point3d|list[float]) – Location of the receiver in meters.

  • label (str) – Label of the receiver.

  • receiver_properties (ReceiverProperties) – Optional, additional receiver properties.

classmethod make_moving_mono(trajectory: Trajectory, label: str = '', receiver_properties: ReceiverProperties | None = None, tags: list[str] = [], **kwargs)
classmethod make_moving_spatial(trajectory: Trajectory, label: str = '', ambisonics_order: int | None = None, ambisonics_sphere_radius_in_m: float = 0.1, receiver_properties: ReceiverProperties | None = None, tags: list[str] = [], **kwargs)
classmethod make_spatial(location: Point3d | list[float] | None = None, label: str = '', ambisonics_order: int | None = None, ambisonics_sphere_radius_in_m: float = 0.1, receiver_properties: ReceiverProperties | None = None, tags: list[str] = [], **kwargs)

Shortcut for creating a spatial receiver.

Parameters:

  • location (Point3d|list[float]) – Location of the receiver in meters.

  • label (str) – Label of the receiver.

  • ambisonics_order (int) – Ambisonics order of the receiver, defaults to 2. This overwrites the value in ReceiverProperties if provided

  • ambisonics_sphere_radius_in_m (float) – The radius in m of the sphere of receivers generated. This overwrites the value in ReceiverProperties if provided

  • receiver_properties (ReceiverProperties) – Optional, additional receiver properties.

pos_as_point() → Point3d
property id: str
property label: str
property location: Point3d
property metadata: ObjectMetadata | dict[str, str] | None
property order_number: int
property receiver_properties: ReceiverProperties
property receiver_type: ReceiverType
property sub_receivers: list[Receiver] | None
property tags: list[str]
property x: float
property y: float
property z: float
class treble_tsdk.core.receiver.ReceiverProperties
__init__(ambisonics_sphere_radius_in_m: float = 0.1, ambisonics_order: int | None = None, trace_ignore: TraceIgnore | None = None, **kwargs)

Additional receiver properties further defining spatial receivers. For spatial receivers the only used parameter is the ambisonics_sphere_radius_in_m

Parameters:

  • ambisonics_sphere_radius_in_m (float) – The radius in m of the sphere where receiver array will be generated on. From 0.05 to 0.15, defaults to 0.1

  • ambisonics_order (int) – Sets the ambisonics order of spatial receiver, allowed values are 1 <= order <= 32. If this is set it will override the value set in the simulation settings for this receiver. If this is not set the default value will be 2.

  • trace_ignore (TraceIgnore | None) – Experimental. Ignore a part of the results and replace with zeros

property ambisonics_order: int | None

Ambisonics order of receiver. If this value is not set the simulation level ambisonics order is used which defaults to 2.

property spatial_radius: float
property trace_ignore: TraceIgnore | None
class treble_tsdk.core.receiver.ReceiverType

Available receiver types.

classmethod list()
classmethod print()
mono = 'Mono'
moving = 'Moving'
spatial = 'Spatial'
class treble_tsdk.core.receiver.TraceIgnore
__init__(ms_to_cut_from_beginning: float, taper_width_in_ms: float | None = None)

To ignore the first milliseconds of a simulation result.

Parameters:

  • ms_to_cut_from_beginning (float) – Number of milliseconds to cut away

  • taper_width_in_ms (float | None) – Width of taper when tapering to zero in milliseconds, defaults to None

property taper_width: float

Taper width in seconds

property time_to_cut: float

Time to cut in seconds.