Antenna Correlation¶

class AntennaCorrelation(channel=None)[source]¶

Base class for statistical modeling of antenna array correlations.

Parameters:: channel (Channel | None) – Channel this correlation model configures. None if the model is currently considered floating.

sample_covariance(antennas, mode)[source]¶

Sample the covariance matrix of a given antenna array.

Parameters:

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)[source]¶

Customizable antenna correlations.

Parameters:: covariance (ndarray) – Postive definte square antenna covariance matrix.

classmethod Deserialize(process)[source]¶

Deserialize an object’s state.

Objects cannot be deserialized directly, instead a Factory must be instructed to carry out the deserialization process.

Parameters:: process (DeserializationProcess) – The current stage of the deserialization process. This object is generated by the Factory and provides an interface to deserialization methods supporting multiple backends.
Return type:: CustomAntennaCorrelation
Returns:: The deserialized object.

sample_covariance(antennas, mode)[source]¶

Sample the covariance matrix of a given antenna array.

Parameters:

Return type:

ndarray

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

serialize(process)[source]¶

Serialize this object’s state.

Objects cannot be serialized directly, instead a Factory must be instructed to carry out the serialization process.

Parameters:: process (SerializationProcess) – The current stage of the serialization process. This object is generated by the Factory and provides an interface to serialization methods supporting multiple backends.
Return type:: None

property covariance: ndarray¶: Postive definte square antenna covariance matrix.