Antenna Correlation

class AntennaCorrelation(channel=None)

Bases: ABC

Base class for statistical modeling of antenna array correlations.

Parameters:

channel (Channel, optional) – Channel this correlation model configures. None if the model is currently considered floating.

sample_covariance(antennas, mode)

Sample the covariance matrix of a given antenna array.

Parameters:

• antennas (AntennaArrayState) – State of the antenna array.

• mode (AntennaMode) – Mode of the antenna array, i.e. transmit or receive.

Return type:

ndarray

Returns: Two-dimensional numpy array representing the covariance matrix.

property channel: Channel | None

The channel this correlation model configures.

Returns:

Handle to the channel. None if the model is currently considered floating

class CustomAntennaCorrelation(covariance)

Bases: Serializable, AntennaCorrelation

Customizable antenna correlations.

Parameters:

covariance (numpy.ndarray) – Postive definte square antenna covariance matrix.

sample_covariance(antennas, mode)

Sample the covariance matrix of a given antenna array.

Parameters:

• antennas (AntennaArrayState) – State of the antenna array.

• mode (AntennaMode) – Mode of the antenna array, i.e. transmit or receive.

Return type:

ndarray

Returns: Two-dimensional numpy array representing the covariance matrix.

property covariance: ndarray

Postive definte square antenna covariance matrix.

yaml_tag: Optional[str] = 'CustomCorrelation'

YAML serialization tag