comyx.network.user_equipment

Module Summary

Classes

UserEquipment

Represents a user equipment in the modelled environment.

Reference

class comyx.network.user_equipment.UserEquipment(id_: str, n_antennas: int, position: List[float] | None = None, t_power: float | None = None, r_sensitivity: float | None = None)

Bases: comyx.network.transceiver.Transceiver

Represents a user equipment in the modelled environment.

Identifiers may be of the form “UEx”, where x is a positive integer. The first two characters indicate the type of transceiver, i.e., “UE” for user equipment. The remaining characters are the unique identifier of the user equipment. For example, “UE42” is a user equipment with identifier 42.

property rate: NDArrayFloat

Calculate the rate of the transceiver (Shannon formula)

Parameters:

mean_axis – Axis along which the mean is calculated. Default is -1 (last axis, i.e., over all realizations).

Returns:

Rate of the transceiver.

classmethod from_base_station(base_station: BaseStation, id_: str, n_antennas: int, t_power: float | None = None, r_sensitivity: float | None = None, height: float = 0, tolerance: float = 0) → UserEquipment

Create a user equipment within the coverage area of a base station.

Parameters:

• id – Unique identifier of the user equipment.

• n_antennas – Number of antennas of the user equipment.

• base_station – Base station to create the user equipment from.

• height – Height of the user equipment. Defaults to 0.

• tolerance – Tolerance from the edge of the coverage area. Defaults to 0.

Returns:

Randomly positioned user equipment.