PyREx

pyrex.detector.CombinedDetector

class pyrex.detector.CombinedDetector(*detectors)

Class for detectors which have been added together.

Designed to allow addition of Detector and Antenna-like objects which can still build all antennas and trigger by smartly passing down keyword arguments to the subsets. Maintains all other properties of the Detector objects.

Raises
ValueError

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

See also

pyrex.Antenna

Base class for antennas.

AntennaSystem

Base class for antenna system with front-end processing.

Detector

Base class for detectors for easily building up sets of antennas.

Attributes
antenna_positionslist

List of the positions of the antennas in the detector.

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(*args, **kwargs)

Sets the positions of antennas in the detector.

triggered(*args[, require_mc_truth])

Check if the detector is triggered based on its current state.

PyREx

A Python package for simulation of neutrinos and radio antennas in ice. Version 1.10.0

Navigation