corems.transient.input.midasDatFile

  1from os import path
  2
  3from numpy import dtype, fromfile
  4
  5
  6__author__ = "Yuri E. Corilo"
  7__date__ = "Jun 19, 2019"
  8
  9
 10class ReadMidasDatFile:
 11    """[Not Implemented] Reads MIDAS .dat files (binary transient data)
 12
 13    This class will read .dat binary format transient data, e.g. midas format from Predator or Thermo datastations
 14    This code is not yet implemented and is not fully functional.
 15
 16    Parameters
 17    ----------
 18    filename_path : str
 19        The path to the .dat file
 20
 21    Attributes
 22    ----------
 23    filename_path : str
 24        The path to the .dat file
 25    d_params : dict
 26        A dictionary with the parameters of the .dat file
 27    transient_data : numpy.ndarray
 28        The transient data
 29
 30    Methods
 31    -------
 32    * read_file().
 33        Reads the .dat file and returns the transient data and the parameters
 34    * get_transient_data(data_file, d_params).
 35        Reads the transient data from the .dat file
 36    * parse_parameter(f).
 37        Parses the parameters from the .dat file
 38
 39    Raises
 40    ------
 41    NotImplementedError
 42        This class is not yet implemented.
 43
 44    """
 45
 46    def __init__(self, filename_path):
 47        raise NotImplementedError(
 48            "This class is not yet implemented, if you want to use it please contact the author at corilo@pnnl.gov or feel free to implement it"
 49        )
 50        if not path.isfile(filename_path):
 51            raise Exception("File does not exist: " + filename_path)
 52
 53        self.filename_path = filename_path
 54
 55    def read_file(self):
 56        """Reads the .dat file and returns the transient data and the parameters
 57
 58        Returns
 59        -------
 60        transient_data : numpy.ndarray
 61            The transient data
 62        d_params : dict
 63            A dictionary with the parameters of the .dat file
 64
 65        """
 66        data_file = open(self.filename_path, "rb")
 67
 68        # modo_de_ions = "POSITIVE ION MODE"
 69        d_params = self.parse_parameters(self.parameter_filename_location)
 70
 71        transient_data = self.get_transient_data(data_file, d_params, d_params)
 72
 73        return transient_data, d_params
 74
 75    def get_transient_data(self, data_file, d_params):
 76        """Reads the transient data from the .dat file
 77
 78        Parameters
 79        ----------
 80        data_file : file
 81            The .dat file
 82        d_params : dict
 83            A dictionary with the parameters of the .dat file
 84
 85        Returns
 86        -------
 87        myarray : numpy.ndarray
 88            The transient data
 89        """
 90
 91        # dt = np.dtype('<f')
 92        if d_params.get("storage_type").split()[0] == "int":
 93            dt = dtype("i2")
 94
 95        else:
 96            dt = dtype("<f")
 97        # dt = np.dtype(int)
 98
 99        myarray = fromfile(data_file, dtype=dt)
100
101        data_file.close()
102
103        if d_params.get("storage_type").split()[0] == "int":
104            return myarray * d_params.get("VoltageScale")
105
106        else:
107            return myarray
108
109    def parse_parameter(self, f):
110        """Parses the parameters from the .dat file
111
112        Parameters
113        ----------
114        f : file
115            The .dat file
116
117        Returns
118        -------
119        output_parameters : dict
120            A dictionary with the parameters of the .dat file
121        """
122
123        output_parameters = {}
124        output_parameters["filename_path"] = self.d_directory_location
125
126        line = f.readline()
127
128        while line != "Data:\n":
129            if line[0:8] == "highfreq":
130                final_frequency = float(line.split(":")[1])
131                output_parameters["exc_high_freq"] = final_frequency
132
133            elif line[0:7] == "lowfreq":
134                initial_frequency = float(line.split(":")[1])
135                output_parameters["exc_low_freq"] = initial_frequency
136
137            elif line[0:9] == "sweeprate":
138                sweeprate = float(line.split(":")[1])
139
140                output_parameters["sweeprate"] = sweeprate
141
142            elif line[0:13] == "Source Coeff0":
143                Acoef = float(line.split(":")[1])
144                output_parameters["Aterm"] = Acoef
145                # print f.readline()
146            elif line[0:13] == "Source Coeff1":
147                output_parameters["Bterm"] = "Bcoef"
148
149            elif line[0:13] == "Voltage Scale":
150                voltage_scale = float(line.split(":")[1])
151                output_parameters["VoltageScale"] = voltage_scale
152
153            elif line[0:9] == "Bandwidth":
154                bandwidth = float(line.split(":")[1])
155                output_parameters["bandwidth"] = bandwidth
156
157            elif line[0:11] == "Data Points":
158                datapoints = float(line.split(":")[1])
159                output_parameters["number_data_points"] = datapoints
160
161            elif line[0:12] == "Storage Type":
162                storage_type = line.split(":")[1]
163                output_parameters["storage_type"] = storage_type
164
165            elif line[0:12] == "Trap Voltage":
166                trap_voltage = float(line.split(":")[1])
167                # Bcoef = Bcoef*trap_voltage
168                output_parameters["trap_voltage"] = trap_voltage
169
170            line = f.readline()
171
172        return output_parameters