treble_tsdk.free_field.model

Functions

add_free_field_model(project, name, geometry)

Create a FreeFieldGeometry model from a device geometry by adding a sphere geometry around it.

Classes

FreeFieldModelSettings

FreeFieldModelSettings(frequency: 'float', receiver_sphere_radius_in_m: 'float | None' = 1.0)

SourceReceiverDistanceExtremes

SourceReceiverDistanceExtremes(max_dist: 'float', min_dist: 'float')
class treble_tsdk.free_field.model.FreeFieldModelSettings

FreeFieldModelSettings(frequency: ‘float’, receiver_sphere_radius_in_m: ‘float | None’ = 1.0)

__init__(frequency: float, receiver_sphere_radius_in_m: float | None = 1.0) → None
frequency: float
receiver_sphere_radius_in_m: float | None = 1.0
class treble_tsdk.free_field.model.SourceReceiverDistanceExtremes

SourceReceiverDistanceExtremes(max_dist: ‘float’, min_dist: ‘float’)

__init__(max_dist: float, min_dist: float) → None
max_dist: float
min_dist: float
treble_tsdk.free_field.model.add_free_field_model(project: Project, name: str, geometry: ModelObj | GeometryComponent | Path | str, sphere_geometry_radius: float | None = None, description: str | None = None, device_microphone_placements: DeviceMicrophonePlacements | None = None, boundary_velocity_source_layer: str | None = None, geometry_checker_settings: GeometryCheckerSettingsDto | None = None, freefield_model_additional_settings: FreeFieldModelSettings | None = None, output_mode: ProgressOutputMode = ProgressOutputMode.TQDM_OUTPUT, tags: list[str] = []) → ModelObj

Create a FreeFieldGeometry model from a device geometry by adding a sphere geometry around it. FreeFieldGeometry models can be used to create FreeFieldSimulations.

Parameters:

  • project (Project) – Project to create the model in.

  • name (str) – Name of the model.

  • geometry (ModelObj | MeshCollection | str) – Device geometry, the device must be centered around the origin.

  • sphere_geometry_radius (float | None) – Radius of the sphere geometry in meters. If None, will compute a size from freefield_model_additional_settings or defaults to 2.5m if the latter is None.

  • description (str | None) – Optional description of the model, defaults to None

  • device_microphone_placements (DeviceMicrophonePlacement | None) – Where to place the microphones on the device, defaults to None

  • boundary_velocity_source_layer (str | None) – The layer name of the boundary velocity source, only applicable for submodel source creation, defaults to None

  • geometry_checker_settings (GeometryCheckerSettingsDto | None) – Advanced settings for GeometryProcessing, defaults to None

  • freefield_model_additional_settings (FreeFieldModelSettings | None) – Optional settings for the free field simulation

  • output_mode (utils.ProgressOutputMode) – Optional, can be used to set how model creation progress reporting is handled, defaults to TQDM progress bars.

Return ModelObj:

Returns a ModelObj object representing the free field geometry.