Further LOFAR development

NuRadioReco/detector/LOFAR/README.md

@@ -0,0 +1,3 @@
+The signalchain folder contains cable attenuation and RCU gains. The RCU gain contains the gain of the RCU in dB, one value for every frequency in the 30-80MHz band.
+The cable attenuation files (one for each cable length) contain the frequency in MHz and the attenuation in dB (careful with the sign).
+The cable lengths for station 11, 28 and 201 are all set to 80.0 (careful here!) as the files containing their true lengths are missing. This will be changed as soon as the corresponding files are found.

NuRadioReco/detector/LOFAR/analog_components.py

@@ -0,0 +1,78 @@
+import numpy as np
+import os
+import logging
+from NuRadioReco.utilities import units
+from scipy.interpolate import interp1d
+from radiotools import helper as hp
+
+logger = logging.getLogger("NuRadioReco.LOFAR_analog_components")
+
+
+def load_cable_response(cable_length):
+    """
+    Parameters
+    ----------
+    path: string
+        Path to the folder containing the cable response
+    cable_length: int
+        length of the coax cable of the corresponding channel
+    """
+    module_dir = os.path.dirname(__file__)
+    file_path = os.path.join(module_dir, "signalchain", f"attenuation_RG58_{cable_length}m.txt")
+
+    data = np.loadtxt(file_path)
+
+    default = {}
+    default['frequencies'] = np.arange(30,81) * units.MHz
+    default['attenuation'] = -1*data  #data is in dB
+    return default
+
+def get_cable_response(frequencies, cable_length):
+
+    cable_response = {}
+    cable_response['default'] = load_cable_response(cable_length=cable_length)
+
+    orig_frequencies = cable_response['default']['frequencies']
+    gain = cable_response['default']['attenuation']
+
+    interp_gain = interp1d(orig_frequencies, gain[:,1], bounds_error=False, fill_value=0)
+
+    cable = {}
+    cable['attenuation'] = interp_gain(frequencies)
+    return cable
+
+
+def load_RCU_response():
+    """
+    Parameters
+    ----------
+    path: string
+        Path to the folder containing the RCU response
+    """
+
+    module_dir = os.path.dirname(__file__)
+    file_path = os.path.join(module_dir, "signalchain/RCU_gain_new_5.txt")
+
+    data = np.loadtxt(file_path)
+
+    default = {}
+    default['frequencies'] = np.arange(30,81) * units.MHz
+    default['gain'] = data   # data is in dB
+
+    return default
+
+def get_RCU_response(frequencies):
+
+
+    RCU_response = {}
+    RCU_response['default'] = load_RCU_response()
+    orig_frequencies = RCU_response['default']['frequencies']
+
+    gain = RCU_response['default']['gain']
+
+    interp_gain = interp1d(orig_frequencies, gain, bounds_error=False, fill_value=0)
+
+    system = {}
+    system['gain'] = interp_gain(frequencies)
+
+    return system

NuRadioReco/detector/LOFAR/signalchain/RCU_gain_new_5.txt

@@ -0,0 +1,51 @@
+0.571199977723
+0.721199977723
+0.799800695235
+0.825966036527
+0.815430246143
+0.783927568626
+0.746950424766
+0.712983105812
+0.682589587584
+0.655908728285
+0.633079386122
+0.614226566278
+0.599111687582
+0.587105693931
+0.577560289905
+0.569827180085
+0.563258069051
+0.557204661382
+0.55101866166
+0.544051774464
+0.535655704375
+0.525182155973
+0.511982833838
+0.495409442551
+0.474813686691
+0.44954727084
+0.418961899576
+0.382409277481
+0.339241109135
+0.288809099118
+0.23046495201
+0.163560372391
+0.0874470648419
+0.00147673394283
+-0.0949989157261
+-0.202628179585
+-0.322059353052
+-0.453940731549
+-0.598920610495
+-0.757647285309
+-0.930769051412
+-1.11893420422
+-1.32279103916
+-1.54298785165
+-2.0801729371
+-2.38499459094
+-2.71223456883
+-3.23061184212
+-4.13436889849
+-5.92420576122
+-8.50082245357

NuRadioReco/detector/LOFAR/signalchain/attenuation_RG58_115m.txt

@@ -0,0 +1,51 @@
+30 9.37884232408
+31 9.53487220268
+32 9.68842092213
+33 9.83960368097
+34 9.98852702327
+35 10.1352897227
+36 10.2799835538
+37 10.4226939673
+38 10.5635006844
+39 10.7024782204
+40 10.839696349
+41 10.9752205142
+42 11.1091121976
+43 11.2414292464
+44 11.3722261673
+45 11.5015543907
+46 11.6294625085
+47 11.7559964886
+48 11.8811998694
+49 12.0051139356
+50 12.1277778787
+51 12.2492289422
+52 12.3695025551
+53 12.4886324526
+54 12.6066507884
+55 12.7235882355
+56 12.8394740809
+57 12.9543363114
+58 13.0682016927
+59 13.1810958433
+60 13.293043302
+61 13.4040675904
+62 13.5141912711
+63 13.6234360018
+64 13.7318225849
+65 13.8393710144
+66 13.9461005192
+67 14.0520296034
+68 14.1571760837
+69 14.2615571255
+70 14.3651892746
+71 14.4680884892
+72 14.5702701679
+73 14.6717491772
+74 14.7725398768
+75 14.8726561435
+76 14.9721113935
+77 15.0709186038
+78 15.1690903319
+79 15.2666387345
+80 15.3635755852

NuRadioReco/detector/LOFAR/signalchain/attenuation_RG58_50m.txt

@@ -0,0 +1,51 @@
+30 4.07775753221
+31 4.14559660986
+32 4.21235692266
+33 4.27808855694
+34 4.3428378362
+35 4.40664770552
+36 4.46955806685
+37 4.53160607273
+38 4.59282638451
+39 4.65325140018
+40 4.7129114561
+41 4.77183500619
+42 4.83004878157
+43 4.8875779332
+44 4.94444615968
+45 5.00067582203
+46 5.05628804716
+47 5.11130282113
+48 5.16573907364
+49 5.21961475461
+50 5.27294690378
+51 5.32575171402
+52 5.37804458916
+53 5.4298401968
+54 5.48115251668
+55 5.531994885
+56 5.58238003519
+57 5.63232013538
+58 5.6818268229
+59 5.73091123623
+60 5.77958404435
+61 5.82785547408
+62 5.87573533527
+63 5.92323304425
+64 5.9703576456
+65 6.01711783236
+66 6.06352196489
+67 6.10957808842
+68 6.15529394945
+69 6.20067701107
+70 6.24573446722
+71 6.29047325617
+72 6.334900073
+73 6.37902138139
+74 6.4228434247
+75 6.46637223629
+76 6.50961364935
+77 6.55257330602
+78 6.59525666605
+79 6.63766901499
+80 6.67981547185

NuRadioReco/detector/LOFAR/signalchain/attenuation_RG58_80m.txt

@@ -0,0 +1,51 @@
+30 6.52441205153
+31 6.63295457577
+32 6.73977107626
+33 6.84494169111
+34 6.94854053793
+35 7.05063632883
+36 7.15129290696
+37 7.25056971637
+38 7.34852221522
+39 7.44520224029
+40 7.54065832975
+41 7.6349360099
+42 7.72807805051
+43 7.82012469312
+44 7.91111385548
+45 8.00108131525
+46 8.09006087545
+47 8.1780845138
+48 8.26518251782
+49 8.35138360738
+50 8.43671504605
+51 8.52120274243
+52 8.60487134266
+53 8.68774431488
+54 8.76984402669
+55 8.851191816
+56 8.93180805631
+57 9.0117122166
+58 9.09092291664
+59 9.16945797796
+60 9.24733447096
+61 9.32456875853
+62 9.40117653643
+63 9.47717287081
+64 9.55257223297
+65 9.62738853178
+66 9.70163514382
+67 9.77532494147
+68 9.84847031912
+69 9.92108321771
+70 9.99317514756
+71 10.0647572099
+72 10.1358401168
+73 10.2064342102
+74 10.2765494795
+75 10.3461955781
+76 10.415381839
+77 10.4841172896
+78 10.5524106657
+79 10.620270424
+80 10.687704755

NuRadioReco/detector/antennapattern.py

@@ -1008,24 +1008,31 @@ def parse_LOFAR_txt_file(path_theta, path_phi):
     return freq, theta, phi, real_theta, imaginary_theta, real_phi, imaginary_phi
 
 
-def preprocess_LOFAR_txt(directory, ant='LBA'):
+def preprocess_LOFAR_txt(directory, ant='LBA', orientation=None):
     """
-    Function to parse the LOFAR antenna model simulation files in TXT format. It extracts the
-    vector effective length for all simulated frequencies, azimuth and zenith angles and dumps
-    them into a pickle file according to the NuRadioReco specification.
+    Function to process the TXT files from the old LOFAR antenna model (only tested for LBA). The paths to these
+    files is currently hardcoded. Because of a weird issue which requires minus signs to be added for the X and Y
+    dipoles separately, the orientation can be specified to create separate antenna models for each. If the
+    orientation is not set, the values for the Y dipole are returned.
 
     Parameters
     ----------
     directory : str
-        The path to the directory where the TXT files are stored
+        Path to where the text files are stored
     ant : str, default='LBA'
-        The antenna type
+        The antenna type, either LBA or HBA (not tested)
+    orientation : str, default=None
+        If set, must be either X or Y.
     """
     path_theta = os.path.join(directory, f'{ant}_Vout_theta.txt')
     path_phi = os.path.join(directory, f'{ant}_Vout_phi.txt')
 
     frequencies, thetas, phis, theta_real, theta_imag, phi_real, phi_imag = parse_LOFAR_txt_file(path_theta, path_phi)
 
+    if orientation == 'X':
+        for ar in [theta_real, theta_imag, phi_real, phi_imag]:
+            ar *= -1
+
     VEL_thetas = theta_real + 1j * theta_imag
     VEL_phis = phi_real + 1j * phi_imag
 
@@ -1046,7 +1053,10 @@ def preprocess_LOFAR_txt(directory, ant='LBA'):
     orientation_theta, orientation_phi, rotation_theta, rotation_phi = \
         90 * units.deg, 0 * units.deg, 0 * units.deg, 0 * units.deg
 
-    fname = f'LOFAR_{ant}'
+    if orientation is not None:
+        fname = f'LOFAR_{ant}_{orientation}'
+    else:
+        fname = f'LOFAR_{ant}'
     output_filename = '{}.pkl'.format(os.path.join(path_to_antennamodels, fname, fname))
 
     directory = os.path.dirname(output_filename)

NuRadioReco/detector/detector_base.py

@@ -974,6 +974,32 @@ def get_channel_group_id(self, station_id, channel_id):
             return channel_id
         else:
             return res['channel_group_id']
+
+    def get_antenna_mode(self, station_id, channel_id):
+        """
+        returns the antenna mode of a given channel - this is specific to LOFAR antennae, as they operate in either inner or outer mode.
+
+        Parameters
+        ----------
+        station_id: int
+            the station id
+        channel_id: int
+            the channel id
+
+        Returns
+        -------
+        ant_mode : str
+            the antenna mode (LBA inner/outer)
+        """
+
+        res = self.__get_channel(station_id, channel_id)
+        if 'ant_mode' not in res.keys():
+            logger.warning(
+                'Antenna mode not set for channel {} in station {}, returning None'.format(
+                    channel_id, station_id))
+            return None
+        else:
+            return res['ant_mode']
 
     def get_noise_RMS(self, station_id, channel_id, stage='amp'):
         """