pyrex.custom.ara.detector.HexagonalGrid

class pyrex.custom.ara.detector.HexagonalGrid(stations=1, station_separation=2000, station_type=<class 'pyrex.custom.ara.detector.RegularStation'>, **station_kwargs)

Hexagonal grid of stations or strings.

Sets the positions of stations by spiralling outward in a hexagonal grid. Supports any station type (including string types) and passes extra keyword arguments on to the station class. 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

stationsfloat, optional

Number of stations to be placed.

station_separationfloat, optional

Distance (m) between adjacent stations.

station_typeoptional

Class to be used for creating station objects for subsets.

**station_kwargs

Keyword arguments to be passed on to the __init__ methods of the station_type class.

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.

ARAString

String of ARA Hpol and Vpol antennas.

RegularStation

Station geometry with strings evenly spaced radially around the center.

Notes

This class is designed to have station-like or 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.

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([stations, …])	Generates antenna positions around the station.
triggered([station_requirement, …])	Check if the detector is triggered based on its current state.