Multipath Fading Standard Templates

class MultipathFadingCost256(model_type=TYPE.URBAN, los_angle=None, doppler_frequency=None, los_doppler_frequency=None, **kwargs)

Bases: hermespy.channel.multipath_fading_channel.MultipathFadingChannel

COST256 Multipath Fading Channel models.

Model initialization.

Parameters
  • model_type (TYPE) – 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.

class TYPE(value)

Bases: enum.Enum

Supported model types.

URBAN = 0
RURAL = 1
HILLY = 2
yaml_tag: str = 'COST256'

YAML serialization tag.

yaml_matrix = True
property model_type: TYPE

Access the configured model type.

Returns

The configured model type.

Return type

MultipathFadingCost256.TYPE

classmethod to_yaml(representer, node)

Serialize a channel 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 (MultipathFadingCost256) – The channel instance to be serialized.

Returns

The serialized YAML node.

Return type

Node

classmethod from_yaml(constructor, node)

Recall a new MultipathFadingCost256 instance from YAML.

Parameters
  • constructor (SafeConstructor) – A handle to the constructor extracting the YAML information.

  • node (Node) – YAML node representing the MultipathFadingCost256 serialization.

Returns

Newly created MultipathFadingCost256 instance. The internal references to modems will be None and need to be initialized by the scenario YAML constructor.

Return type

Channel

class MultipathFading5GTDL(model_type=0, rms_delay=0.0, doppler_frequency=None, los_doppler_frequency=None, **kwargs)

Bases: hermespy.channel.multipath_fading_channel.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.

class TYPE(value)

Bases: enum.Enum

Supported model types.

A = 0
B = 1
C = 2
D = 4
E = 5
yaml_tag: str = '5GTDL'

YAML serialization tag.

yaml_matrix = True
property model_type: TYPE

Access the configured model type.

Returns

The configured model type.

Return type

MultipathFading5gTDL.TYPE

classmethod to_yaml(representer, node)

Serialize a channel 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 (MultipathFading5GTDL) – The channel instance to be serialized.

Returns

The serialized YAML node.

Return type

Node

classmethod from_yaml(constructor, node)

Recall a new MultipathFading5GTDL instance from YAML.

Parameters
  • constructor (SafeConstructor) – A handle to the constructor extracting the YAML information.

  • node (Node) – YAML node representing the MultipathFading5GTDL serialization.

Returns

Newly created MultipathFading5GTDL instance. The internal references to modems will be None and need to be initialized by the scenario YAML constructor.

Return type

Channel

class MultipathFadingExponential(tap_interval=0.0, rms_delay=0.0, **kwargs)

Bases: hermespy.channel.multipath_fading_channel.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.

yaml_matrix = True
classmethod to_yaml(representer, node)

Serialize a channel 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 (MultipathFadingExponential) – The channel instance to be serialized.

Returns

The serialized YAML node.

Return type

Node

classmethod from_yaml(constructor, node)

Recall a new MultipathFadingExponential instance from YAML.

Parameters
  • constructor (SafeConstructor) – A handle to the constructor extracting the YAML information.

  • node (Node) – YAML node representing the MultipathFadingExponential serialization.

Returns

Newly created MultipathFadingExponential instance. The internal references to modems will be None and need to be initialized by the scenario YAML constructor.

Return type

Channel