NuRadioReco.framework.sim_station module

class NuRadioReco.framework.sim_station.SimStation(station_id)

Bases: BaseStation

Methods

add_channel(channel)	adds a NuRadioReco.framework.sim_channel to the SimStation object
get_ARIANNA_parameter(key)
get_channel(unique_identifier)	returns channel identified by the triple (channel_id, shower_id, ray_tracing_id)
get_channel_ids()	returns a list with the channel IDs of all simChannels of the simStation
get_channels_by_channel_id(channel_id)	returns all simChannels that have the given channel_id
get_channels_by_ray_tracing_id(ray_tracing_id)	returns all simChannels that have the given ray_tracing_id
get_channels_by_shower_id(shower_id)	returns all simChannels that have the given shower_id
get_first_trigger()	Returns the first trigger.
get_ray_tracing_ids()	returns a list with the raytracing IDs of all simChannels of the simStation
get_shower_ids()	returns a list with the shower IDs of all simChannels of the simStation
get_station_time([format])	Returns a astropy.time.Time object
get_station_time_dict()	Return the station time as dict {value, format}.
get_triggers()	Returns a dictionary of the triggers.
has_trigger(trigger_name)	Checks if station has a trigger with a certain name.
has_triggered([trigger_name])	Checks if the station has triggered.
set_is_cosmic_ray()	set station type to cosmic rays (relevant e.g.
set_is_neutrino()	set station type to neutrino
set_station_time(time[, format])	Set the (absolute) time for the station (stored as astropy.time.Time).
set_triggered([triggered])	Convenience function to set a simple trigger.

add_electric_field
deserialize
get_ARIANNA_parameters
get_electric_fields
get_electric_fields_for_channels
get_id
get_magnetic_field_vector
get_parameter
get_parameter_error
get_parameters
get_simulation_weight
get_trigger
has_ARIANNA_parameter
has_parameter
is_cosmic_ray
is_neutrino
iter_channels
remove_parameter
remove_triggers
serialize
set_ARIANNA_parameter
set_electric_fields
set_magnetic_field_vector
set_parameter
set_parameter_error
set_simulation_weight
set_trigger

get_magnetic_field_vector()

set_magnetic_field_vector(magnetic_field_vector)

get_simulation_weight()

set_simulation_weight(simulation_weight)

iter_channels()

add_channel(channel)

adds a NuRadioReco.framework.sim_channel to the SimStation object

get_channel(unique_identifier)

returns channel identified by the triple (channel_id, shower_id, ray_tracing_id)

get_channel_ids()

returns a list with the channel IDs of all simChannels of the simStation

get_shower_ids()

returns a list with the shower IDs of all simChannels of the simStation

get_ray_tracing_ids()

returns a list with the raytracing IDs of all simChannels of the simStation

get_channels_by_channel_id(channel_id)

returns all simChannels that have the given channel_id

get_channels_by_shower_id(shower_id)

returns all simChannels that have the given shower_id

get_channels_by_ray_tracing_id(ray_tracing_id)

returns all simChannels that have the given ray_tracing_id

serialize(save_channel_traces, save_efield_traces)

deserialize(data_pkl)

add_electric_field(electric_field)

get_ARIANNA_parameter(key)

get_ARIANNA_parameters()

get_electric_fields()

get_electric_fields_for_channels(channel_ids=None, ray_path_type=None)

get_first_trigger()

Returns the first trigger. Returns None if no trigger is present.

get_id()

get_parameter(key)

get_parameter_error(key)

get_parameters()

get_station_time(format='isot')

Returns a astropy.time.Time object

Parameters:

format: str

Format in which the time object is displayed. (Default: isot)

Returns:

_station_time: astropy.time.Time

get_station_time_dict()

Return the station time as dict {value, format}. Used for reading and writing

get_trigger(name)

get_triggers()

Returns a dictionary of the triggers. key is the trigger name, value is a trigger object

has_ARIANNA_parameter(key)

has_parameter(key)

has_trigger(trigger_name)

Checks if station has a trigger with a certain name. WARNING: This function does not check if the trigger has triggered.

Parameters:

trigger_name: string

the name of the trigger

Returns bool

has_triggered(trigger_name=None)

Checks if the station has triggered. If trigger_name is set, check if the trigger with that name has triggered.

Parameters:

trigger_name: string or None (default None)

• if None: The function returns False if not trigger was set. If one or multiple triggers were set,

  it returns True if any of those triggers triggered

• if trigger name is set: return if the trigger with name ‘trigger_name’ has a trigger

is_cosmic_ray()

is_neutrino()

remove_parameter(key)

remove_triggers()

set_ARIANNA_parameter(key, value)

set_electric_fields(electric_fields)

set_is_cosmic_ray()

set station type to cosmic rays (relevant e.g. for refraction into the snow)

set_is_neutrino()

set station type to neutrino

set_parameter(key, value)

set_parameter_error(key, value)

set_station_time(time, format=None)

Set the (absolute) time for the station (stored as astropy.time.Time). Not related to the event._event_time.

Parameters:

time: astropy.time.Time or datetime.datetime or float

If “time” is a float, you have to specify its format.

format: str

Only used when “time” is a float. Format to interpret “time”. (Default: None)

set_trigger(trigger)

set_triggered(triggered=True)

Convenience function to set a simple trigger. The recommended interface is to set triggers through the set_trigger() interface.