PyREx

pyrex.detector.CombinedDetector.triggered

CombinedDetector.triggered(*args, require_mc_truth=False, **kwargs)

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

By default triggers if any subset of the detector is triggered. Passes arguments down to the appropriate subsets if the subsets are Detector objects, or checks for any triggering waveforms in Antenna-like objects.

Parameters
require_mc_truthboolean, optional

Whether or not the trigger should be based on the Monte-Carlo truth. If True, noise-only triggers are removed.

*args, **kwargs

Positional and keyword arguments to be passed down to triggered methods of the detector subsets.

Returns
boolean

Whether or not the detector is triggered in its current state.

See also

pyrex.Antenna.trigger

Check if an antenna triggers on a given signal.

pyrex.AntennaSystem.trigger

Check if an antenna system triggers on a given signal.

pyrex.Detector.triggered

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