NuRadioReco.framework.base_station module

class NuRadioReco.framework.base_station.BaseStation(station_id)

Bases: object

Methods

get_ARIANNA_parameter(key)
get_electric_field_ids()	returns a sorted list with the electric field IDs of all simElectricFields of the simStation
get_first_trigger()	Returns the first/earliest trigger.
get_primary_trigger()	Returns the primary trigger of the station.
get_station_time([format])	Returns a astropy.time.Time object
get_station_time_dict()	Return the station time as dict {value, format}.
get_trigger(name)	returns the trigger with the name 'name'
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.
remove_triggers()	removes all triggers from the station
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_trigger(trigger)	sets a trigger for the station.
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_parameter
get_parameter_error
get_parameters
has_ARIANNA_parameter
has_parameter
is_cosmic_ray
is_neutrino
remove_parameter
serialize
set_ARIANNA_parameter
set_electric_fields
set_parameter
set_parameter_error

get_parameter(key)

get_parameters()

has_parameter(key)

set_parameter(key, value)

set_parameter_error(key, value)

get_parameter_error(key)

remove_parameter(key)

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)

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_id()

remove_triggers()

removes all triggers from the station

get_trigger(name)

returns the trigger with the name ‘name’

Parameters:

name: string

the name of the trigger

Returns:

trigger: Trigger

get_primary_trigger()

Returns the primary trigger of the station. If no primary trigger exists, it returns None

get_first_trigger()

Returns the first/earliest trigger. Returns None if no trigger fired.

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

get_triggers()

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

set_trigger(trigger)

sets a trigger for the station. If a trigger with the same name already exists, it will be overridden

Parameters:

trigger: Trigger

the trigger object to set

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

set_triggered(triggered=True)

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

set_electric_fields(electric_fields)

get_electric_fields()

get_electric_field_ids()

returns a sorted list with the electric field IDs of all simElectricFields of the simStation

Returns:

efield_ids: list

add_electric_field(electric_field)

get_electric_fields_for_channels(channel_ids=None, ray_path_type=None)

is_neutrino()

is_cosmic_ray()

set_is_neutrino()

set station type to neutrino

set_is_cosmic_ray()

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

get_ARIANNA_parameter(key)

get_ARIANNA_parameters()

has_ARIANNA_parameter(key)

set_ARIANNA_parameter(key, value)

serialize(save_efield_traces)

deserialize(data_pkl)