NuRadioReco.modules.RNO_G.stationCoherentlySummedWaveforms module

class NuRadioReco.modules.RNO_G.stationCoherentlySummedWaveforms.stationCoherentlySummedWaveforms

Bases: object

Generates a coherently-summed waveform (CSW) and calculates its signal-to-noise-ratio (SNR).

When multiple waveforms and a referance waveform are given, one can find the cross correlation between each waveform and the referance waveform, then each waveform will be rolled to line up the signal position with the referance based on the time lag when both waveforms are most correlated, and then all waveforms including the reference will be summed up to become a coherently-summed waveform (CSW). Thermal noise is random so it scales with the square root of added waveforms while coherent signals will added up linearly. Once summed the CSW is treated as a regular waveform and different analysis variables are calculated.

Methods

begin([coincidence_window_size, pad_length, ...])
coherent_sum_step_by_step(station)	Plot the four original waveforms before any alignment and save
end()	(Unused)
run(evt, station, det[, ref_ch_id, use_envelope])	Calculate the SNR of the coherently-summed waveform and add to the station object.

(Unused)

Methods

begin([coincidence_window_size, pad_length, ...])
coherent_sum_step_by_step(station)	Plot the four original waveforms before any alignment and save
end()	(Unused)
run(evt, station, det[, ref_ch_id, use_envelope])	Calculate the SNR of the coherently-summed waveform and add to the station object.

begin(coincidence_window_size=6, pad_length=500, channel_ids=[0, 1, 2, 3])

Parameters:

coincidence_window_size: float (default: 6 * units.ns)

Window size used for calculating the maximum peak to peak amplitude in nanoseconds

pad_length: int (default: 500)

Padding length used for calculating the coherent sum

channel_ids: array of int (default: [0, 1, 2, 3])

Channels for which to calculate the variables

run(evt, station, det, ref_ch_id=0, use_envelope=True)

Calculate the SNR of the coherently-summed waveform and add to the station object.

Parameters:

evt, station, det

Event, Station, Detector

ref_ch_id: int (default: 0)

Reference channel for the coherent sum

use_envelope: bool (default: True)

If use Hilbert envelopes to find the cross correlation or not

end()

(Unused)

coherent_sum_step_by_step(station)

Plot the four original waveforms before any alignment and save