NuRadioReco.modules.neutrinoDirectionReconstructor.voltageToEfieldAnalyticConverterForNeutrinos module

class NuRadioReco.modules.neutrinoDirectionReconstructor.voltageToEfieldAnalyticConverterForNeutrinos.voltageToAnalyticEfieldConverterNeutrinos

Bases: object

This module reconstructs the electric-field by forward folding an analytic pulse function through the antenna.

This module is specified for neutrinos.

Before the reconstruction, the channels are upsampled.

The module is optimized for an electric-field reconstruction using two channels. First, the energy and the viewing angle are fitted using a Vpol antenna. Then the viewing angle is fixed in the Hpol antenna, and the energy is fitted.

Methods

begin()	begin method.
run(evt, station, det, icemodel[, ...])	run method.

end

begin()

begin method. This function is executed before the event loop. The antenna pattern provieder is initialized here.

run(evt, station, det, icemodel, shower_type='HAD', use_channels=[0, 1, 2, 3], attenuation_model='SP1', parametrization='Alvarez2000', hilbert=False, use_bandpass_filter=False, passband_low={}, passband_high={}, include_focusing=False, use_MC=True, n_samples_multiplication_factor=1, plot_traces_with_true_input=False, debug=False)

run method. This function is executed for each event

Parameters:

evt

station

det

icemodel

shower_type: string

determines the shower type during reconstructing the voltage traces.

use_channels: array of ints

the channel ids for the antennas used for reconstructing voltage traces.

attenuation_model: string

the frequency dependent ice attenuation model used

parametrization: string

neutrino parametrization model used for the reconstruction.

hilbert: bool

if True, use the hilbert envelope of the traces in the chi2 fit

use_bandpass_filter: bool

if True, the voltage traces are filtered according to the passband_low and passband_high inputs

passband_low: dictionary

map between channel id and complex filter amplitudes which themselves are array of complex floats.

passband_high: dictionary

map between channel id and complex filter amplitudes which themselves are array of complex floats

include_focusing: bool

if True, include amplification of signal due to focusing effects.

use_MC: bool

if True use simulated properties such as vertex position instead of reconstructed properties

n_samples_multiplication_factor: int

expands the time window length by n. It is used to consider all ray tracing solutions when fitting reconstructed traces against event. The value of n is site dependent and can speed up the algorithm and save space considerably.

plot_traces_with_true_input: bool,

for simulated events only, if True produces a figure overlaying the simulated voltage traces with the reconstructed voltage traces using the true nu direction and energy

debug: bool

if True debug plotting is enabled

end()