PyREx

pyrex.custom.irex.detector.RegularStation.triggered

RegularStation.triggered(antenna_requirement=1, string_requirement=1, require_mc_truth=False)

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

Station is triggered if the number of antennas that have been hit (according to is_hit) is greater than or equal to the antenna_requirement and the number of strings with antennas that have been hit is greater than or equal to the string_requirement.

Parameters
antenna_requirementfloat, optional

The number of antennas which must be hit for the station to trigger.

string_requirementfloat, optional

The number of strings which must be hit for the station to trigger.

require_mc_truthboolean, optional

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

Returns
boolean

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

See also

pyrex.custom.irex.EnvelopeHpol.trigger

Check if the antenna triggers on a given signal.

pyrex.custom.irex.EnvelopeVpol.trigger

Check if the antenna triggers on a given signal.

IREXString.triggered

Check if the string 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