NuRadioReco.framework.trigger module

NuRadioReco.framework.trigger.deserialize(triggers_pkl)

class NuRadioReco.framework.trigger.Trigger(name, channels=None, trigger_type='default', pre_trigger_times=55)

Bases: object

base class to store different triggers

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

initialize trigger class

Parameters:

name: string

unique name of the trigger

channels: array of ints

the channels that are involved in the trigger

trigger_type: string

the trigger type

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

is_primary()

return True if this trigger is the primary trigger

has_triggered()

returns true if station has trigger, false otherwise

set_triggered(triggered=True)

set the trigger to True or False

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_name()

get trigger name

get_type()

get trigger type

get_triggered_channels()

get IDs of channels that have triggered

set_triggered_channels(triggered_channels)

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

serialize()

deserialize(data_pkl)

get_trigger_settings()

class NuRadioReco.framework.trigger.SimpleThresholdTrigger(name, threshold, channels=None, number_of_coincidences=1, channel_coincidence_window=None, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold: float or dict of floats

the threshold

channels: array of ints or None

the channels that are involved in the trigger default: None, i.e. all channels

number_of_coincidences: int

the number of channels that need to fulfill the trigger condition default: 1

channel_coincidence_window: float or None (default)

the coincidence time between triggers of different channels

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.EnvelopePhasedTrigger(name, threshold_factor, power_mean, power_std, triggered_channels=None, phasing_angles=None, trigger_delays=None, output_passband=(None, None), pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold_factor: float

the threshold factor

power_mean: float

mean of the noise trace after being filtered with the diode

power_std: float

standard deviation of the noise trace after being filtered with the diode. power_mean and power_std can be calculated with the function calculate_noise_parameters from utilities.diodeSimulator

triggered_channels: array of ints or None

the channels that are involved in the main phased beam default: None, i.e. all channels

phasing_angles: array of floats or None

the angles for each beam

trigger_delays: dictionary

the delays for the channels that have caused a trigger. If there is no trigger, it’s an empty dictionary

output_passband: (float, float) tuple

Frequencies for a 6th-order Butterworth filter to be applied after the diode filtering.

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.SimplePhasedTrigger(name, threshold, channels=None, secondary_channels=None, primary_angles=None, secondary_angles=None, trigger_delays=None, sec_trigger_delays=None, window_size=None, step_size=None, maximum_amps=None, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold: float

the threshold

channels: array of ints or None

the channels that are involved in the main phased beam default: None, i.e. all channels

secondary_channels: array of ints or None

the channels involved in the secondary phased beam

primary_angles: array of floats or None

the angles for each subbeam of the primary phasing

secondary_angles: array of floats or None

the angles for each subbeam of the secondary phasing

trigger_delays: dictionary

the delays for the primary channels that have caused a trigger. If there is no trigger, it’s an empty dictionary

sec_trigger_delays: dictionary

the delays for the secondary channels that have caused a trigger. If there is no trigger or no secondary channels, it’s an empty dictionary

window_size: int

the size of the integration window (units of ADC time ticks)

step_size: int

the size of the stride between calculating the phasing (units of ADC time ticks)

maximum_amps: list of floats (length equal to that of `phasing_angles`)

the maximum value of all the integration windows for each of the phased waveforms

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.HighLowTrigger(name, threshold_high, threshold_low, high_low_window, channel_coincidence_window, channels=None, number_of_coincidences=1, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold_high: float or dict of floats

the high threshold

threshold_low: float or dict of floats

the low threshold

high_low_window: float

the coincidence time between a high and low per channel

channel_coincidence_window: float

the coincidence time between triggers of different channels

channels: array of ints or None

the channels that are involved in the trigger default: None, i.e. all channels

number_of_coincidences: int

the number of channels that need to fulfill the trigger condition default: 1

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.IntegratedPowerTrigger(name, threshold, channel_coincidence_window, channels=None, number_of_coincidences=1, power_mean=None, power_std=None, integration_window=None, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold: float

the threshold

channel_coincidence_window: float

the coincidence time between triggers of different channels

channels: array of ints or None

the channels that are involved in the trigger default: None, i.e. all channels

number_of_coincidences: int

the number of channels that need to fulfill the trigger condition default: 1

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.EnvelopeTrigger(name, passband, order, threshold, number_of_coincidences=2, channel_coincidence_window=None, channels=None, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

passband: array

the passband in which the trigger should apply

order: int

order of filtertype ‘butterabs’

threshold: float

the threshold

channels: array of ints or None

the channels that are involved in the trigger default: None, i.e. all channels

number_of_coincidences: int

the number of channels that need to fulfill the trigger condition default: 1

channel_coincidence_window: float or None (default)

the coincidence time between triggers of different channels

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)

class NuRadioReco.framework.trigger.RNOGSurfaceTrigger(name, threshold, number_of_coincidences=1, channel_coincidence_window=60, channels=[13, 16, 19], temperature=250, Vbias=2.0, pre_trigger_times=55)

Bases: Trigger

initialize trigger class

Parameters:

name: string

unique name of the trigger

threshold: float

the threshold

number_of_coincidences: int

the number of channels that need to fulfill the trigger condition default: 1

channel_coincidence_window: float or None (default)

the coincidence time between triggers of different channels

channels: array of ints or None

the channels that are involved in the trigger default: None, i.e. all channels

temperature: float

temperature of the trigger board

Vbias: float

bias voltage on the trigger board

pre_trigger_times: float or dict of floats

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

Methods

get_name()	get trigger name
get_pre_trigger_time_channel(channel_id)	get the trigger time for a specific channel
get_pre_trigger_times()	Return the pre_trigger_time between the start of the trace and the (global) trigger time
get_trigger_time()	Get the trigger time.
get_trigger_times()	Get the trigger times
get_triggered_channels()	get IDs of channels that have triggered
get_type()	get trigger type
has_triggered()	returns true if station has trigger, false otherwise
is_primary()	return True if this trigger is the primary trigger
set_pre_trigger_times(pre_trigger_times)	Set the pre-trigger times
set_primary([primary_trigger])	set the trigger to be the primary trigger.
set_trigger_time(time)	set the trigger time
set_trigger_times(times)	set the trigger times
set_triggered([triggered])	set the trigger to True or False

deserialize
get_trigger_settings
serialize
set_triggered_channels

units = <module 'NuRadioReco.utilities.units' from '/home/runner/work/NuRadioMC/NuRadioMC/NuRadioReco/utilities/units.py'>

deserialize(data_pkl)

get_name()

get trigger name

get_pre_trigger_time_channel(channel_id)

get the trigger time for a specific channel

convenience function to get the trigger time for a specific channel

Parameters:

channel_id: int

the channel id

Returns:

trigger_time: float

the trigger time for the channel

get_pre_trigger_times()

Return the pre_trigger_time between the start of the trace and the (global) trigger time

Returns:

pre_trigger_times: dict | float

the time before the trigger time that should be read out if a dict is returned, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

get_trigger_settings()

get_trigger_time()

Get the trigger time.

Returns trigger time, i.e. the first time in the event where the trigger condition was fulfilled. This is defined relative to the station_time.

Returns:

trigger_timefloat

The trigger time

See also

get_trigger_times

function to return all times where the trigger condition was fulfilled

get_trigger_times()

Get the trigger times

For some triggers, in addition to the time of the first trigger, also all subsequent times where the trigger condition were fulfilled are stored. For triggers that do not store this information, this method is equivalent to get_trigger_time with the exception that it returns an array (of shape (1,)) instead of a scalar. Note that the trigger times are defined relative to the station_time.

Returns:

trigger_timesnp.ndarray

Array of all times where the trigger condition was satisfied

See also

get_trigger_time

method to return the (first) trigger time

get_triggered_channels()

get IDs of channels that have triggered

get_type()

get trigger type

has_triggered()

returns true if station has trigger, false otherwise

is_primary()

return True if this trigger is the primary trigger

serialize()

set_pre_trigger_times(pre_trigger_times)

Set the pre-trigger times

Parameters:

pre_trigger_times: float or dict

the time before the trigger time that should be read out if a dict is given, the keys are the channel_ids, and the value is the pre_trigger_time between the start of the trace and the trigger time. if only a float is given, the same pre_trigger_time is used for all channels

set_primary(primary_trigger=True)

set the trigger to be the primary trigger. The trigger time of the primary trigger is used to define the readout window. There should only be one primary trigger.

set_trigger_time(time)

set the trigger time

Parameters:

time: float

the trigger time from the beginning of the trace

set_trigger_times(times)

set the trigger times

Parameters:

times: array

all trigger times

set_triggered(triggered=True)

set the trigger to True or False

set_triggered_channels(triggered_channels)