| 1 | """ |
|---|
| 2 | This is the base file reader class most file readers should inherit from. |
|---|
| 3 | All generic functionality required for a file loader/reader is built into this |
|---|
| 4 | class |
|---|
| 5 | """ |
|---|
| 6 | |
|---|
| 7 | import os |
|---|
| 8 | import logging |
|---|
| 9 | import numpy as np |
|---|
| 10 | from abc import abstractmethod |
|---|
| 11 | from loader_exceptions import NoKnownLoaderException, FileContentsException,\ |
|---|
| 12 | DataReaderException, DefaultReaderException |
|---|
| 13 | from data_info import Data1D, Data2D, DataInfo, plottable_1D, plottable_2D,\ |
|---|
| 14 | combine_data_info_with_plottable |
|---|
| 15 | |
|---|
| 16 | logger = logging.getLogger(__name__) |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | class FileReader(object): |
|---|
| 20 | # List of Data1D and Data2D objects to be sent back to data_loader |
|---|
| 21 | output = [] |
|---|
| 22 | # Current plottable_(1D/2D) object being loaded in |
|---|
| 23 | current_dataset = None |
|---|
| 24 | # Current DataInfo object being loaded in |
|---|
| 25 | current_datainfo = None |
|---|
| 26 | # String to describe the type of data this reader can load |
|---|
| 27 | type_name = "ASCII" |
|---|
| 28 | # Wildcards to display |
|---|
| 29 | type = ["Text files (*.txt|*.TXT)"] |
|---|
| 30 | # List of allowed extensions |
|---|
| 31 | ext = ['.txt'] |
|---|
| 32 | # Bypass extension check and try to load anyway |
|---|
| 33 | allow_all = False |
|---|
| 34 | # Able to import the unit converter |
|---|
| 35 | has_converter = True |
|---|
| 36 | # Open file handle |
|---|
| 37 | f_open = None |
|---|
| 38 | # Default value of zero |
|---|
| 39 | _ZERO = 1e-16 |
|---|
| 40 | |
|---|
| 41 | def read(self, filepath): |
|---|
| 42 | """ |
|---|
| 43 | Basic file reader |
|---|
| 44 | |
|---|
| 45 | :param filepath: The full or relative path to a file to be loaded |
|---|
| 46 | """ |
|---|
| 47 | if os.path.isfile(filepath): |
|---|
| 48 | basename, extension = os.path.splitext(os.path.basename(filepath)) |
|---|
| 49 | self.extension = extension.lower() |
|---|
| 50 | # If the file type is not allowed, return nothing |
|---|
| 51 | if self.extension in self.ext or self.allow_all: |
|---|
| 52 | # Try to load the file, but raise an error if unable to. |
|---|
| 53 | try: |
|---|
| 54 | self.f_open = open(filepath, 'rb') |
|---|
| 55 | self.get_file_contents() |
|---|
| 56 | self.sort_one_d_data() |
|---|
| 57 | except DataReaderException as e: |
|---|
| 58 | self.handle_error_message(e.message) |
|---|
| 59 | except OSError as e: |
|---|
| 60 | # If the file cannot be opened |
|---|
| 61 | msg = "Unable to open file: {}\n".format(filepath) |
|---|
| 62 | msg += e.message |
|---|
| 63 | self.handle_error_message(msg) |
|---|
| 64 | finally: |
|---|
| 65 | # Close the file handle if it is open |
|---|
| 66 | if not self.f_open.closed: |
|---|
| 67 | self.f_open.close() |
|---|
| 68 | else: |
|---|
| 69 | msg = "Unable to find file at: {}\n".format(filepath) |
|---|
| 70 | msg += "Please check your file path and try again." |
|---|
| 71 | self.handle_error_message(msg) |
|---|
| 72 | # Return a list of parsed entries that data_loader can manage |
|---|
| 73 | return self.output |
|---|
| 74 | |
|---|
| 75 | def handle_error_message(self, msg): |
|---|
| 76 | """ |
|---|
| 77 | Generic error handler to add an error to the current datainfo to |
|---|
| 78 | propogate the error up the error chain. |
|---|
| 79 | :param msg: Error message |
|---|
| 80 | """ |
|---|
| 81 | if isinstance(self.current_datainfo, DataInfo): |
|---|
| 82 | self.current_datainfo.errors.append(msg) |
|---|
| 83 | else: |
|---|
| 84 | logger.warning(msg) |
|---|
| 85 | |
|---|
| 86 | def send_to_output(self): |
|---|
| 87 | """ |
|---|
| 88 | Helper that automatically combines the info and set and then appends it |
|---|
| 89 | to output |
|---|
| 90 | """ |
|---|
| 91 | data_obj = combine_data_info_with_plottable(self.current_dataset, |
|---|
| 92 | self.current_datainfo) |
|---|
| 93 | self.output.append(data_obj) |
|---|
| 94 | |
|---|
| 95 | def sort_one_d_data(self): |
|---|
| 96 | """ |
|---|
| 97 | Sort 1D data along the X axis for consistency |
|---|
| 98 | """ |
|---|
| 99 | final_list = [] |
|---|
| 100 | for data in self.output: |
|---|
| 101 | if isinstance(data, Data1D): |
|---|
| 102 | # Sort data by increasing x and remove 1st point |
|---|
| 103 | ind = np.lexsort((data.y, data.x)) |
|---|
| 104 | ind = ind[1:] # Remove 1st point (Q, I) = (0, 0) |
|---|
| 105 | data.x = np.asarray([data.x[i] for i in ind]) |
|---|
| 106 | data.y = np.asarray([data.y[i] for i in ind]) |
|---|
| 107 | if data.dx is not None: |
|---|
| 108 | data.dx = np.asarray([data.dx[i] for i in ind]) |
|---|
| 109 | if data.dxl is not None: |
|---|
| 110 | data.dxl = np.asarray([data.dxl[i] for i in ind]) |
|---|
| 111 | if data.dxw is not None: |
|---|
| 112 | data.dxw = np.asarray([data.dxw[i] for i in ind]) |
|---|
| 113 | if data.dy is not None: |
|---|
| 114 | data.dy = np.asarray([data.dy[i] for i in ind]) |
|---|
| 115 | if data.lam is not None: |
|---|
| 116 | data.lam = np.asarray([data.lam[i] for i in ind]) |
|---|
| 117 | if data.dlam is not None: |
|---|
| 118 | data.dlam = np.asarray([data.dlam[i] for i in ind]) |
|---|
| 119 | data.xmin = np.min(data.x) |
|---|
| 120 | data.xmax = np.max(data.x) |
|---|
| 121 | data.ymin = np.min(data.y) |
|---|
| 122 | data.ymax = np.max(data.y) |
|---|
| 123 | final_list.append(data) |
|---|
| 124 | self.output = final_list |
|---|
| 125 | |
|---|
| 126 | def set_all_to_none(self): |
|---|
| 127 | """ |
|---|
| 128 | Set all mutable values to None for error handling purposes |
|---|
| 129 | """ |
|---|
| 130 | self.current_dataset = None |
|---|
| 131 | self.current_datainfo = None |
|---|
| 132 | self.output = [] |
|---|
| 133 | |
|---|
| 134 | def remove_empty_q_values(self, has_error_dx=False, has_error_dy=False): |
|---|
| 135 | """ |
|---|
| 136 | Remove any point where Q == 0 |
|---|
| 137 | """ |
|---|
| 138 | x = self.current_dataset.x |
|---|
| 139 | self.current_dataset.x = self.current_dataset.x[x != 0] |
|---|
| 140 | self.current_dataset.y = self.current_dataset.y[x != 0] |
|---|
| 141 | self.current_dataset.dy = self.current_dataset.dy[x != 0] if \ |
|---|
| 142 | has_error_dy else np.zeros(len(self.current_dataset.y)) |
|---|
| 143 | self.current_dataset.dx = self.current_dataset.dx[x != 0] if \ |
|---|
| 144 | has_error_dx else np.zeros(len(self.current_dataset.x)) |
|---|
| 145 | |
|---|
| 146 | def reset_data_list(self, no_lines=0): |
|---|
| 147 | """ |
|---|
| 148 | Reset the plottable_1D object |
|---|
| 149 | """ |
|---|
| 150 | # Initialize data sets with arrays the maximum possible size |
|---|
| 151 | x = np.zeros(no_lines) |
|---|
| 152 | y = np.zeros(no_lines) |
|---|
| 153 | dy = np.zeros(no_lines) |
|---|
| 154 | dx = np.zeros(no_lines) |
|---|
| 155 | self.current_dataset = plottable_1D(x, y, dx, dy) |
|---|
| 156 | |
|---|
| 157 | @staticmethod |
|---|
| 158 | def splitline(line): |
|---|
| 159 | """ |
|---|
| 160 | Splits a line into pieces based on common delimeters |
|---|
| 161 | :param line: A single line of text |
|---|
| 162 | :return: list of values |
|---|
| 163 | """ |
|---|
| 164 | # Initial try for CSV (split on ,) |
|---|
| 165 | toks = line.split(',') |
|---|
| 166 | # Now try SCSV (split on ;) |
|---|
| 167 | if len(toks) < 2: |
|---|
| 168 | toks = line.split(';') |
|---|
| 169 | # Now go for whitespace |
|---|
| 170 | if len(toks) < 2: |
|---|
| 171 | toks = line.split() |
|---|
| 172 | return toks |
|---|
| 173 | |
|---|
| 174 | @abstractmethod |
|---|
| 175 | def get_file_contents(self): |
|---|
| 176 | """ |
|---|
| 177 | Reader specific class to access the contents of the file |
|---|
| 178 | All reader classes that inherit from FileReader must implement |
|---|
| 179 | """ |
|---|
| 180 | pass |
|---|
