differt.plugins.deepmimo.export

export(*, paths, scene, radio_materials=None, frequency, include_primitives=False, polarization='V')

Export a Ray Tracing simulation to the DeepMIMO format.

Note

The current implementation assumes far-field propagation in free space and isotropic antennas.

Parameters:

• paths (Paths | Iterable[Paths]) –

  The geometrical paths.

  You can provide paths with different numbers of interactions by passing an iterable.

  E.g., the return value of TriangleScene.compute_paths.

• scene (TriangleScene) – The scene that was used to compute the paths.

• radio_materials (Mapping[str, Material] | None) –

  The list of materials in the scene.

  If not provided, materials will be used.

• frequency (Float[ArrayLike, '']) – The operating frequency (in Hz).

• include_primitives (bool) – If True, include the primitive indices in the output.

• polarization (Literal['V', 'H'] | Float[ArrayLike, '3'] | tuple[Literal['V', 'H'] | Float[ArrayLike, '3'], Literal['V', 'H'] | Float[ArrayLike, '3']]) – The antennas polarization. Can be either "V" (vertical, z-axis up), "H" (horizontal, x-axis up), a 3D unit vector, or a tuple of (tx_polarization, rx_polarization).

Return type:

DeepMIMO[Array]

Returns:

The exported DeepMIMO data as JAX arrays.

Raises:

ValueError – If the scene does not contain information about face materials.