NuRadioReco.framework.radio_shower module

class NuRadioReco.framework.radio_shower.RadioShower(shower_id=0, station_ids=None)[source]

Bases: BaseShower

Parameters:

parameter_typesparameter class or list of classes: The parameter classes are defined in NuRadioReco.framework.parameters

Methods

`add_parameter_type`(parameter_type)	Add a parameter class to the list of allowed parameter classes.
`get_axis`()	Returns the (shower) axis.
`get_coordinatesystem`()	Returns radiotools.coordinatesystem.cstrafo for shower geometry.
`get_parameter`(key)	Get a parameter
`get_parameter_error`(key)	Get the error of a parameter
`get_parameters`()	Get all parameters
`has_parameter`(key)	Returns True if the parameter key is present, False otherwise
`has_parameter_error`(key)	Returns True if an uncertainty for the parameter key is present, False otherwise
`remove_parameter`(key)	Remove a parameter
`set_parameter`(key, value)	Set a parameter
`set_parameter_error`(key, value)	Set the error of a parameter

deserialize
get_id
get_station_ids
has_station_ids
serialize

get_station_ids()[source]

has_station_ids(ids)[source]

serialize()[source]

deserialize(data_pkl)[source]

add_parameter_type(parameter_type)

Add a parameter class to the list of allowed parameter classes.

Parameters:

parameter_typeparameter class: The parameter class is defined in NuRadioReco.framework.parameters

get_axis()

Returns the (shower) axis.

The axis is antiparallel to the movement of the shower particla and point towards the origin of the shower.

Returns:

np.array(3,): Shower axis

get_coordinatesystem()

Returns radiotools.coordinatesystem.cstrafo for shower geometry.

Can be used to transform the radio pulses or the observer coordiates in the shower frame. Requieres the shower arrival direction (azimuth and zenith angle) and magnetic field vector (showerParameters).

Returns:

radiotools.coordinatesystem.cstrafo

get_id()

get_parameter(key): Get a parameter

get_parameter_error(key): Get the error of a parameter

get_parameters(): Get all parameters

has_parameter(key): Returns True if the parameter key is present, False otherwise

has_parameter_error(key): Returns True if an uncertainty for the parameter key is present, False otherwise

remove_parameter(key): Remove a parameter

set_parameter(key, value): Set a parameter

set_parameter_error(key, value): Set the error of a parameter