Source code for NuRadioReco.detector.detector_base

import numpy as np
from NuRadioReco.utilities import units
import NuRadioReco.detector.RNO_G.analog_components
import NuRadioReco.detector.ARIANNA.analog_components
from radiotools import helper as hp
import os
import logging
from tinydb import TinyDB, Query
from tinydb_serialization import SerializationMiddleware
from tinydb.storages import MemoryStorage
import astropy.time
from datetime import datetime
from tinydb_serialization import Serializer
import six  # # used for compatibility between py2 and py3
import warnings
from astropy.utils.exceptions import ErfaWarning
import NuRadioReco.utilities.metaclasses

logger = logging.getLogger('NuRadioReco.detector')
warnings.filterwarnings('ignore', category=ErfaWarning)


[docs]class DateTimeSerializer(Serializer): """ helper class to serialize datetime objects with TinyDB """ OBJ_CLASS = datetime # The class this serializer handles
[docs] def encode(self, obj): return obj.strftime('%Y-%m-%dT%H:%M:%S')
[docs] def decode(self, s): return datetime.strptime(s, '%Y-%m-%dT%H:%M:%S')
[docs]def buffer_db(in_memory, filename=None): """ buffers the complete SQL database into a TinyDB object (either in memory or into a local JSON file) Parameters ---------- in_memory: bool if True: the mysql database will be buffered as a tiny tb object that only exists in memory if False: the mysql database will be buffered as a tiny tb object and saved in a local json file filename: string only relevant if `in_memory = True`: the filename of the json file of the tiny db object """ serialization = SerializationMiddleware() serialization.register_serializer(DateTimeSerializer(), 'TinyDate') logger.info("buffering SQL database on-the-fly") if in_memory: db = TinyDB(storage=MemoryStorage) else: db = TinyDB(filename, storage=serialization, sort_keys=True, indent=4, separators=(',', ': ')) db.truncate() from NuRadioReco.detector import detector_sql sqldet = detector_sql.Detector() results = sqldet.get_everything_stations() table_stations = db.table('stations') table_stations.truncate() for result in results: table_stations.insert({'station_id': result['st.station_id'], 'commission_time': result['st.commission_time'], 'decommission_time': result['st.decommission_time'], 'station_type': result['st.station_type'], 'position': result['st.position'], 'board_number': result['st.board_number'], 'MAC_address': result['st.MAC_address'], 'MBED_type': result['st.MBED_type'], 'pos_position': result['pos.position'], 'pos_measurement_time': result['pos.measurement_time'], 'pos_easting': result['pos.easting'], 'pos_northing': result['pos.northing'], 'pos_altitude': result['pos.altitude'], 'pos_zone': result['pos.zone'], 'pos_site': result['pos.site']}) table_channels = db.table('channels') table_channels.truncate() results = sqldet.get_everything_channels() for channel in results: table_channels.insert({'station_id': channel['st.station_id'], 'channel_id': channel['ch.channel_id'], 'commission_time': channel['ch.commission_time'], 'decommission_time': channel['ch.decommission_time'], 'ant_type': channel['ant.antenna_type'], 'ant_orientation_phi': channel['ant.orientation_phi'], 'ant_orientation_theta': channel['ant.orientation_theta'], 'ant_rotation_phi': channel['ant.rotation_phi'], 'ant_rotation_theta': channel['ant.rotation_theta'], 'ant_position_x': channel['ant.position_x'], 'ant_position_y': channel['ant.position_y'], 'ant_position_z': channel['ant.position_z'], 'ant_deployment_time': channel['ant.deployment_time'], 'ant_comment': channel['ant.comment'], 'cab_length': channel['cab.cable_length'], 'cab_reference_measurement': channel['cab.reference_measurement'], 'cab_time_delay': channel['cab.time_delay'], 'cab_id': channel['cab.cable_id'], 'cab_type': channel['cab.cable_type'], 'amp_type': channel['amps.amp_type'], 'amp_reference_measurement': channel['amps.reference_measurement'], 'adc_id': channel['adcs.adc_id'], 'adc_time_delay': channel['adcs.time_delay'], 'adc_nbits': channel['adcs.nbits'], 'adc_n_samples': channel['adcs.n_samples'], 'adc_sampling_frequency': channel['adcs.sampling_frequency']}) results = sqldet.get_everything_positions() table_positions = db.table('positions') table_positions.truncate() for result in results: table_positions.insert({ 'pos_position': result['pos.position'], 'pos_measurement_time': result['pos.measurement_time'], 'pos_easting': result['pos.easting'], 'pos_northing': result['pos.northing'], 'pos_altitude': result['pos.altitude'], 'pos_zone': result['pos.zone'], 'pos_site': result['pos.site']}) logger.info("sql database buffered") return db
[docs]@six.add_metaclass(NuRadioReco.utilities.metaclasses.Singleton) class DetectorBase(object): """ main detector class which provides access to the detector description This class provides functions for all relevant detector properties. """ def __init__(self, source='json', json_filename='ARIANNA/arianna_detector_db.json', dictionary=None, assume_inf=True, antenna_by_depth=True): """ Initialize the stations detector properties. By default, a new detector instance is only created of none exists yet, otherwise the existing instance is returned. To force the creation of a new detector instance, pass the additional keyword parameter `create_new=True` to this function. For more details, check the documentation for the `Singleton metaclass <NuRadioReco.utilities.html#NuRadioReco.utilities.metaclasses.Singleton>`_. Parameters ---------- source : str 'json', 'dictionary' or 'sql' default value is 'json' if dictionary is specified, the dictionary passed to __init__ is used if 'sql' is specified, the file 'detector_sql_auth.json' file needs to be present in this folder that specifies the sql server credentials (see 'detector_sql_auth.json.sample' for an example of the syntax) json_filename : str the path to the json detector description file (if first checks a path relative to this directory, then a path relative to the current working directory of the user) default value is 'ARIANNA/arianna_detector_db.json' assume_inf : Bool Default to True, if true forces antenna models to have infinite boundary conditions, otherwise the antenna madel will be determined by the station geometry. antenna_by_depth: bool (default True) if True the antenna model is determined automatically depending on the depth of the antenna. This is done by appending e.g. '_InfFirn' to the antenna model name. if False, the antenna model as specified in the database is used. create_new: bool (default:False) Can be used to force the creation of a new detector object. By default, the __init__ will only create a new object if none already exists. """ self._serialization = SerializationMiddleware() self._serialization.register_serializer(DateTimeSerializer(), 'TinyDate') if source == 'sql': self._db = buffer_db(in_memory=True) elif source == 'dictionary': self._db = TinyDB(storage=MemoryStorage) self._db.truncate() stations_table = self._db.table('stations', cache_size=1000) for station in dictionary['stations'].values(): stations_table.insert(station) channels_table = self._db.table('channels', cache_size=1000) for channel in dictionary['channels'].values(): channels_table.insert(channel) else: self._db = TinyDB( json_filename, storage=self._serialization, sort_keys=True, indent=4, separators=(',', ': ') ) self._stations = self._db.table('stations', cache_size=1000) self._channels = self._db.table('channels', cache_size=1000) self._devices = self._db.table('devices', cache_size=1000) self.__positions = self._db.table('positions', cache_size=1000) logger.info("database initialized") self._buffered_stations = {} self.__buffered_positions = {} self._buffered_channels = {} self._buffered_devices = {} self.__valid_t0 = astropy.time.Time('2100-1-1') self.__valid_t1 = astropy.time.Time('1970-1-1') self.__noise_RMS = None self.__current_time = None self.__assume_inf = assume_inf if antenna_by_depth: logger.info("the correct antenna model will be determined automatically based on the depth of the antenna") self._antenna_by_depth = antenna_by_depth @property def assume_inf(self): """ Getter function for the `assume_inf` attribute """ return self.__assume_inf @assume_inf.setter def assume_inf(self, value): """ Setter function for the `assume_inf` attribute. Checks whether new value is boolean before assigning the value to the attribute. """ if isinstance(value, bool): self.__assume_inf = value else: raise ValueError(f"Value for assume_inf should be boolean, not {type(value)}") @property def antenna_by_depth(self): """ Getter function for the `antenna_by_depth` attribute """ return self._antenna_by_depth @antenna_by_depth.setter def antenna_by_depth(self, value): """ Setter function for the `antenna_by_depth` attribute. Checks whether new value is boolean before assigning the value to the attribute. """ if isinstance(value, bool): self.__assume_inf = value else: raise ValueError(f"Value for antenna_by_depth should be boolean, not {type(value)}") def __query_channel(self, station_id, channel_id): Channel = Query() if self.__current_time is None: raise ValueError( "Detector time is not set. The detector time has to be set using the Detector.update() function before it can be used.") res = self._channels.get((Channel.station_id == station_id) & (Channel.channel_id == channel_id) & (Channel.commission_time <= self.__current_time.datetime) & (Channel.decommission_time > self.__current_time.datetime)) if res is None: logger.error( "query for station {} and channel {} at time {} returned no results".format(station_id, channel_id, self.__current_time)) raise LookupError return res def _query_channels(self, station_id): Channel = Query() if self.__current_time is None: raise ValueError( "Detector time is not set. The detector time has to be set using the Detector.update() function before it can be used.") return self._channels.search((Channel.station_id == station_id) & (Channel.commission_time <= self.__current_time.datetime) & (Channel.decommission_time > self.__current_time.datetime)) def _query_devices(self, station_id): Device = Query() if self.__current_time is None: raise ValueError( "Detector time is not set. The detector time has to be set using the Detector.update() function before it can be used.") return self._devices.search((Device.station_id == station_id) & (Device.commission_time <= self.__current_time.datetime) & (Device.decommission_time > self.__current_time.datetime)) def _query_station(self, station_id): Station = Query() if self.__current_time is None: raise ValueError( "Detector time is not set. The detector time has to be set using the Detector.update() function before it can be used.") res = self._stations.get((Station.station_id == station_id) & (Station.commission_time <= self.__current_time.datetime) & (Station.decommission_time > self.__current_time.datetime)) if res is None: logger.error( "query for station {} at time {} returned no results".format(station_id, self.__current_time.datetime)) raise LookupError( "query for station {} at time {} returned no results".format(station_id, self.__current_time.datetime)) return res def __query_position(self, position_id): Position = Query() res = self.__positions.get((Position.pos_position == position_id)) if self.__current_time is None: raise ValueError( "Detector time is not set. The detector time has to be set using the Detector.update() function before it can be used.") if res is None: logger.error("query for position {} at time {} returned no results".format(position_id, self.__current_time.datetime)) raise LookupError("query for position {} at time {} returned no results".format(position_id, self.__current_time.datetime)) return res
[docs] def get_station_ids(self): """ returns a sorted list of all station ids present in the database """ station_ids = [] res = self._stations.all() if res is None: logger.error("query for stations returned no results") raise LookupError("query for stations returned no results") for a in res: if a['station_id'] not in station_ids: station_ids.append(a['station_id']) return sorted(station_ids)
def _get_station(self, station_id): if station_id not in self._buffered_stations.keys(): self._buffer(station_id) return self._buffered_stations[station_id]
[docs] def get_station(self, station_id): return self._get_station(station_id)
def __get_position(self, position_id): if position_id not in self.__buffered_positions.keys(): self.__buffer_position(position_id) return self.__buffered_positions[position_id] def __get_channels(self, station_id): if station_id not in self._buffered_stations.keys(): self._buffer(station_id) return self._buffered_channels[station_id] def __get_channel(self, station_id, channel_id): if station_id not in self._buffered_stations.keys(): self._buffer(station_id) return self._buffered_channels[station_id][channel_id] def __get_devices(self, station_id): if station_id not in self._buffered_stations.keys(): self._buffer(station_id) return self._buffered_devices[station_id] def __get_device(self, station_id, device_id): if station_id not in self._buffered_stations.keys(): self._buffer(station_id) return self._buffered_devices[station_id][device_id] def _buffer(self, station_id): self._buffered_stations[station_id] = self._query_station(station_id) self.__valid_t0 = astropy.time.Time(self._buffered_stations[station_id]['commission_time']) self.__valid_t1 = astropy.time.Time(self._buffered_stations[station_id]['decommission_time']) channels = self._query_channels(station_id) self._buffered_channels[station_id] = {} for channel in channels: self._buffered_channels[station_id][channel['channel_id']] = channel self.__valid_t0 = max(self.__valid_t0, astropy.time.Time(channel['commission_time'])) self.__valid_t1 = min(self.__valid_t1, astropy.time.Time(channel['decommission_time'])) devices = self._query_devices(station_id) self._buffered_devices[station_id] = {} for device in devices: self._buffered_devices[station_id][device['device_id']] = device self.__valid_t0 = max(self.__valid_t0, astropy.time.Time(channel['commission_time'])) self.__valid_t1 = min(self.__valid_t1, astropy.time.Time(channel['decommission_time'])) def __buffer_position(self, position_id): self.__buffered_positions[position_id] = self.__query_position(position_id) def __get_t0_t1(self, station_id): Station = Query() res = self._stations.get(Station.station_id == station_id) t0 = None t1 = None if isinstance(res, list): for station in res: if t0 is None: t0 = station['commission_time'] else: t0 = min(t0, station['commission_time']) if t1 is None: t1 = station['decommission_time'] else: t1 = max(t1, station['decommission_time']) else: t0 = res['commission_time'] t1 = res['decommission_time'] return astropy.time.Time(t0), astropy.time.Time(t1)
[docs] def has_station(self, station_id): """ checks if a station is present in the database Parameters ---------- station_id: int the station id Returns bool """ Station = Query() res = self._stations.get(Station.station_id == station_id) return res is not None
[docs] def get_unique_time_periods(self, station_id): """ returns the time periods in which the station configuration (including all channels) was constant Parameters ---------- station_id: int the station id Returns datetime tuple """ up = [] t0, t1 = self.__get_t0_t1(station_id) self.update(t0) while True: if len(up) > 0 and up[-1] == t1: break self._buffer(station_id) if len(up) == 0: up.append(self.__valid_t0) up.append(self.__valid_t1) self.update(self.__valid_t1) return up
[docs] def update(self, time): """ updates the detector description to a new time Parameters ---------- time: astropy.time.Time the time to update the detector description to for backward compatibility datetime is also accepted, but astropy.time is prefered """ if isinstance(time, datetime): self.__current_time = astropy.time.Time(time) else: self.__current_time = time logger.info("updating detector time to {}".format(self.__current_time)) if not ((self.__current_time > self.__valid_t0) and (self.__current_time < self.__valid_t1)): self._buffered_stations = {} self._buffered_channels = {} self.__valid_t0 = astropy.time.Time('2100-1-1') self.__valid_t1 = astropy.time.Time('1970-1-1')
[docs] def get_detector_time(self): """ Returns the time that the detector is currently set to """ return self.__current_time
[docs] def get_channel(self, station_id, channel_id): """ returns a dictionary of all channel parameters Parameters ---------- station_id: int the station id channel_id: int the channel id Returns ------- dict of channel parameters """ return self.__get_channel(station_id, channel_id)
[docs] def get_device(self, station_id, device_id): """ returns a dictionary of all device parameters Parameters ---------- station_id: int the station id device_id: int the device id Returns ------- dict of device parameters """ return self.__get_device(station_id, device_id)
[docs] def get_absolute_position(self, station_id): """ get the absolute position of a specific station Parameters ---------- station_id: int the station id Returns ------- 3-dim array of absolute station position in easting, northing and depth wrt. to snow level at time of measurement """ res = self._get_station(station_id) easting, northing, altitude = 0, 0, 0 unit_xy = units.m if 'pos_zone' in res and res['pos_zone'] == "SP-grid": unit_xy = units.feet if res['pos_easting'] is not None: easting = res['pos_easting'] * unit_xy if res['pos_northing'] is not None: northing = res['pos_northing'] * unit_xy if res['pos_altitude'] is not None: altitude = res['pos_altitude'] return np.array([easting, northing, altitude])
[docs] def get_absolute_position_site(self, site): """ get the absolute position of a specific station Parameters ---------- site: string the position identifier e.g. "G" Returns ------- 3-dim array of absolute station position in easting, northing and depth wrt. to snow level at time of measurement """ res = self.__get_position(site) unit_xy = units.m if 'pos_zone' in res and res['pos_zone'] == "SP-grid": unit_xy = units.feet easting, northing, altitude = 0, 0, 0 if res['pos_easting'] is not None: easting = res['pos_easting'] * unit_xy if res['pos_northing'] is not None: northing = res['pos_northing'] * unit_xy if res['pos_altitude'] is not None: altitude = res['pos_altitude'] * units.m return np.array([easting, northing, altitude])
[docs] def get_relative_position(self, station_id, channel_id, mode = 'channel'): """ get the relative position of a specific channels/antennas with respect to the station center Parameters ---------- station_id: int the station id channel_id: int the channel id mode_id: str specify if relative position of a channel or a device is asked for Returns ------- 3-dim array of relative station position """ if mode == 'channel': res = self.__get_channel(station_id, channel_id) elif mode == 'device': res = self.__get_device(station_id, channel_id) else: logger.error("Mode {} does not exist. Use 'channel' or 'device'".format(mode)) raise NameError return np.array([res['ant_position_x'], res['ant_position_y'], res['ant_position_z']])
[docs] def get_site(self, station_id): """ get the site where the station is deployed (e.g. MooresBay or South Pole) Parameters ---------- station_id: int the station id Returns string """ res = self._get_station(station_id) return res['pos_site']
[docs] def get_site_coordinates(self, station_id): """ get the (latitude, longitude) coordinates (in degrees) for a given detector site. Parameters ---------- station_id: int the station ID """ sites = { 'auger': (-35.10, -69.55), 'mooresbay': (-78.74, 165.09), 'southpole': (-90., 0.), 'summit': (72.57, -38.46), 'lofar': (52.92, 6.87) } site = self.get_site(station_id) if site in sites.keys(): return sites[site] return (None, None)
[docs] def get_number_of_channels(self, station_id): """ Get the number of channels per station Parameters ---------- station_id: int the station id Returns int """ res = self.__get_channels(station_id) return len(res)
[docs] def get_channel_ids(self, station_id): """ get the channel ids of a station Parameters ---------- station_id: int the station id Returns list of ints """ channel_ids = [] for channel in self.__get_channels(station_id).values(): channel_ids.append(channel['channel_id']) return sorted(channel_ids)
[docs] def get_parallel_channels(self, station_id): """ get a list of parallel antennas Parameters ---------- station_id: int the station id Returns list of list of ints """ res = self.__get_channels(station_id) orientations = np.zeros((len(res), 4)) antenna_types = [] channel_ids = [] for iCh, ch in enumerate(res.values()): channel_id = ch['channel_id'] channel_ids.append(channel_id) antenna_types.append(self.get_antenna_type(station_id, channel_id)) orientations[iCh] = self.get_antenna_orientation(station_id, channel_id) orientations[iCh][3] = hp.get_normalized_angle(orientations[iCh][3], interval=np.deg2rad([0, 180])) channel_ids = np.array(channel_ids) antenna_types = np.array(antenna_types) orientations = np.round(np.rad2deg(orientations)) # round to one degree to overcome rounding errors parallel_antennas = [] for antenna_type in np.unique(antenna_types): for u_zen_ori in np.unique(orientations[:, 0]): for u_az_ori in np.unique(orientations[:, 1]): for u_zen_rot in np.unique(orientations[:, 2]): for u_az_rot in np.unique(orientations[:, 3]): mask = (antenna_types == antenna_type) \ & (orientations[:, 0] == u_zen_ori) & (orientations[:, 1] == u_az_ori) \ & (orientations[:, 2] == u_zen_rot) & (orientations[:, 3] == u_az_rot) if np.sum(mask): parallel_antennas.append(channel_ids[mask]) return np.array(parallel_antennas)
[docs] def get_number_of_devices(self, station_id): """ Get the number of devices per station Parameters ---------- station_id: int the station id Returns int """ res = self.__get_devices(station_id) return len(res)
[docs] def get_device_ids(self, station_id): """ get the device ids of a station Parameters ---------- station_id: int the station id Returns list of ints """ device_ids = [] for device in self.__get_devices(station_id).values(): device_ids.append(device['device_id']) return sorted(device_ids)
[docs] def get_cable_delay(self, station_id, channel_id): """ returns the cable delay of a channel Parameters ---------- station_id: int the station id channel_id: int the channel id Returns float (delay time) """ res = self.__get_channel(station_id, channel_id) if 'cab_time_delay' not in res.keys(): logger.warning( 'Cable delay not set for channel {} in station {}, assuming cable delay is zero'.format( channel_id, station_id)) return 0 else: return res['cab_time_delay']
[docs] def get_cable_type_and_length(self, station_id, channel_id): """ returns the cable type (e.g. LMR240) and its length Parameters ---------- station_id: int the station id channel_id: int the channel id Returns tuple (string, float) """ res = self.__get_channel(station_id, channel_id) return res['cab_type'], res['cab_length'] * units.m
[docs] def get_antenna_type(self, station_id, channel_id): """ returns the antenna type Parameters ---------- station_id: int the station id channel_id: int the channel id Returns string """ res = self.__get_channel(station_id, channel_id) return res['ant_type']
[docs] def get_antenna_deployment_time(self, station_id, channel_id): """ returns the time of antenna deployment Parameters ---------- station_id: int the station id channel_id: int the channel id Returns datetime """ res = self.__get_channel(station_id, channel_id) return res['ant_deployment_time']
[docs] def get_antenna_orientation(self, station_id, channel_id): """ returns the orientation of a specific antenna Parameters ---------- station_id: int the station id channel_id: int the channel id Returns ------- tuple of floats * orientation theta: orientation of the antenna, as a zenith angle (0deg is the zenith, 180deg is straight down); for LPDA: outward along boresight; for dipoles: upward along axis of azimuthal symmetry * orientation phi: orientation of the antenna, as an azimuth angle (counting from East counterclockwise); for LPDA: outward along boresight; for dipoles: upward along axis of azimuthal symmetry * rotation theta: rotation of the antenna, is perpendicular to 'orientation', for LPDAs: vector perpendicular to the plane containing the the tines * rotation phi: rotation of the antenna, is perpendicular to 'orientation', for LPDAs: vector perpendicular to the plane containing the the tines """ res = self.__get_channel(station_id, channel_id) return np.deg2rad([res['ant_orientation_theta'], res['ant_orientation_phi'], res['ant_rotation_theta'], res['ant_rotation_phi']])
[docs] def get_amplifier_type(self, station_id, channel_id): """ returns the type of the amplifier Parameters ---------- station_id: int the station id channel_id: int the channel id Returns string """ res = self.__get_channel(station_id, channel_id) return res['amp_type']
[docs] def get_amplifier_measurement(self, station_id, channel_id): """ returns a unique reference to the amplifier measurement Parameters ---------- station_id: int the station id channel_id: int the channel id Returns string """ res = self.__get_channel(station_id, channel_id) return res['amp_reference_measurement']
[docs] def get_amplifier_response(self, station_id, channel_id, frequencies): """ Returns the amplifier response for the amplifier of a given channel Parameters ---------- station_id: int The ID of the station channel_id: int The ID of the channel frequencies: array of floats The frequency array for which the amplifier response shall be returned """ res = self.__get_channel(station_id, channel_id) amp_type = None if 'amp_type' in res.keys(): amp_type = res['amp_type'] if amp_type is None: raise ValueError( 'Amplifier type for station {}, channel {} not in detector description'.format( station_id, channel_id )) amp_response_functions = None if amp_type in NuRadioReco.detector.RNO_G.analog_components.get_available_amplifiers(): amp_response_functions = NuRadioReco.detector.RNO_G.analog_components.load_amp_response(amp_type) if amp_type in NuRadioReco.detector.ARIANNA.analog_components.get_available_amplifiers(): if amp_response_functions is not None: raise ValueError('Amplifier name {} is not unique'.format(amp_type)) amp_response_functions = NuRadioReco.detector.ARIANNA.analog_components.load_amplifier_response(amp_type) if amp_response_functions is None: raise ValueError('Amplifier of type {} not found'.format(amp_type)) amp_gain = amp_response_functions['gain'](frequencies) amp_phase = amp_response_functions['phase'](frequencies) return amp_gain * amp_phase
[docs] def get_sampling_frequency(self, station_id, channel_id): """ returns the sampling frequency Parameters ---------- station_id: int the station id channel_id: int the channel id Returns float """ res = self.__get_channel(station_id, channel_id) return res['adc_sampling_frequency'] * units.GHz
[docs] def get_number_of_samples(self, station_id, channel_id): """ returns the number of samples of a channel Parameters ---------- station_id: int the station id channel_id: int the channel id Returns int """ res = self.__get_channel(station_id, channel_id) return res['adc_n_samples']
[docs] def get_antenna_model(self, station_id, channel_id, zenith=None): """ determines the correct antenna model from antenna type, position and orientation of antenna so far only infinite firn and infinite air cases are differentiated Parameters ---------- station_id: int the station id channel_id: int the channel id zenith: float or None (default) the zenith angle of the incoming signal direction Returns string """ antenna_type = self.get_antenna_type(station_id, channel_id) antenna_relative_position = self.get_relative_position(station_id, channel_id) if self._antenna_by_depth: if zenith is not None and (antenna_type == 'createLPDA_100MHz'): if antenna_relative_position[2] > 0: antenna_model = "{}_InfAir".format(antenna_type) if (not self.__assume_inf) and zenith < 90 * units.deg: antenna_model = "{}_z1cm_InAir_RG".format(antenna_type) else: # antenna in firn antenna_model = "{}_InfFirn".format(antenna_type) if (not self.__assume_inf) and zenith > 90 * units.deg: # signal comes from below antenna_model = "{}_z1cm_InFirn_RG".format(antenna_type) # we need to add further distinction here elif not antenna_type.startswith('analytic'): if antenna_relative_position[2] > 0: antenna_model = "{}_InfAir".format(antenna_type) else: antenna_model = "{}_InfFirn".format(antenna_type) else: antenna_model = antenna_type else: antenna_model = antenna_type return antenna_model
[docs] def get_channel_group_id(self, station_id, channel_id): """ returns the group ID of a channel. If the channel has no group ID, the channel ID is returned. Parameters ---------- station_id: int the station id channel_id: int the channel id Returns ------- group_id : int the channel group ID """ res = self.__get_channel(station_id, channel_id) if 'channel_group_id' not in res: logger.info( 'Channel group ID not set for channel {} in station {}, returning channel_id'.format( channel_id, station_id)) return channel_id else: return res['channel_group_id']
[docs] def get_noise_RMS(self, station_id, channel_id, stage='amp'): """ returns the noise RMS that was precomputed from forced triggers Parameters ---------- station_id: int station id channel_id: int the channel id, not used at the moment, only station averages are computed stage: string (default 'amp') specifies the stage of reconstruction you want the noise RMS for, `stage` can be one of * 'raw' (raw measured trace) * 'amp' (after the amp was deconvolved) * 'filt' (after the trace was highpass with 100MHz Returns ------- RMS: float the noise RMS (actually it is the standard deviation but as the mean should be zero its the same) """ if self.__noise_RMS is None: import json detector_directory = os.path.dirname(os.path.abspath(__file__)) with open(os.path.join(detector_directory, 'noise_RMS.json'), 'r') as fin: self.__noise_RMS = json.load(fin) key = "{:d}".format(station_id) if key not in self.__noise_RMS.keys(): rms = self.__noise_RMS['default'][stage] logger.warning( "no RMS values for station {} available, returning default noise for stage {}: RMS={:.2g} mV".format( station_id, stage, rms / units.mV)) return rms return self.__noise_RMS[key][stage]
[docs] def get_noise_temperature(self, station_id, channel_id): """ returns the noise temperature of the channel Parameters ---------- station_id: int station id channel_id: int the channel id """ res = self.__get_channel(station_id, channel_id) if 'noise_temperature' not in res: raise AttributeError( f"field noise_temperature not present in detector description of station {station_id} and channel {channel_id}") return res['noise_temperature']
[docs] def is_channel_noiseless(self, station_id, channel_id): """ returns true if the detector description has the field `noiseless` and if this field is True. Allows to run a noiseless simulation on specific channels (for example to simulate a single-antenna proxy along with the phased array) Parameters ---------- station_id: int station id channel_id: int the channel id """ res = self.__get_channel(station_id, channel_id) if 'noiseless' not in res: return False return res['noiseless']