NuRadioReco.modules.RNO_G.channelGlitchDetector module

class NuRadioReco.modules.RNO_G.channelGlitchDetector.channelGlitchDetector(cut_value=0.0, glitch_fraction_warn_level=0.1, log_level=0)[source]

Bases: object

This module detects scrambled data (digitizer “glitches”) in the channels.

RNO-G data (in particular the RNO-G data recorded with the LAB4D digitizers on the first-generation radiants) is known to have “glitches” in the channels. When a glitch is present in a channel, the 64-sample readout blocks were scrambled by the readout electronics which results in sudden unphyiscal jumps in the signal. These jumps are detected with this module (but not corrected).

Methods

run(event, station[, det])

Run over channel traces and sets channelParameter.glitch.

begin
end

Parameters:

cut_valuefloat: This module calculates a test statistic that is sensitive to the presence of digitizer glitches. This parameter marks the critical value at which the test is said to have detected a glitch. This is a free parameter; increasing its value results in a lower false-positive rate (i.e. healthy events are incorrectly marked as glitching), but also a lower true-positive rate (i.e. glitching events are correctly marked as such). The default value of 0.0 is a good starting point.
glitch_fraction_warn_levelfloat: Print warning messages at the end of a run if a channel shows glitching in more than a fraction of glitch_fraction_warn_level of all events.
log_level: enum: Set verbosity level of logger. If logging.DEBUG, set mattak to verbose (unless specified in mattak_kwargs). (Default: logging.NOTSET, ie adhere to general log level)

Methods

run(event, station[, det])

Run over channel traces and sets channelParameter.glitch.

begin
end

begin()[source]

end()[source]

run(event, station, det=None)[source]

Run over channel traces and sets channelParameter.glitch.

Parameters:

eventNuRadioReco.framework.event.Event: The event object
stationNuRadioReco.framework.station.Station: The station object
detNuRadioReco.detector.detector.Detector (default: None): Detector object, not used!

NuRadioReco.modules.RNO_G.channelGlitchDetector.has_glitch(event_or_station)[source]

Returns true if any channel in any station has a “glitch”.

Requires the RNO_G.channelGlitchDetector module to have ran on the event.

Parameters:

event_or_stationEvent or Station: The event or station to check for glitches. If an event is given, the first station is used (if multiple stations exist in the event an error is raised).

Returns:

has_glitchbool: True if any channel has a glitch, False otherwise.