NuRadioReco.modules.correlationDirectionFitter module

class NuRadioReco.modules.correlationDirectionFitter.correlationDirectionFitter[source]

Bases: object

Fits the direction using correlation of parallel channels.

Methods

run(evt, station, det[, n_index, ZenLim, ...])

reconstruct signal arrival direction for all events

begin

end

begin(debug=False, log_level=0)[source]
run(evt, station, det, n_index=None, ZenLim=None, AziLim=None, channel_pairs=((0, 2), (1, 3)), use_envelope=False)[source]

reconstruct signal arrival direction for all events

Parameters:
evt: Event

The event to run the module on

station: Station

The station to run the module on

det: Detector

The detector description

n_index: float

the index of refraction

ZenLim: 2-dim array/list of floats (default: [0 * units.deg, 90 * units.deg])

the zenith angle limits for the fit

AziLim: 2-dim array/list of floats (default: [0 * units.deg, 360 * units.deg])

the azimuth angle limits for the fit

channel_pairs: pair of pair of integers

specify the two channel pairs to use, default ((0, 2), (1, 3))

use_envelope: bool (default False)

if True, the hilbert envelope of the traces is used

end()[source]