NuRadioReco.framework.sim_station module

class NuRadioReco.framework.sim_station.SimStation(station_id)[source]

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_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_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_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.
`is_candidate`()	Returns whether the station is a candidate for producing a trigger.
`remove_triggers`()	removes all triggers from the station
`set_candidate`(candidate_status)	Set the candidate for the simulation 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_magnetic_field_vector
get_parameter
get_parameter_error
get_parameters
get_simulation_weight
has_ARIANNA_parameter
has_parameter
is_cosmic_ray
is_neutrino
iter_channels
remove_parameter
serialize
set_ARIANNA_parameter
set_electric_fields
set_magnetic_field_vector
set_parameter
set_parameter_error
set_simulation_weight

set_candidate(candidate_status)[source]

Set the candidate for the simulation station. True means the station is a candidate for producing a trigger.

Parameters:

candidate_statusbool: If the station is a candidate for producing a trigger.

Returns:

None

is_candidate()[source]

Returns whether the station is a candidate for producing a trigger.

Returns:

bool: True if the station is a candidate for producing a trigger, False otherwise.

get_magnetic_field_vector()[source]

set_magnetic_field_vector(magnetic_field_vector)[source]

get_simulation_weight()[source]

set_simulation_weight(simulation_weight)[source]

iter_channels()[source]

add_channel(channel)[source]: adds a NuRadioReco.framework.sim_channel to the SimStation object

get_channel(unique_identifier)[source]: returns channel identified by the triple (channel_id, shower_id, ray_tracing_id)

get_channel_ids()[source]: returns a list with the channel IDs of all simChannels of the simStation

get_shower_ids()[source]: returns a list with the shower IDs of all simChannels of the simStation

get_ray_tracing_ids()[source]: returns a list with the raytracing IDs of all simChannels of the simStation

get_channels_by_channel_id(channel_id)[source]: returns all simChannels that have the given channel_id

get_channels_by_shower_id(shower_id)[source]: returns all simChannels that have the given shower_id

get_channels_by_ray_tracing_id(ray_tracing_id)[source]: returns all simChannels that have the given ray_tracing_id

serialize(save_channel_traces, save_efield_traces)[source]

deserialize(data_pkl)[source]

add_electric_field(electric_field)

get_ARIANNA_parameter(key)

get_ARIANNA_parameters()

get_electric_field_ids()

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

Returns:

efield_ids: list

get_electric_fields()

get_electric_fields_for_channels(channel_ids=None, ray_path_type=None)

get_first_trigger(): Returns the first/earliest trigger. Returns None if no trigger fired.

get_id()

get_parameter(key)

get_parameter_error(key)

get_parameters()

get_primary_trigger(): Returns the primary trigger of the station. If no primary trigger exists, it returns 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_trigger(name)

returns the trigger with the name ‘name’

Parameters:

name: string: the name of the trigger

Returns:

trigger: Trigger

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(): removes all triggers from the station

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)

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

set_triggered(triggered=True): Convenience function to set a simple trigger. The recommended interface is to set triggers through the set_trigger() interface.