pyrex.custom.ara.PhasedArrayStation.triggered¶
-
PhasedArrayStation.
triggered
(beam_threshold, outrigger_antenna_requirement=None, beam_delays=None, beam_angles=None, require_mc_truth=False)¶ Check if the station is triggered based on its current state.
Station is triggered if the phased array triggers with the given parameters. If the outrigger_antenna_requirement is not
None
then the station will also trigger if the number of outrigger antennas that have been hit (according tois_hit
) of a single type (polarization) is greater than or equal to the outrigger_antenna_requirement.- Parameters
- beam_thresholdfloat
Factor of expected noise RMS above which a phased beam waveform will trigger.
- outrigger_antenna_requirementfloat or None, optional
The number of outrigger antennas in a single polarization which must be hit for the station to trigger.
- beam_delaysarray_like or None
Time delays (s) between each pair of antennas to use for beam forming. If
None
calculates the time delays based on the desired beam angles in angles.- beam_anglesarray_like or None
Polar angles (degrees) at which to form phased beams. If
None
and delays isNone
, default beam delays are used based on the typical ARA phased array delays.- 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
PhasedArrayString.triggered
Check if the string is triggered based on its current state.
pyrex.custom.ara.HpolAntenna.trigger
Check if the antenna system triggers on a given signal.
pyrex.custom.ara.VpolAntenna.trigger
Check if the antenna system triggers on a given signal.