Custom Array

Inheritance diagram of hermespy.simulation.antennas.SimulatedCustomArray
class SimulatedCustomArray(ports=None, pose=None)[source]

Bases: SimulatedAntennaArray, CustomAntennaArray[SimulatedAntennaPort, SimulatedAntenna]

A custom array of simulated antennas.

Parameters:
  • ports (Sequence[SimulatedAntennaPort | SimulatedAntenna], optional) – Sequence of antenna ports available within this array. If antennas are passed instead of ports, the ports are automatically created. If not specified, an empty array is assumed.

  • pose (Transformation, optional) – The anntena array’s transformation with respect to its device.

add_antenna(antenna)[source]

Add a new antenna element to this array.

Convenience wrapper around add_port(), meaning a new port is automatically created and the antenna is added to it.

Parameters:

antenna (AT) – The antenna element to be added.

Raises:

ValueError – If the antenna is already attached to another array or port.

Return type:

None

Returns: The newly created port.

add_port(port)[source]

Add a new port to this array.

Parameters:

port (APT) – The antenna port to be added.

Return type:

None

remove_port(port)[source]

Remove a port from this array.

Parameters:

port (APT) – The antenna port to be removed.

Raises:

ValueError – If the port is not connected to this array.

Return type:

None