PyREx

pyrex.AntennaSystem

class pyrex.AntennaSystem(antenna)

Base class for antenna system with front-end processing.

Behaves similarly to an antenna by passing some functionality downward to an antenna class, but additionally applies some front-end processing (e.g. an electronics chain) to the signals received.

Parameters
antennaAntenna

Antenna class or subclass to be extended with a front end. Can also accept an Antenna object directly.

See also

pyrex.Antenna

Base class for antennas.

Attributes
antennaAntenna

Antenna object extended by the front end.

lead_in_timefloat

Lead-in time (s) required for the front end to equilibrate. Automatically added in before calculation of signals and waveforms.

is_hit

Boolean of whether the antenna system has been triggered.

is_hit_mc_truth

Boolean of whether the antenna has been triggered by signal.

signals

The signals received by the antenna with front-end processing.

waveforms

The antenna system signal + noise for each triggered hit.

all_waveforms

The antenna system signal + noise for all hits.

Methods

apply_response(signal[, direction, …])

Process the complete antenna response for an incoming signal.

clear([reset_noise])

Reset the antenna system to an empty state.

front_end(signal)

Apply front-end processes to a signal and return the output.

full_waveform(times)

Signal + noise for the antenna system for the given times.

is_hit_during(times)

Check if the antenna system is triggered in a time range.

make_noise(times)

Creates a noise signal over the given times.

receive(signal[, direction, polarization, …])

Process and store one or more incoming (polarized) signals.

set_orientation([z_axis, x_axis])

Sets the orientation of the antenna system.

setup_antenna(*args, **kwargs)

Setup the antenna by passing along its init arguments.

trigger(signal)

Check if the antenna system triggers on a given signal.

PyREx

A Python package for simulation of neutrinos and radio antennas in ice. Version 1.10.0

Navigation