source: sasview/src/sas/sascalc/dataloader/file_reader_base_class.py @ 9efdb29

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalcmagnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 9efdb29 was 7b50f14, checked in by Paul Kienzle <pkienzle@…>, 7 years ago

restore python 2 functionality
  • Property mode set to 100644
File size: 10.1 KB
Line 
1"""
2This is the base file reader class most file readers should inherit from.
3All generic functionality required for a file loader/reader is built into this
4class
5"""
6
7import os
8import sys
9import re
10import logging
11from abc import abstractmethod
12
13import numpy as np
14from .loader_exceptions import NoKnownLoaderException, FileContentsException,\
15    DataReaderException, DefaultReaderException
16from .data_info import Data1D, Data2D, DataInfo, plottable_1D, plottable_2D,\
17    combine_data_info_with_plottable
18
19logger = logging.getLogger(__name__)
20
21if sys.version_info[0] < 3:
22    def decode(s):
23        return s
24else:
25    def decode(s):
26        return s.decode() if isinstance(s, bytes) else s
27
28class FileReader(object):
29    # List of Data1D and Data2D objects to be sent back to data_loader
30    output = []
31    # Current plottable_(1D/2D) object being loaded in
32    current_dataset = None
33    # Current DataInfo object being loaded in
34    current_datainfo = None
35    # String to describe the type of data this reader can load
36    type_name = "ASCII"
37    # Wildcards to display
38    type = ["Text files (*.txt|*.TXT)"]
39    # List of allowed extensions
40    ext = ['.txt']
41    # Bypass extension check and try to load anyway
42    allow_all = False
43    # Able to import the unit converter
44    has_converter = True
45    # Open file handle
46    f_open = None
47    # Default value of zero
48    _ZERO = 1e-16
49
50    def read(self, filepath):
51        """
52        Basic file reader
53
54        :param filepath: The full or relative path to a file to be loaded
55        """
56        if os.path.isfile(filepath):
57            basename, extension = os.path.splitext(os.path.basename(filepath))
58            self.extension = extension.lower()
59            # If the file type is not allowed, return nothing
60            if self.extension in self.ext or self.allow_all:
61                # Try to load the file, but raise an error if unable to.
62                try:
63                    self.f_open = open(filepath, 'rb')
64                    self.get_file_contents()
65
66                except DataReaderException as e:
67                    self.handle_error_message(e.message)
68                except OSError as e:
69                    # If the file cannot be opened
70                    msg = "Unable to open file: {}\n".format(filepath)
71                    msg += e.message
72                    self.handle_error_message(msg)
73                finally:
74                    # Close the file handle if it is open
75                    if not self.f_open.closed:
76                        self.f_open.close()
77                    if len(self.output) > 0:
78                        # Sort the data that's been loaded
79                        self.sort_one_d_data()
80                        self.sort_two_d_data()
81        else:
82            msg = "Unable to find file at: {}\n".format(filepath)
83            msg += "Please check your file path and try again."
84            self.handle_error_message(msg)
85
86        # Return a list of parsed entries that data_loader can manage
87        return self.output
88
89    def nextline(self):
90        """
91        Returns the next line in the file as a string.
92        """
93        #return self.f_open.readline()
94        return decode(self.f_open.readline())
95
96    def nextlines(self):
97        """
98        Returns the next line in the file as a string.
99        """
100        for line in self.f_open:
101            #yield line
102            yield decode(line)
103
104    def readall(self):
105        """
106        Returns the entire file as a string.
107        """
108        #return self.f_open.read()
109        return decode(self.f_open.read())
110
111    def handle_error_message(self, msg):
112        """
113        Generic error handler to add an error to the current datainfo to
114        propogate the error up the error chain.
115        :param msg: Error message
116        """
117        if len(self.output) > 0:
118            self.output[-1].errors.append(msg)
119        elif isinstance(self.current_datainfo, DataInfo):
120            self.current_datainfo.errors.append(msg)
121        else:
122            logger.warning(msg)
123
124    def send_to_output(self):
125        """
126        Helper that automatically combines the info and set and then appends it
127        to output
128        """
129        data_obj = combine_data_info_with_plottable(self.current_dataset,
130                                                    self.current_datainfo)
131        self.output.append(data_obj)
132
133    def sort_one_d_data(self):
134        """
135        Sort 1D data along the X axis for consistency
136        """
137        for data in self.output:
138            if isinstance(data, Data1D):
139                # Normalize the units for
140                data.x_unit = self.format_unit(data.x_unit)
141                data.y_unit = self.format_unit(data.y_unit)
142                # Sort data by increasing x and remove 1st point
143                ind = np.lexsort((data.y, data.x))
144                data.x = np.asarray([data.x[i] for i in ind]).astype(np.float64)
145                data.y = np.asarray([data.y[i] for i in ind]).astype(np.float64)
146                if data.dx is not None:
147                    if len(data.dx) == 0:
148                        data.dx = None
149                        continue
150                    data.dx = np.asarray([data.dx[i] for i in ind]).astype(np.float64)
151                if data.dxl is not None:
152                    data.dxl = np.asarray([data.dxl[i] for i in ind]).astype(np.float64)
153                if data.dxw is not None:
154                    data.dxw = np.asarray([data.dxw[i] for i in ind]).astype(np.float64)
155                if data.dy is not None:
156                    if len(data.dy) == 0:
157                        data.dy = None
158                        continue
159                    data.dy = np.asarray([data.dy[i] for i in ind]).astype(np.float64)
160                if data.lam is not None:
161                    data.lam = np.asarray([data.lam[i] for i in ind]).astype(np.float64)
162                if data.dlam is not None:
163                    data.dlam = np.asarray([data.dlam[i] for i in ind]).astype(np.float64)
164                if len(data.x) > 0:
165                    data.xmin = np.min(data.x)
166                    data.xmax = np.max(data.x)
167                    data.ymin = np.min(data.y)
168                    data.ymax = np.max(data.y)
169
170    def sort_two_d_data(self):
171        for dataset in self.output:
172            if isinstance(dataset, Data2D):
173                # Normalize the units for
174                dataset.x_unit = self.format_unit(dataset.Q_unit)
175                dataset.y_unit = self.format_unit(dataset.I_unit)
176                dataset.data = dataset.data.astype(np.float64)
177                dataset.qx_data = dataset.qx_data.astype(np.float64)
178                dataset.xmin = np.min(dataset.qx_data)
179                dataset.xmax = np.max(dataset.qx_data)
180                dataset.qy_data = dataset.qy_data.astype(np.float64)
181                dataset.ymin = np.min(dataset.qy_data)
182                dataset.ymax = np.max(dataset.qy_data)
183                dataset.q_data = np.sqrt(dataset.qx_data * dataset.qx_data
184                                         + dataset.qy_data * dataset.qy_data)
185                if dataset.err_data is not None:
186                    dataset.err_data = dataset.err_data.astype(np.float64)
187                if dataset.dqx_data is not None:
188                    dataset.dqx_data = dataset.dqx_data.astype(np.float64)
189                if dataset.dqy_data is not None:
190                    dataset.dqy_data = dataset.dqy_data.astype(np.float64)
191                if dataset.mask is not None:
192                    dataset.mask = dataset.mask.astype(dtype=bool)
193
194                if len(dataset.data.shape) == 2:
195                    n_rows, n_cols = dataset.data.shape
196                    dataset.y_bins = dataset.qy_data[0::int(n_cols)]
197                    dataset.x_bins = dataset.qx_data[:int(n_cols)]
198                dataset.data = dataset.data.flatten()
199
200    def format_unit(self, unit=None):
201        """
202        Format units a common way
203        :param unit:
204        :return:
205        """
206        if unit:
207            split = unit.split("/")
208            if len(split) == 1:
209                return unit
210            elif split[0] == '1':
211                return "{0}^".format(split[1]) + "{-1}"
212            else:
213                return "{0}*{1}^".format(split[0], split[1]) + "{-1}"
214
215    def set_all_to_none(self):
216        """
217        Set all mutable values to None for error handling purposes
218        """
219        self.current_dataset = None
220        self.current_datainfo = None
221        self.output = []
222
223    def remove_empty_q_values(self, has_error_dx=False, has_error_dy=False,
224                              has_error_dxl=False, has_error_dxw=False):
225        """
226        Remove any point where Q == 0
227        """
228        x = self.current_dataset.x
229        self.current_dataset.x = self.current_dataset.x[x != 0]
230        self.current_dataset.y = self.current_dataset.y[x != 0]
231        if has_error_dy:
232            self.current_dataset.dy = self.current_dataset.dy[x != 0]
233        if has_error_dx:
234            self.current_dataset.dx = self.current_dataset.dx[x != 0]
235        if has_error_dxl:
236            self.current_dataset.dxl = self.current_dataset.dxl[x != 0]
237        if has_error_dxw:
238            self.current_dataset.dxw = self.current_dataset.dxw[x != 0]
239
240    def reset_data_list(self, no_lines=0):
241        """
242        Reset the plottable_1D object
243        """
244        # Initialize data sets with arrays the maximum possible size
245        x = np.zeros(no_lines)
246        y = np.zeros(no_lines)
247        dx = np.zeros(no_lines)
248        dy = np.zeros(no_lines)
249        self.current_dataset = plottable_1D(x, y, dx, dy)
250
251    @staticmethod
252    def splitline(line):
253        """
254        Splits a line into pieces based on common delimeters
255        :param line: A single line of text
256        :return: list of values
257        """
258        # Initial try for CSV (split on ,)
259        toks = line.split(',')
260        # Now try SCSV (split on ;)
261        if len(toks) < 2:
262            toks = line.split(';')
263        # Now go for whitespace
264        if len(toks) < 2:
265            toks = line.split()
266        return toks
267
268    @abstractmethod
269    def get_file_contents(self):
270        """
271        Reader specific class to access the contents of the file
272        All reader classes that inherit from FileReader must implement
273        """
274        pass
Note: See TracBrowser for help on using the repository browser.