Custom Cluster Delay Line#

class ClusterDelayLine(alpha_device=None, beta_device=None, gain=1.0, line_of_sight=True, delay_spread_mean=7.14, delay_spread_std=0.38, aod_spread_mean=1.21, aod_spread_std=0.41, aoa_spread_mean=1.73, aoa_spread_std=0.28, zoa_spread_mean=0.73, zoa_spread_std=0.34, zod_spread_mean=0.1, zod_spread_std=0.0, zod_offset=0.0, rice_factor_mean=9.0, rice_factor_std=5.0, delay_scaling=1.0, cross_polarization_power_mean=9.0, cross_polarization_power_std=3.0, num_clusters=12, num_rays=20, cluster_delay_spread=5e-09, cluster_aod_spread=5.0, cluster_aoa_spread=17.0, cluster_zoa_spread=7.0, cluster_shadowing_std=3.0, **kwargs)[source]#

Bases: ClusterDelayLineBase, Serializable

3GPP Cluster Delay Line Channel Model.

Parameters:

alpha_device (SimulatedDevice, optional) – First device linked by the ClusterDelayLine instance that generated this realization.
beta_device (SiumulatedDevice, optional) – Second device linked by the ClusterDelayLine instance that generated this realization.
gain (float, optional) – Linear power gain factor a signal experiences when being propagated over this realization. \(1.0\) by default.
num_clusters (int, optional) – Number of generated clusters per channel sample.
delay_spread (float, optional) – Root-Mean-Square spread of the cluster delay in seconds.
delay_scaling (float, optional) – Delay distribution proportionality factor.
rice_factor_mean (float, optional) – Mean of the rice factor K.
rice_factor_std (float, optional) – Standard deviation of the rice factor K.
cluster_shadowing_std (float, optional) – Cluster shadowing standard deviation in dB.
line_of_sight (bool, optional) – Is this model a line-of-sight model?

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 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 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_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_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_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.

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 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 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 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 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 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

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 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_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 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.