NuRadioReco.modules.channelReadoutWindowCutter module

class NuRadioReco.modules.channelReadoutWindowCutter.channelReadoutWindowCutter(log_level=0)

Bases: object

Modifies channel traces to simulate the effects of the trigger

The trace is cut to the length defined in the detector description relative to the trigger time. If no trigger exists, nothing is done.

Methods

run(event, station, detector)

Cuts the traces to the readout window defined in the trigger.

begin

begin()

run(event, station, detector)

Cuts the traces to the readout window defined in the trigger.

If multiple triggers exist, the primary trigger is used. If multiple primary triggers exist, an error is raised. If no primary trigger exists, the trigger with the earliest trigger time is defined as the primary trigger and used to set the readout windows.

Parameters:

event: `NuRadioReco.framework.event.Event`

station: `NuRadioReco.framework.base_station.Station`

detector: `NuRadioReco.detector.detector.Detector`

NuRadioReco.modules.channelReadoutWindowCutter.get_empty_channel(station_id, channel_id, detector, trigger, sampling_rate)

Returns a channel with a trace containing zeros.

The trace start time is given by the trigger, the duration of the trace is determined by the detector description, and the number of samples determined by the duration and the given sampling rate.

Parameters:

station_id: int

The station id

channel_id: int

The channel id

detector: `NuRadioReco.detector.detector.Detector`

The detector description

trigger: `NuRadioReco.framework.trigger.Trigger`

The trigger that triggered the station

sampling_rate: float

The sampling rate of the channel