NuRadioReco.modules.efieldToVoltageConverter module

class NuRadioReco.modules.efieldToVoltageConverter.efieldToVoltageConverter(log_level=0)[source]

Bases: object

Convolves electric field with antenna response to get the voltage output of the antenna

Module that should be used to convert simulations to data. It assumes that at least one efield is given per channel as input. It will convolve the electric field with the corresponding antenna response for the incoming direction specified in the channel object. The station id, defines antenna location and antenna type.

Attributes:

antenna_provider

Methods

`begin`([debug, uncertainty, time_resolution, ...])	Begin method, sets general parameters of module
`get_antenna_pattern_and_orientation`(det, ...)	Get the antenna pattern and orientation for a given channel and zenith angle.

end
run

begin(debug=False, uncertainty=None, time_resolution=None, pre_pulse_time=200, post_pulse_time=400, caching=True)[source]

Begin method, sets general parameters of module

Parameters:

debug: bool

enable/disable debug mode (default: False -> no debug output)

uncertainty: dictionary (default: {})

optional argument to specify systematic uncertainties. currently supported keys

‘sys_dx’: systematic uncertainty of x position of antenna

‘sys_dy’: systematic uncertainty of y position of antenna

‘sys_dz’: systematic uncertainty of z position of antenna

‘sys_amp’: systematic uncertainty of the amplifier aplification,
specify value as relative difference of linear gain

‘amp’: statistical uncertainty of the amplifier aplification,
specify value as relative difference of linear gain

time_resolution: float

Deprecated.

pre_pulse_time: float

length of empty samples that is added before the first pulse

post_pulse_time: float

length of empty samples that is added after the simulated trace

caching: bool

enable/disable caching of antenna response to save loading times (default: True)

property antenna_provider

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

end()[source]

get_antenna_pattern_and_orientation(det, station, channel_id, zenith)[source]

Get the antenna pattern and orientation for a given channel and zenith angle.

Parameters:

det: Detector: Detector object
station: Station: Station object
channel_id: int: Channel id of the channel
zenith: float: Zenith angle in radians. For some antenna models, the zenith angle is needed to get the correct antenna pattern.

Returns:

antenna_pattern: AntennaPattern: Antenna pattern object
antenna_orientation: list: Antenna orientation in radians

NuRadioReco.modules.efieldToVoltageConverter.calculate_time_shift_for_cosmic_ray(det, sim_station, efield, channel_id)[source]

Calculate the time shift for an electric field to reach a channel.

For cosmic ray events, we often only have one electric field for all channels, so we have to account for the difference in signal travel between channels.

Parameters:

det: Detector
sim_station: SimStation
efield: ElectricField
channel_id: int: Channel id of the channel

Returns:

travel_time_shift: float: time shift in ns