NuRadioReco.modules.trigger.envelopeTrigger module

NuRadioReco.modules.trigger.envelopeTrigger.get_envelope_triggers(trace, threshold)

calculates a Hilbert-envelope based trigger

Parameters:

trace: array of floats

the signal trace

threshold: float

the threshold

Returns:

triggered bins: array of bools

the bins where the trigger condition is satisfied

class NuRadioReco.modules.trigger.envelopeTrigger.triggerSimulator

Bases: object

Calculate a simple amplitude trigger depending on the Hilbert-envelope.

Methods

run(evt, station, det, passband, order, ...)

Simulates simple threshold trigger based on a Hilbert-envelope of the trace.

begin
end

begin()

run(evt, station, det, passband, order, threshold, coinc_window, number_coincidences=2, triggered_channels=None, trigger_name='envelope_trigger')

Simulates simple threshold trigger based on a Hilbert-envelope of the trace. Passband of the trigger, coincidence window within different channels should have triggered, and the number of channels needed to trigger can be specified.

Parameters:

evt: Event

Event to run the module on

station: Station

Station to run the module on

det: Detector

The detector description

passband: list

Passband of the filter to apply before the trigger

order: int

Order of the butterworth filter to apply before the trigger

threshold: float or dict of floats

threshold above (or below) a trigger is issued, absolute amplitude a dict can be used to specify a different threshold per channel where the key is the channel id

number_coincidences: int

number of channels that are required in coincidence to trigger a station

triggered_channels: array of ints or None

channels ids that are triggered on, if None trigger will run on all channels

coinc_window: float

time window in which number_coincidences channels need to trigger

trigger_name: string

a unique name of this particular trigger

end()