pyrex.custom.irex.IREXString.triggered

IREXString.triggered(antenna_requirement=1, require_mc_truth=False)

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

String is triggered if the number of antennas that have been hit (according to is_hit) is greater than or equal to the antenna_requirement.

Parameters

antenna_requirementfloat, optional

The number of antennas which must be hit for the string 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 string 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.