pyrex.custom.ara.stations.DeployedString

class pyrex.custom.ara.stations.DeployedString(positions, types, names)

String of ARA Hpol and Vpol antennas as deployed at South Pole.

Sets the positions of antennas on string based on the parameters. Once the antennas have been built with build_antennas, the object can be directly iterated over to iterate over the antennas (as if the object were just a list of the antennas).

Parameters

positionsarray_like

Array of Cartesian positions (m) for each antenna on the string.

typesarray_like

List of classes to be used for construction of each antenna.

namesarray_like

List of names to be given to the antennas.

Raises

ValueError

If test_antenna_positions is True and an antenna is found to be above the ice surface.

See also

pyrex.custom.ara.HpolAntenna

ARA Hpol (“quad-slot”) antenna system with front-end processing.

pyrex.custom.ara.VpolAntenna

ARA Vpol (“bicone” or “birdcage”) antenna system with front-end processing.

Notes

This class is designed to be the lowest subset level of a detector. It can (and should) be used for the subsets of some other Detector subclass to build up a full detector. Then when its “parent” is iterated, the instances of this class will be iterated as though they were all part of one flat list.

Attributes

antenna_positionslist

List (potentially with sub-lists) of the positions of the antennas generated by the set_positions method.

subsetslist

List of the antenna or detector objects which make up the detector.

test_antenna_positionsboolean

Class attribute for whether or not an error should be raised if antenna positions are found above the surface of the ice (where simulation behavior is ill-defined). Defaults to True.

Methods

build_antennas(*args, **kwargs)	Creates antenna objects at the set antenna positions.
clear([reset_noise])	Reset the detector to an empty state.
set_positions(positions, types, names)	Generates antenna positions along the string.
triggered([antenna_requirement, …])	Check if the string is triggered based on its current state.