pyrex.custom.ara.ARA03¶
-
class
pyrex.custom.ara.
ARA03
(global_coords=False)¶ Station geometry representing the deployed station ARA03.
Sets the positions of strings around the station 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
- global_coordsbool, optional
Whether the station should be positioned in global coordinates. If True, the station will be set in the global “array” coordinate system with appropriate relative positions to other ARA stations. In this case the x-positions of antennas are their Easting coordinates and the y-positions are their Northing coordinates. If False, the station will be set in the local “station” coordinate system with the station centered around zero in x and y.
- Raises
- ValueError
If
test_antenna_positions
isTrue
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.
pyrex.custom.ara.ARAString
String of ARA Hpol and Vpol antennas.
Notes
This class is designed to have string-like objects (which are subclasses of
Detector
) as its subsets. Then whenever an object of this class is iterated, all the antennas of its strings will be yielded as in a 1D 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
.- eastingfloat
Station nominal Easting coordinate (m).
- northingfloat
Station nominal Northing coordinate (m).
- elevationfloat
Station nominal elevation (m).
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
([global_coords])Generates antenna positions around the station.
triggered
([polarized_antenna_requirement, …])Check if the station is triggered based on its current state.