pyrex.custom.ara.RegularStation

class pyrex.custom.ara.RegularStation(x, y, strings_per_station=4, station_diameter=20, string_type=<class 'pyrex.custom.ara.detector.ARAString'>, **string_kwargs)

Station geometry with strings evenly spaced radially around the center.

Sets the positions of strings around the station based on the parameters. Supports any string type and passes extra keyword arguments on to the string 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

xfloat

Cartesian x-position (m) of the station.

yfloat

Cartesian y-position (m) of the station.

strings_per_stationfloat, optional

Number of strings to be placed evenly around the station.

station_diameterfloat, optional

Diameter (m) of the circle around which strings are placed.

string_typeoptional

Class to be used for creating string objects for subsets.

**string_kwargs

Keyword arguments to be passed on to the __init__ methods of the string_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.

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.

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