NuRadioReco.detector.RNO_G.rnog_detector_mod module

NuRadioReco.detector.RNO_G.rnog_detector_mod.replace_value_in_dict(d, keys, value)[source]

Replaces the value of a nested dict entry.

Examples

d = {1: {2: {3: 1, 4: 2}}}
replace_value_in_dict(d, [1, 2, 4], 14)
print(d) # {1: {2: {3: 1, 4: 14}}}

class NuRadioReco.detector.RNO_G.rnog_detector_mod.ModDetector(*args, **kwargs)[source]

Bases: Detector

The RNO-G detector description.

Parameters:

database_connectionstr (Default: ‘RNOG_public’): Allows to specify database connection. Passed to mongo-db interface.
log_levellogging.LOG_LEVEL (Default: logging.NOTSET): Overrides verbosity level of logger. Propagates through to Response class logger. Other options are: logging.WARNING, logging.DEBUG, …
over_write_handset_valuesdict (Default: {}): Overwrite the default values for (channel) parameters which are not (yet) implemented in the database. You can not specify keys which already exist in the database. If the value is a dict it should be contain a value for each channel_id (key). (Default: None, the acutally default values for the parameters in question are defined below)
database_timedatetime.datetime or astropy.time.Time: Set database time which is used to select the primary measurement. By default (= None) the database time is set to now (time the code is running) to select the measurement which is now primary.
always_query_entire_descriptionbool (Default: False): If True, query the entire detector describtion all at once when calling Detector.update(…) (if necessary). This value is currently set to False by default to avoid errors due to missing information in the database.
detector_filestr: File to import detector description instead of querying from DB. (Default: None -> query from DB)
select_stationsint or list(int) (Default: None): Select a station or list of stations using their station ids for which the describtion is provided. This is useful for example in simulations when one wants to simulate only one station. The default None means to descibe all commissioned stations.
create_newbool (Default: False): If False, and a database already exists, the existing database will be used rather than initializing a new connection. Set to True to create a new database connection.

Methods

`add_component`(station_id, channel_id, component)	Add an additional component to the response_chain and the corresponding response to the total_response
`add_manual_time_delay`(station_id, ...[, ...])	Add an additional time delay to the signal chain and total response
`add_response`(station_id, channel_id, response)	Add an additional response to the total_response
`export`(filename[, json_kwargs, ...])	Export the buffered detector description.
`export_as_string`([...])	Export the detector description as string using json.dumps
`get_absolute_position`(station_id)	Get the absolute position of a specific station (relative to site)
`get_amplifier_response`(station_id, ...)	Returns the complex response function for the entire signal chain of a channel.
`get_antenna_model`(station_id, channel_id[, ...])
`get_antenna_orientation`(station_id, channel_id)	Returns get_channel_orientation
`get_antenna_type`(station_id, channel_id)	Returns type of antenna, i.e., "VPol" or "HPol" or "LPDA", ...
`get_cable_delay`(station_id, channel_id[, ...])	Same as `get_time_delay`.
`get_channel`(station_id, channel_id)	Returns a dictionary of all channel parameters
`get_channel_ids`(station_id)	Get channel ids for a particlular station.
`get_channel_orientation`(station_id, channel_id)	Returns the orientation of a specific channel/antenna
`get_channel_signal_chain`(station_id, channel_id)
`get_component`([collection, component])	Get the response of a component from the database.
`get_database`()	Returns the database connection
`get_detector_time`()
`get_devices`(station_id)	Get all devices for a particular station.
`get_noise_temperature`(station_id, channel_id)	Get noise temperture per station / channel
`get_number_of_channels`(station_id)	Get number of channels for a particlular station.
`get_number_of_samples`(station_id[, channel_id])	Get number of samples for recorded waveforms
`get_relative_position`(station_id, channel_id)	Get the relative position of a specific channel/antenna with respect to the station center
`get_relative_position_device`(station_id, ...)	Get the relative position of a specific device with respect to the station center
`get_sampling_frequency`(station_id[, ...])	Get sampling frequency per station / channel
`get_signal_chain_components`(station_id, ...)	Returns the names of all components in the signal chain.
`get_signal_chain_response`(station_id, channel_id)	Returns a detector.response.Response object which describes the complex response of the entire signal chain, i.e., the combined reponse of all components of one channel.
`get_site`(station_id)	Returns the site "summit"
`get_site_coordinates`([station_id])	Get the (latitude, longitude) coordinates (in degrees) for the RNO-G detector site.
`get_station`(station_id)	Returns a dictionary of all station parameters/information including some channel information.
`get_station_ids`()	Returns the list of all commissioned stations.
`get_time_delay`(station_id, channel_id[, ...])	Return the sum of the time delay of all components in the signal chain calculated from the phase.
`has_station`(station_id)	Returns true if the station is commission.
`modify_channel_description`(station_id, ...)	This function allows you to replace/modifty the description of a channel.
`modify_station_description`(station_id, keys, ...)	This function allows you to replace/modifty the description of a channel.
`set_channel_position`(station_id, channel_id, ...)	Set the relative position of a channel.
`set_device_position`(station_id, device_id, value)	Set the relative position of a device.
`update`(time)	Updates the detector.

is_channel_noiseless

Notes

For more information about Detector objects in NuRadioMC, see https://nu-radio.github.io/NuRadioMC/NuRadioReco/pages/detector_tree.html

modify_channel_description(station_id, channel_id, keys, value)[source]

This function allows you to replace/modifty the description of a channel.

Parameters:

station_id: int: The station id
channel_id: int: The channel id
keys: list of str: The list of keys of the corresponding part of the description to be changed
value: various types: The value of the description to be changed

get_channel(station_id, channel_id)[source]

Returns a dictionary of all channel parameters

Parameters:

station_id: int: The station id
channel_id: int: The channel id

Returns:

channel_info: dict: Dictionary of channel parameters

modify_station_description(station_id, keys, value)[source]

This function allows you to replace/modifty the description of a channel.

Parameters:

station_id: int: The station id
keys: list of str: The list of keys of the corresponding part of the description to be changed
value: various types: The value of the description to be changed

add_response(station_id, channel_id, response)[source]

Add an additional response to the total_response

Parameters:

station_id: int: The station id
channel_id: int: The channel id
response: response.Response: A response object to be added to the total_response

add_component(station_id, channel_id, component)[source]

Add an additional component to the response_chain and the corresponding response to the total_response

Parameters:

station_id: int: The station id
channel_id: int: The channel id
componennt: dict: A dictionary with the properties of the component to be added

add_manual_time_delay(station_id, channel_id, time_delay, weight=1, name='MOD_manual_time_delay')[source]

Add an additional time delay to the signal chain and total response

Parameters:

station_id: int: The station id
channel_id: int: The channel id
time_delay: float: The manual time delay to be added
weight: float (default: 1): The weight of the time delay in the total response (either 1 or -1)
name: str (default: “MOD_manual_time_delay”): The name of the component to be added

set_channel_position(station_id, channel_id, value)[source]

Set the relative position of a channel.

Parameters:

station_id: int: The station id
channel_id: int: The channel id
value: array/list of float: The relative position of the channel

set_device_position(station_id, device_id, value)[source]

Set the relative position of a device.

Parameters:

station_id: int: The station id
device_id: int: The device id
value: array/list of float: The relative position of the channel

export(filename, json_kwargs=None, additional_data=None, drop_response_data=False, comment=None)

Export the buffered detector description.

Parameters:

filename: str: Filename of the exported detector description
json_kwargs: dict: Arguments passed to json.dumps(..). (Default: None -> dict(indent=0, default=_json_serial))
additional_data: dict (Default: None): If specified the content of this dict will be added to the exported detector description.
drop_response_data: bool (Default: False): If True, the response data (frequency, mag, phase) will be dropped from the exported detector description.
comment: str (Default: None): An optional comment describing this detector that will be added to the exported detector description.

export_as_string(skip_signal_chain_response=True, dumps_kwargs=None)

Export the detector description as string using json.dumps

Parameters:

skip_signal_chain_response: bool: If true drop the data of the response chain from the detector description (because this creates large files). (Default: True)
dumps_kwargs: dict: Arguments passed to json.dumps(..). (Default: None -> dict(indent=4, default=str))

get_absolute_position(station_id)

Get the absolute position of a specific station (relative to site)

Parameters:

station_id: int: the station id

Returns:

pos: np.array(3,): 3-dim array of absolute station position in easting, northing and depth wrt. to snow level at time of measurement

get_amplifier_response(station_id, channel_id, frequencies)

Returns the complex response function for the entire signal chain of a channel.

This includes not only the (main) amplifier but also cables and other components. Note that while group delays are appropriately accounted for, an overall time delay (mostly due to cable delay) has been removed and is instead accounted for by get_time_delay.

Parameters:

station_id: int: The station id
channel_id: int: The channel id
frequencies: array of floats: Array of frequencies for which the response is returned

Returns:

response: array of complex floats: Complex response function