NuRadioReco.framework.particle module

class NuRadioReco.framework.particle.Particle(particle_index)

Bases: ParameterStorage

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_id()	Returns hierarchical index
get_parameter(key[, copy])	Get a parameter
get_parameter_covariance(key1, key2)	Get the covariance of two parameters
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_covariance(key1, key2)	Returns True if the covariance for key1 and key2 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_covariance(key1, key2, value)	Set the covariance of two parameters
set_parameter_error(key, value)	Set the error of a parameter
show([show_parameters, print_stdout])	Print an overview of the structure of the Particle.

as_hdf5_dict
deserialize
serialize

get_id()

Returns hierarchical index

as_hdf5_dict()

serialize()

deserialize(data_pkl)

show(show_parameters=0, print_stdout=True, **kwargs)

Print an overview of the structure of the Particle.

Parameters:

show_parametersint, default: 0

If > 0, print the parameters stored in the Particle.

Returns:

str_outputstr, optional

A string representation of the Particle structure.

Other Parameters:

print_stdoutbool, optional

If True (default), print the Particle structure to stdout. Otherwise, return the string representation

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_parameter(key, copy=True)

Get a parameter

Parameters:

keyparameter key

The parameter to retrieve.

copybool (default: True)

If True (default), mutable values (e.g. list, dict, numpy.ndarray) are deep-copied before being returned, so that modifying the returned value does not also modify the parameter stored in this object. Values of immutable types (e.g. int, float, str, None) are never copied, since they cannot be mutated in place regardless of this option.

Set to False to retrieve the stored object itself without copying, e.g. for read-only access to large objects in performance-critical code. Note that in this case, any in-place modification of the returned object will also modify the parameter stored in this object.

get_parameter_covariance(key1, key2)

Get the covariance of two parameters

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_covariance(key1, key2)

Returns True if the covariance for key1 and key2 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_covariance(key1, key2, value)

Set the covariance of two parameters

set_parameter_error(key, value)

Set the error of a parameter