Multipath Fading Standard Templates
- class DeviceType(value)
Bases:
SerializableEnum
3GPP device type
- BASE_STATION = 0
Base station
- TERMINAL = 1
Mobile terminal
- yaml_tag: Optional[str] = 'DeviceType'
YAML serialization tag.
- property_blacklist: Set[str] = {}
Set of properties to be ignored during serialization.
- serialized_attributes: Set[str] = {}
Set of object attributes to be serialized.
- class CorrelationType(value)
Bases:
SerializableEnum
3GPP correlation type
- LOW = (0.0, 0.0)
Low antenna correlation
- MEDIUM = (0.3, 0.3)
Medium antenna correlation
- MEDIUM_A = (0.3, 0.3874)
Medium antenna correlation
- HIGH = (0.9, 0.9)
High antenna correlation
- yaml_tag: Optional[str] = 'CorrelationType'
YAML serialization tag.
- property_blacklist: Set[str] = {}
Set of properties to be ignored during serialization.
- serialized_attributes: Set[str] = {}
Set of object attributes to be serialized.
- class StandardAntennaCorrelation(device_type, correlation, **kwargs)
Bases:
Serializable
,AntennaCorrelation
3GPP 5G Multipath fading standardized antenna correlations
- Parameters
device_type (Union[DeviceType, int, str]) – The assumed device.
correlation (Union[CorrelationType, str]) – The assumed correlation.
- yaml_tag: Optional[str] = 'StandardCorrelation'
YAML serialization tag
- property device_type: DeviceType
Assumed 3GPP device type.
Returns: The device type.
- Raises
ValuError – On unsupported type conversions.
- Return type
- property correlation: CorrelationType
Assumed 3GPP standard correlation type.
Returns: The correlation type.
- Raises
ValuError – On unsupported type conversions.
- Return type
- property covariance: ndarray
Antenna covariance matrix.
Returns: Two-dimensional numpy array representing the covariance matrix.
- Return type
ndarray
- class Cost256Type(value)
Bases:
SerializableEnum
Supported model types of the Cost256 channel model
- URBAN = 0
Urban area
- RURAL = 1
Rural area
- HILLY = 2
Hilly terrain
- yaml_tag: Optional[str] = 'Cost256Type'
YAML serialization tag.
- property_blacklist: Set[str] = {}
Set of properties to be ignored during serialization.
- serialized_attributes: Set[str] = {}
Set of object attributes to be serialized.
- class MultipathFadingCost256(model_type=Cost256Type.URBAN, los_angle=None, doppler_frequency=None, los_doppler_frequency=None, **kwargs)
Bases:
MultipathFadingChannel
COST256 Multipath Fading Channel models.
Model initialization.
- Parameters
model_type (Cost256Type) – The model type.
los_angle (float, optional) – Angle phase of the line of sight component within the statistical distribution.
doppler_frequency (float, optional) – Doppler frequency shift of the statistical distribution.
kwargs (Any) – MultipathFadingChannel initialization parameters.
- Raises
ValueError – If model_type is not supported. If los_angle is defined in HILLY model type.
- yaml_tag: str = 'COST256'
YAML serialization tag.
- property model_type: Cost256Type
Access the configured model type.
Returns: The configured model type.
- Return type
- classmethod to_yaml(representer, node)
Serialize a serializable object to YAML.
- Parameters
representer (SafeRepresenter) – A handle to a representer used to generate valid YAML code. The representer gets passed down the serialization tree to each node.
node (Serializable) – The MultipathFadingCost256 instance to be serialized.
Returns: The serialized YAML node.
- Return type
MappingNode
- class TDLType(value)
Bases:
SerializableEnum
Supported model types of the 5G TDL channel model
- A = 0
- B = 1
- C = 2
- D = 4
- E = 5
- yaml_tag: Optional[str] = 'TDLType'
YAML serialization tag.
- property_blacklist: Set[str] = {}
Set of properties to be ignored during serialization.
- serialized_attributes: Set[str] = {}
Set of object attributes to be serialized.
- class MultipathFading5GTDL(model_type=TDLType.A, rms_delay=0.0, doppler_frequency=None, los_doppler_frequency=None, **kwargs)
Bases:
MultipathFadingChannel
5G TDL Multipath Fading Channel models.
Model initialization.
- Parameters
model_type (TYPE) – The model type.
rms_delay (float) – Root-Mean-Squared delay in seconds.
num_sinusoids (int, optional) – Number of sinusoids used to sample the statistical distribution.
doppler_frequency (float, optional) – Doppler frequency shift of the statistical distribution.
kwargs (Any) – MultipathFadingChannel initialization parameters.
- Raises
ValueError – If model_type is not supported. If rms_delay is smaller than zero. If los_angle is specified in combination with model_type D or E.
- yaml_tag: str = '5GTDL'
YAML serialization tag.
- property model_type: TDLType
Access the configured model type.
- Returns
The configured model type.
- Return type
MultipathFading5gTDL.TYPE
- property rms_delay: float
Root mean squared channel delay.
Returns: Delay in seconds.
- Return type
float
- class MultipathFadingExponential(tap_interval=0.0, rms_delay=0.0, **kwargs)
Bases:
MultipathFadingChannel
Exponential Multipath Fading Channel models.
Exponential Multipath Channel Model initialization.
- Parameters
tap_interval (float, optional) – Tap interval in seconds.
rms_delay (float, optional) – Root-Mean-Squared delay in seconds.
kwargs (Any) – MultipathFadingChannel initialization parameters.
- Raises
ValueError – On invalid arguments.
- yaml_tag: str = 'Exponential'
YAML serialization tag.
- property tap_interval: float
Tap interval.
Returns: Tap interval in seconds.
- Return type
float
- property rms_delay: float
Root mean squared channel delay.
Returns: Delay in seconds.
- Return type
float