3GPP Rural Macrocells Model

Implements several parameter sets defined within the 3GPP standard modeling specific scenarios.

class RuralMacrocellsLineOfSight(delay_normalization=DelayNormalization.ZERO, **kwargs)

Bases: hermespy.channel.cluster_delay_lines.ClusterDelayLineBase, hermespy.core.factory.Serializable

Parameter Preset for the 3GPP Cluster Delay Line Rural Macrocells Model.

Parameters

delay_normalization (DelayNormalization, optional) – The delay normalization routine applied during channel sampling.

yaml_tag: str = 'RMaLOS'

YAML serialization tag.

property line_of_sight: bool

Does this model assume direct line of sight between the two devices?

Referred to as \(LOS\) within the standard.

Returns

Line of sight indicator.

Return type

bool

property delay_spread_mean: float

Mean of the cluster delay spread.

The spread realization and its mean are referred to as \(\mathrm{DS}\) and \(\mu_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Mean delay spread in seconds.

Return type

float

property delay_spread_std: float

Standard deviation of the cluster delay spread.

The spread realization and its standard deviation are referred to as \(\mathrm{DS}\) and \(\sigma_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Delay spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aod_spread_mean: float

Mean of the Azimuth Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ASD}\) and \(\mu_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aod_spread_std: float

Standard deviation of the Azimuth Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASD}\) and \(\sigma_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aoa_spread_mean: float

Mean of the Azimuth Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ASA}\) and \(\mu_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aoa_spread_std: float

Standard deviation of the Azimuth Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASA}\) and \(\sigma_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zoa_spread_mean: float

Mean of the Zenith Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ZSA}\) and \(\mu_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property zoa_spread_std: float

Standard deviation of the Zenith Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZSA}\) and \(\sigma_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_spread_mean: float

Mean of the Zenith Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ZOD}\) and \(\mu_{\mathrm{lgZSD}}\) within the the standard, respectively.

Returns

Mean angle spread in degrees

Return type

float

property zod_spread_std: float

Standard deviation of the Zenith Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZOD}\) and \(\sigma_{\mathrm{lgZOD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in degrees.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_offset: float

Offset between Zenith Angle-of-Arrival and Angle-of-Departure.

The offset is referred to as \(\mu_{\mathrm{offset,ZOD}}\) within the standard.

Returns

The offset in degrees.

Return type

float

property rice_factor_mean: float

Mean of the rice factor distribution.

The rice factor realization and its mean are referred to as \(K\) and \(\mu_K\) within the the standard, respectively.

Returns

Rice factor mean in dB.

Return type

float

property rice_factor_std: float

Standard deviation of the rice factor distribution.

The rice factor realization and its standard deviation are referred to as \(K\) and \(\sigma_K\) within the the standard, respectively.

Returns

Rice factor standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property delay_scaling: float

Delay scaling proportionality factor

Referred to as \(r_{\tau}\) within the standard.

Returns

Scaling factor.

Return type

float

Raises

ValueError – If scaling factor is smaller than one.

property cross_polarization_power_mean: float

Mean of the cross-polarization power.

The cross-polarization power and its mean are referred to as \(\mathrm{XPR}\) and \(\mu_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Mean power in dB.

Return type

float

property cross_polarization_power_std: float

Standard deviation of the cross-polarization power.

The cross-polarization power and its standard deviation are referred to as \(\mathrm{XPR}\) and \(\sigma_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Power standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property num_clusters: int

Number of clusters.

Referred to as \(M\) within the standard.

Returns

Number of clusters.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property num_rays: int

Number of rays per cluster.

Referred to as \(N\) within the standard.

Returns

Number of rays.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property cluster_delay_spread: float

Delay spread within an individual cluster.

Referred to as \(c_{DS}\) within the standard.

Returns

Delay spread in seconds.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aod_spread: float

Azimuth Angle-of-Departure spread within an individual cluster.

Referred to as \(c_{ASD}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aoa_spread: float

Azimuth Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ASA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_zoa_spread: float

Zenith Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ZSA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_shadowing_std: float

Standard deviation of the cluster shadowing.

Referred to as \(\zeta\) within the the standard.

Returns

Cluster shadowing standard deviation.

Return type

float

Raises

ValueError – If the deviation is smaller than zero.

delay_normalization: DelayNormalization

The delay normalization routine applied during channel sampling.

class RuralMacrocellsNoLineOfSight(delay_normalization=DelayNormalization.ZERO, **kwargs)

Bases: hermespy.channel.cluster_delay_lines.ClusterDelayLineBase, hermespy.core.factory.Serializable

Parameter Preset for the 3GPP Cluster Delay Line Urban Macrocells Model.

Parameters

delay_normalization (DelayNormalization, optional) – The delay normalization routine applied during channel sampling.

yaml_tag: str = 'RMaLOS'

YAML serialization tag.

property line_of_sight: bool

Does this model assume direct line of sight between the two devices?

Referred to as \(LOS\) within the standard.

Returns

Line of sight indicator.

Return type

bool

property delay_spread_mean: float

Mean of the cluster delay spread.

The spread realization and its mean are referred to as \(\mathrm{DS}\) and \(\mu_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Mean delay spread in seconds.

Return type

float

property delay_spread_std: float

Standard deviation of the cluster delay spread.

The spread realization and its standard deviation are referred to as \(\mathrm{DS}\) and \(\sigma_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Delay spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aod_spread_mean: float

Mean of the Azimuth Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ASD}\) and \(\mu_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aod_spread_std: float

Standard deviation of the Azimuth Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASD}\) and \(\sigma_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aoa_spread_mean: float

Mean of the Azimuth Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ASA}\) and \(\mu_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aoa_spread_std: float

Standard deviation of the Azimuth Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASA}\) and \(\sigma_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zoa_spread_mean: float

Mean of the Zenith Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ZSA}\) and \(\mu_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property zoa_spread_std: float

Standard deviation of the Zenith Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZSA}\) and \(\sigma_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_spread_mean: float

Mean of the Zenith Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ZOD}\) and \(\mu_{\mathrm{lgZSD}}\) within the the standard, respectively.

Returns

Mean angle spread in degrees

Return type

float

property zod_spread_std: float

Standard deviation of the Zenith Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZOD}\) and \(\sigma_{\mathrm{lgZOD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in degrees.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_offset: float

Offset between Zenith Angle-of-Arrival and Angle-of-Departure.

The offset is referred to as \(\mu_{\mathrm{offset,ZOD}}\) within the standard.

Returns

The offset in degrees.

Return type

float

property rice_factor_mean: float

Mean of the rice factor distribution.

The rice factor realization and its mean are referred to as \(K\) and \(\mu_K\) within the the standard, respectively.

Returns

Rice factor mean in dB.

Return type

float

property rice_factor_std: float

Standard deviation of the rice factor distribution.

The rice factor realization and its standard deviation are referred to as \(K\) and \(\sigma_K\) within the the standard, respectively.

Returns

Rice factor standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property delay_scaling: float

Delay scaling proportionality factor

Referred to as \(r_{\tau}\) within the standard.

Returns

Scaling factor.

Return type

float

Raises

ValueError – If scaling factor is smaller than one.

property cross_polarization_power_mean: float

Mean of the cross-polarization power.

The cross-polarization power and its mean are referred to as \(\mathrm{XPR}\) and \(\mu_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Mean power in dB.

Return type

float

property cross_polarization_power_std: float

Standard deviation of the cross-polarization power.

The cross-polarization power and its standard deviation are referred to as \(\mathrm{XPR}\) and \(\sigma_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Power standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property num_clusters: int

Number of clusters.

Referred to as \(M\) within the standard.

Returns

Number of clusters.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property num_rays: int

Number of rays per cluster.

Referred to as \(N\) within the standard.

Returns

Number of rays.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property cluster_delay_spread: float

Delay spread within an individual cluster.

Referred to as \(c_{DS}\) within the standard.

Returns

Delay spread in seconds.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aod_spread: float

Azimuth Angle-of-Departure spread within an individual cluster.

Referred to as \(c_{ASD}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aoa_spread: float

Azimuth Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ASA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_zoa_spread: float

Zenith Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ZSA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_shadowing_std: float

Standard deviation of the cluster shadowing.

Referred to as \(\zeta\) within the the standard.

Returns

Cluster shadowing standard deviation.

Return type

float

Raises

ValueError – If the deviation is smaller than zero.

delay_normalization: DelayNormalization

The delay normalization routine applied during channel sampling.

class RuralMacrocellsOutsideToInside(delay_normalization=DelayNormalization.ZERO, **kwargs)

Bases: hermespy.channel.cluster_delay_lines.ClusterDelayLineBase, hermespy.core.factory.Serializable

Parameter Preset for the 3GPP Cluster Delay Line Urban Macrocells Model.

Parameters

delay_normalization (DelayNormalization, optional) – The delay normalization routine applied during channel sampling.

yaml_tag: str = 'RMaO2I'

YAML serialization tag.

property line_of_sight: bool

Does this model assume direct line of sight between the two devices?

Referred to as \(LOS\) within the standard.

Returns

Line of sight indicator.

Return type

bool

property delay_spread_mean: float

Mean of the cluster delay spread.

The spread realization and its mean are referred to as \(\mathrm{DS}\) and \(\mu_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Mean delay spread in seconds.

Return type

float

property delay_spread_std: float

Standard deviation of the cluster delay spread.

The spread realization and its standard deviation are referred to as \(\mathrm{DS}\) and \(\sigma_{\mathrm{lgDS}}\) within the the standard, respectively.

Returns

Delay spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aod_spread_mean: float

Mean of the Azimuth Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ASD}\) and \(\mu_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aod_spread_std: float

Standard deviation of the Azimuth Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASD}\) and \(\sigma_{\mathrm{lgASD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property aoa_spread_mean: float

Mean of the Azimuth Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ASA}\) and \(\mu_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property aoa_spread_std: float

Standard deviation of the Azimuth Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ASA}\) and \(\sigma_{\mathrm{lgASA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zoa_spread_mean: float

Mean of the Zenith Angle-of-Arriaval spread.

The spread realization and its mean are referred to as \(\mathrm{ZSA}\) and \(\mu_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Mean angle spread in seconds

Return type

float

property zoa_spread_std: float

Standard deviation of the Zenith Angle-of-Arrival spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZSA}\) and \(\sigma_{\mathrm{lgZSA}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in seconds.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_spread_mean: float

Mean of the Zenith Angle-of-Departure spread.

The spread realization and its mean are referred to as \(\mathrm{ZOD}\) and \(\mu_{\mathrm{lgZSD}}\) within the the standard, respectively.

Returns

Mean angle spread in degrees

Return type

float

property zod_spread_std: float

Standard deviation of the Zenith Angle-of-Departure spread.

The spread realization and its standard deviation are referred to as \(\mathrm{ZOD}\) and \(\sigma_{\mathrm{lgZOD}}\) within the the standard, respectively.

Returns

Angle spread standard deviation in degrees.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property zod_offset: float

Offset between Zenith Angle-of-Arrival and Angle-of-Departure.

The offset is referred to as \(\mu_{\mathrm{offset,ZOD}}\) within the standard.

Returns

The offset in degrees.

Return type

float

property rice_factor_mean: float

Mean of the rice factor distribution.

The rice factor realization and its mean are referred to as \(K\) and \(\mu_K\) within the the standard, respectively.

Returns

Rice factor mean in dB.

Return type

float

property rice_factor_std: float

Standard deviation of the rice factor distribution.

The rice factor realization and its standard deviation are referred to as \(K\) and \(\sigma_K\) within the the standard, respectively.

Returns

Rice factor standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property delay_scaling: float

Delay scaling proportionality factor

Referred to as \(r_{\tau}\) within the standard.

Returns

Scaling factor.

Return type

float

Raises

ValueError – If scaling factor is smaller than one.

property cross_polarization_power_mean: float

Mean of the cross-polarization power.

The cross-polarization power and its mean are referred to as \(\mathrm{XPR}\) and \(\mu_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Mean power in dB.

Return type

float

property cross_polarization_power_std: float

Standard deviation of the cross-polarization power.

The cross-polarization power and its standard deviation are referred to as \(\mathrm{XPR}\) and \(\sigma_{\mathrm{XPR}}\) within the the standard, respectively.

Returns

Power standard deviation in dB.

Return type

float

Raises

ValueError – If the standard deviation is smaller than zero.

property num_clusters: int

Number of clusters.

Referred to as \(M\) within the standard.

Returns

Number of clusters.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property num_rays: int

Number of rays per cluster.

Referred to as \(N\) within the standard.

Returns

Number of rays.

Return type

int

Raises

ValueError – If the number of clusters is smaller than one.

property cluster_delay_spread: float

Delay spread within an individual cluster.

Referred to as \(c_{DS}\) within the standard.

Returns

Delay spread in seconds.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aod_spread: float

Azimuth Angle-of-Departure spread within an individual cluster.

Referred to as \(c_{ASD}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_aoa_spread: float

Azimuth Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ASA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

property cluster_zoa_spread: float

Zenith Angle-of-Arrival spread within an individual cluster.

Referred to as \(c_{ZSA}\) within the standard.

Returns

Angle spread in degrees.

Return type

float

Raises

ValueError – If spread is smaller than zero.

delay_normalization: DelayNormalization

The delay normalization routine applied during channel sampling.

property cluster_shadowing_std: float

Standard deviation of the cluster shadowing.

Referred to as \(\zeta\) within the the standard.

Returns

Cluster shadowing standard deviation.

Return type

float

Raises

ValueError – If the deviation is smaller than zero.