NuRadioReco.modules.eventTypeIdentifier module

class NuRadioReco.modules.eventTypeIdentifier.eventTypeIdentifier[source]

Bases: object

Use this module to distinguish cosmic ray events from neutrino events

Methods

run(event, station, mode[, forced_event_type])

Determines the type of event so that the correct modules can be executed accordingly.

begin

begin()[source]
run(event, station, mode, forced_event_type='neutrino')[source]

Determines the type of event so that the correct modules can be executed accordingly. Currently neutrino and cosmic ray events are supported, but others can be added in the future.

Parameters:
event: event
station: station
mode: string

specifies which criteria the decision to flag the event as cosmic ray or neutrino should be based on. Currently only supports ‘forced’, which automatically flags the event to a specified type. Add new modes to use different criteria

forced_event_type: string

if the mode is set to forced, this is the type the event will be set to. Currently supported options are neutrino and cosmic_ray