PyREx

pyrex.askaryan.ZHSAskaryanSignal

class pyrex.askaryan.ZHSAskaryanSignal(times, particle, viewing_angle, viewing_distance=1, ice_model=<pyrex.ice_model.AntarcticIce object>, t0=0)

Class for generating Askaryan signals according to ZHS parameterization.

Stores the time-domain information for an Askaryan electric field (V/m) produced by the electromagnetic shower initiated by a neutrino.

Parameters
timesarray_like

1D array of times (s) for which the signal is defined.

particleParticle

Particle object responsible for the shower which produces the Askaryan signal. Should have an energy in GeV, vertex in m, and id, plus an interaction with an em_frac and had_frac.

viewing_anglefloat

Observation angle (radians) measured relative to the shower axis.

viewing_distancefloat, optional

Distance (m) between the shower vertex and the observation point (along the ray path).

ice_modeloptional

The ice model to be used for describing the index of refraction of the medium.

t0float, optional

Pulse offset time (s), i.e. time at which the shower takes place.

Raises
ValueError

If the particle object is not a neutrino or antineutrino with a charged-current or neutral-current interaction.

See also

pyrex.FunctionSignal

Class for signals generated by a function.

pyrex.Particle

Class for storing particle attributes.

Notes

Calculates the Askaryan signal based on the ZHS parameterization [1]. Uses equations 20 and 21 to calculate the electric field close to the Cherenkov angle.

References

1

E. Zas, F. Halzen, T. Stanev, “Electromagnetic pulses from high-energy showers: implications for neutrino detection”, Physical Review D 45, 362-376 (1992). DOI:10.1103/PhysRevD.45.362

Attributes
times, valuesndarray

1D arrays of times (s) and corresponding values which define the signal.

value_typeSignal.Type.field

Type of signal, representing the units of the values.

TypeEnum

Enum containing possible types (units) for signal values.

energyfloat

Energy (GeV) of the electromagnetic shower producing the pulse.

vector_potential
dt

The time spacing of the times array, or None if invalid.

frequencies

The FFT frequencies of the signal.

spectrum

The FFT complex spectrum values of the signal.

envelope

The envelope of the signal by Hilbert transform.

Methods

Type(value)

Enum containing possible types (units) for signal values.

copy()

Get a copy of the FunctionSignal object.

filter_frequencies(freq_response[, force_real])

Apply the given frequency response function to the signal, in-place.

resample(n)

Resamples the signal into n points in the same time range, in-place.

set_buffers([leading, trailing, force])

Set leading and trailing buffers used in calculation of signal values.

shift(dt)

Shifts the signal values in time by dt.

with_times(new_times)

Returns a representation of this signal over a different times array.

PyREx

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

Navigation