UMiScenario#

class sionna.phy.channel.tr38901.UMiScenario(carrier_frequency: float, o2i_model: str, ut_array: sionna.phy.channel.tr38901.antenna.PanelArray | sionna.phy.channel.tr38901.antenna.HandheldUTArray, bs_array: sionna.phy.channel.tr38901.antenna.PanelArray | sionna.phy.channel.tr38901.antenna.HandheldUTArray, direction: str, enable_pathloss: bool = True, enable_shadow_fading: bool = True, precision: str | None = None, device: str | None = None, spec_version: str = '19.2')[source]#

3GPP TR 38.901 urban microcell (UMi) channel model scenario.

Parameters:

carrier_frequency (float) – Carrier frequency [Hz]
o2i_model (str) – Outdoor to indoor (O2I) pathloss model, used for indoor UTs. Must be "low" or "high". See section 7.4.3 from 38.901 specification.
ut_array (sionna.phy.channel.tr38901.antenna.PanelArray | sionna.phy.channel.tr38901.antenna.HandheldUTArray) – Antenna array used by UTs. This can be a PanelArray or HandheldUTArray.
bs_array (sionna.phy.channel.tr38901.antenna.PanelArray | sionna.phy.channel.tr38901.antenna.HandheldUTArray) – Antenna array used by base stations. This can be a PanelArray or HandheldUTArray.
direction (str) – Link direction. Must be "uplink" or "downlink".
enable_pathloss (bool) – If True, apply pathloss. Otherwise doesn’t. Defaults to True.
enable_shadow_fading (bool) – If True, apply shadow fading. Otherwise doesn’t. Defaults to True.
precision (str | None) – Precision used for internal calculations and outputs. If set to None, precision is used.
device (str | None) – Device for computation (e.g., "cpu", "cuda:0"). If None, device is used.
spec_version (str) – Version of the TR 38.901 parameter tables to use. Supported values are "16.1" and "19.2". Defaults to "19.2".

Methods

clip_carrier_frequency_lsp(fc: torch.Tensor) → torch.Tensor[source]#

Clip the carrier frequency fc in GHz for LSP calculation

Parameters:: fc (torch.Tensor) – Carrier frequency [GHz]
Outputs:: fc_clipped – Clipped carrier frequency, that should be used for LSP computation

Attributes

property los_parameter_filepath: str#: Path of the configuration file for LoS scenario

property los_probability: torch.Tensor#

Probability of each UT to be LoS. Used to randomly generate LoS status of outdoor UTs.

Computed following section 7.4.2 of TR 38.901.

Shape [batch size, num_bs, num_ut]

property max_2d_in: torch.Tensor#: Maximum indoor 2D distance for indoor UTs [m]

property min_2d_in: torch.Tensor#: Minimum indoor 2D distance for indoor UTs [m]

property nlos_parameter_filepath: str#: Path of the configuration file for NLoS scenario

property o2i_parameter_filepath: str#: Path of the configuration file for indoor scenario