Cluster Delay Line Base#

class ClusterDelayLineBase(alpha_device=None, beta_device=None, gain=1.0, delay_normalization=DelayNormalization.ZERO, **kwargs)[source]#

Bases: Channel[ClusterDelayLineRealization]

Parameters:
  • alpha_device (SimulatedDevice, optional) – First device linked by the ClusterDelayLineBase instance that generated this realization.

  • beta_device (SimulatedDevice, optional) – Second device linked by the ClusterDelayLineBase 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.

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

recall_realization(group)[source]#

Recall a realization of this channel type from its HDF serialization.

Parameters:

group (h5py.Group) – HDF group to which the channel realization was serialized.

Return type:

ClusterDelayLineRealization

Returns: The recalled realization instance.

abstract 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

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

abstract 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

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

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

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

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

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

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

abstract 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

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

delay_normalization: DelayNormalization#

The delay normalization routine applied during channel sampling.

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

abstract 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

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

abstract 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

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

abstract property num_rays: int#

Number of rays per cluster.

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

Returns:

Number of rays.

Return type:

int

abstract 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

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

subcluster_indices: List[List[int]] = [[0, 1, 2, 3, 4, 5, 6, 7, 18, 19], [8, 9, 10, 11, 16, 17], [12, 13, 14, 15]]#
abstract 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

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

abstract 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

abstract 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

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