pyrex.custom.ara.stations.Calpulsers

class pyrex.custom.ara.stations.Calpulsers(station, x=0, y=0, z=0, local_coords=None)

Group of ARA calibration pulser antenna strings.

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.

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.

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(station[, x, y, z, local_coords])	Generates antenna positions along the string.
triggered(*args[, require_mc_truth])	Check if the detector is triggered based on its current state.