template_synthesis.jax.io.base_shower module¶

class template_synthesis.jax.io.base_shower.BaseShower¶

Bases: object

Base class to contain the shower parameters.

The Shower class is used to hold the geometric information for a shower, like the zenith/azimuth, as well as the longitudinal profile. It can be used to specify the target parameters for a shower in template synthesis.

property azimuth : float¶

The azimuthal angle in degrees.

property core : Array¶

The core (x, y, z in NRR CS) where the EAS hit in the simulation.

property geomagnetic_angle : float¶

The angle between the magnetic field vector and the shower axis.

property geometry : Array¶

Store the zenith and azimuth. These must be provided in the internal units system.

property grammages : Array¶

Array of atmospheric slices in g/cm^2.

property magnet : float¶

Magnetic field vector in the NRR coordinate system.

property nmax : float¶

The $N_{max}$ of the shower, from fitting a GH to the longitudinal profile.

property nparts_per_slice : float¶

The number of particles in each slice.

property nr_slices : int¶

The number of slices in the array.

set_parameters(grammages: Array | ndarray | bool | number | bool | int | float | complex, params: dict) → None¶

Set the parameters of the shower model from a dictionary of parameters.

Parameter:¶

grammagesjax.typing.ArrayLike

an array of atmospheric depth in g/cm^2

paramsdict

a dictionary containing values of all parameters. this includes: - Xmax in g/cm^2 (key: “xmax”) - Nmax (key: “nmax”) - zenith angle in degrees (key : “zenith”) - azimuthal angle in degrees (key : “azimuth”) - magnetic field vector in jax.typing.ArrayLike (key : “magnetic_field”)

The function will raise an error if any of these parameters are not contained in the dictionary with the specific key.

property slice_grammage : float¶

The spacing between each grammage in g/cm^2.

property xmax : float¶

The $X_{max}$ of the shower, from fitting a GH to the longitudinal profile.

property zenith : float¶

The zenith angle in degrees.