NuRadioReco.modules.channelSignalReconstructor module

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

Bases: object

Calculates basic signal parameters.

Methods

begin([debug, signal_window_start, ...])
get_SNR(station_id, channel, det[, ...])
get_max_a_norm(station)	Calculate the maximum peak to peak amplitude of the signal normalized by the noise level over all channels in a station.
run(evt, station, det[, stored_noise, ...])	Compute signal properties for all channels in a station.

end

begin(debug=False, signal_window_start=None, signal_window_length=120, noise_window_start=None, noise_window_length=None, coincidence_window_size=6)

Parameters:

debug: bool

Set module to debug output

signal_window_start: float or None

Start time (relative to the trace start time) of the window in which signal quantities will be calculated, with time units If None is passed as a parameter, the signal window is laid around the trace maximum

signal_window_length: float

Length of the signal window, with time units

noise_window_start: float or None

Start time (relative to the trace start time) of the window in which noise quantities will be calculated, with time units If noise_window_start or noise_window_length are None, the noise window is the part of the trace outside the signal window

noise_window_length: float or None

Length of the noise window, with time units If noise_window_start or noise_window_length are None, the noise window is the part of the trace outside the signal window

coincidence_window_sizefloat (default: 6ns)

Window size used for calculating the maximum peak to peak amplitude used for the max_a_norm variable

get_SNR(station_id, channel, det, stored_noise=False, rms_stage=None)

Parameters:

station_id: int

ID of the station

channelChannel

detDetector

stored_noise: bool, optional

Calculates noise from pre-computed forced triggers. Default False

rms_stage: string, optional

See functionality of det.get_noise_RMS. Only relevant if stored_noise==True

Returns:

SNR: dict

dictionary of various SNR parameters

RMS: float

noise root mean square of a channel

get_max_a_norm(station)

Calculate the maximum peak to peak amplitude of the signal normalized by the noise level over all channels in a station.

Parameters:

stationStation

The station object containing the channels.

Returns:

maxavalfloat

The maximum peak to peak amplitude of the signal normalized by the noise level over all channels in the station.

run(evt, station, det, stored_noise=False, rms_stage='amp', snr_only=False)

Compute signal properties for all channels in a station.

Parameters:

evtEvent

stationStation

detDetector

stored_noise: bool

Calculates noise from pre-computed forced triggers

rms_stage: string, optional

See functionality of det.get_noise_RMS. Only relevant if stored_noise==True. Default “amp”, i.e. use RMS voltage after amplifier stage.

snr_onlybool, default False

If True, only compute SNR statistics (faster); otherwise (default), also compute additional signal properties such as impulsivity, kurtosis and entropy.

end()