Atmospheric Lidar Package: atmospheric_lidar/licel_depol.py@e59cdc4fd4c0 (annotated)

atmospheric_lidar/licel_depol.py@e59cdc4fd4c0 (annotated)

atmospheric_lidar/licel_depol.py

Fri, 22 Sep 2017 15:02:53 +0300

author: Victor Nicolae <victor.nicolae@inoe.ro>
date: Fri, 22 Sep 2017 15:02:53 +0300
changeset 76: e59cdc4fd4c0
parent 71: 695e9c21a966
child 92: 6d26002aaeed
permissions: -rw-r--r--

Include all parameters from the NetCDF parameters file in the final output file.

Better inform the user if any mandatory parameter misses from the file.

In case of extra (optional) parameters, allow missing values in the output file.

 import datetime
 import numpy as np
 from licel import LicelLidarMeasurement
 class LicelCalibrationMeasurement(LicelLidarMeasurement):
     def __init__(self, plus45_files=None, minus45_files=None,  use_id_as_name=False):
         # Setup the empty class
         super(LicelCalibrationMeasurement, self).__init__(use_id_as_name=use_id_as_name)
         self.plus45_files = plus45_files
         self.minus45_files = minus45_files
         if plus45_files and minus45_files:
             self.check_equal_length()
             self.read_channel_data()
             self.update()
     def update(self):
         """ Correct timescales after each update.
         """
         super(LicelCalibrationMeasurement, self).update()
         self.correct_timescales()
     def check_equal_length(self):
         """
         Check if input time series have equal lengths.
         """
         len_plus = len(self.plus45_files)
         len_minus = len(self.minus45_files)
         if len_plus != len_minus:
             raise self.UnequalMeasurementLengthError(
                             "Input timeseries have different length: %s vs %s." % (len_plus, len_minus))
     def read_channel_data(self):
         # Read plus and minus 45 measurements
         self.plus45_measurement = LicelLidarMeasurement(self.plus45_files, self.use_id_as_name)
         self.plus45_measurement.rename_channel(suffix='_p45')
         self.minus45_measurement = LicelLidarMeasurement(self.minus45_files, self.use_id_as_name)
         self.minus45_measurement.rename_channel(suffix='_m45')
         # Combine them in this object
         self.channels = {}
         self.channels.update(self.plus45_measurement.channels)
         self.channels.update(self.minus45_measurement.channels)
     def correct_timescales(self):
         self.check_timescales_are_two()
         self.combine_scales()
     def check_timescales_are_two(self):
         no_timescales = len(self.variables['Raw_Data_Start_Time'])
         if no_timescales != 2:
             raise self.WrongNumberOfTimescalesError("Wrong number of timescales: %s instead of 2." % no_timescales)
     def combine_scales(self):
         start_times, end_times = self.get_ordered_timescales()
         new_start_time = start_times[0]
         new_stop_time = end_times[1]
         self.variables['Raw_Data_Start_Time'] = [new_start_time, ]
         self.variables['Raw_Data_Stop_Time'] = [new_stop_time, ]
         self.reset_timescale_id()
     def reset_timescale_id(self):
         """
         Set all timescales to 0
         :return:
         """
         timescale_dict = self.variables['id_timescale']
         self.variables['id_timescale'] = dict.fromkeys(timescale_dict, 0)
     def get_ordered_timescales(self):
         scale_start_1, scale_start_2 = self.variables['Raw_Data_Start_Time']
         scale_end_1, scale_end_2 = self.variables['Raw_Data_Stop_Time']
         if scale_start_1[0] > scale_start_2[0]:
             scale_start_1, scale_start_2 = scale_start_2, scale_start_1
         if scale_end_1[0] > scale_end_2[0]:
             scale_end_1, scale_end_2 = scale_end_2, scale_end_1
         return (scale_start_1, scale_start_2), (scale_end_1, scale_end_2)
     def add_fake_measurements(self, no_profiles, variation=0.1):
         """
         Add a number of fake measurements. This is done to allow testing with single analog profiles.
         Adds a predefined variation in each new profile.
         """
         duration = self.info['duration']
         for channel_name, channel in self.channels.items():
             base_time = channel.data.keys()[0]
             base_data = channel.data[base_time]
             for n in range(no_profiles):
                 random_variation = base_data * (np.random.rand(len(base_data)) * 2 - 1) * variation
                 new_time = base_time + n * duration
                 new_data = channel.data[base_time].copy() + random_variation
                 if 'ph' in channel_name:
                     new_data = new_data.astype('int')
                 channel.data[new_time] = new_data
         self.update()
     def subset_photoncounting(self):
         """
         Subset photoncounting channels.
         """
         ph_channels = [channel for channel in self.channels.keys() if 'ph' in channel]
         new_measurement = self.subset_by_channels(ph_channels)
         return new_measurement
     def _get_scc_mandatory_channel_variables(self):
         """
         Get a list of variables to put in the SCC.
         It can be overridden e.g. in the depolarization product class.
         Returns
         -------
         channel_variables: dict
            A dictionary with channel variable specifications.
         """
         channel_variables = \
             {'Background_Low': (('channels',), 'd'),
              'Background_High': (('channels',), 'd'),
              'LR_Input': (('channels',), 'i'),
              'DAQ_Range': (('channels',), 'd'),
              'Pol_Calib_Range_Min': (('channels',), 'd'),
              'Pol_Calib_Range_Max': (('channels',), 'd'),
              }
         return channel_variables
     class UnequalMeasurementLengthError(RuntimeError):
         """ Raised when the plus and minus files have different length.
         """
         pass
     class WrongNumberOfTimescalesError(RuntimeError):
         """ Raised when timescales are not two.
         """
         pass

Mercurial > public > atmospheric_lidar / annotate

atmospheric_lidar/licel_depol.py@e59cdc4fd4c0 (annotated)

atmospheric_lidar/licel_depol.py