pyrex.custom.irex.detector.StationGrid.triggered

StationGrid.triggered(station_requirement=1, require_mc_truth=False, **station_trigger_kwargs)

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

Detector is triggered if the number of stations that are triggered (according to their triggered method) is greater than or equal to the station_requirement. Passes extra keyword arguments on to the triggered methods of the station objects.

Parameters

station_requirementfloat, optional

The number of stations which must be triggered for the detector 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.

**station_trigger_kwargs

Keyword arguments to be passed on to the triggered methods of the station objects in subsets.

Returns

boolean

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

See also

IREXString.triggered

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

RegularStation.triggered

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

CoxeterStation.triggered

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