source: sasview/src/sas/sascalc/dataloader/readers/sesans_reader.py @ def97a0

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since def97a0 was def97a0, checked in by Adam Washington <adam.washington@…>, 3 years ago

Pass flake8 on sesans_reader.py

Imrpove the code in sesans reader by ensuring that everything passes
the flake8 tests

  • Property mode set to 100644
File size: 4.8 KB
Line 
1"""
2    SESANS reader (based on ASCII reader)
3
4    Reader for .ses or .sesans file format
5
6    Jurrian Bakker
7"""
8import numpy as np
9import os
10from sas.sascalc.dataloader.data_info import Data1D
11
12# Check whether we have a converter available
13has_converter = True
14try:
15    from sas.sascalc.data_util.nxsunit import Converter
16except:
17    has_converter = False
18_ZERO = 1e-16
19
20
21class Reader:
22    """
23    Class to load sesans files (6 columns).
24    """
25    # File type
26    type_name = "SESANS"
27
28    # Wildcards
29    type = ["SESANS files (*.ses)|*.ses",
30            "SESANS files (*..sesans)|*.sesans"]
31    # List of allowed extensions
32    ext = ['.ses', '.SES', '.sesans', '.SESANS']
33
34    # Flag to bypass extension check
35    allow_all = True
36
37    def read(self, path):
38        """
39        Load data file
40
41        :param path: file path
42
43        :return: SESANSData1D object, or None
44
45        :raise RuntimeError: when the file can't be opened
46        :raise ValueError: when the length of the data vectors are inconsistent
47        """
48        if os.path.isfile(path):
49            basename = os.path.basename(path)
50            _, extension = os.path.splitext(basename)
51            if self.allow_all or extension.lower() in self.ext:
52                with open(path, 'r') as input_f:
53                    # Read in binary mode since GRASP frequently has no-ascii
54                    # characters that brakes the open operation
55                    line = input_f.readline()
56                    params = {}
57                    while line.strip() != "":
58                        if line.strip() == "":
59                            break
60                        terms = line.strip().split("\t")
61                        params[terms[0].strip()] = " ".join(terms[1:]).strip()
62                        line = input_f.readline()
63                    headers_temp = input_f.readline().strip().split("\t")
64                    headers = {}
65                    for h in headers_temp:
66                        temp = h.strip().split()
67                        headers[h[:-1].strip()] = temp[-1][1:-1]
68                    data = np.loadtxt(input_f)
69                    x = data[:, 0]
70                    dx = data[:, 3]
71                    lam = data[:, 4]
72                    dlam = data[:, 5]
73                    y = data[:, 1]
74                    dy = data[:, 2]
75
76                    lam_unit = _header_fetch(headers, "wavelength")
77                    if lam_unit == "AA":
78                        lam_unit = "A"
79
80                    x, x_unit = self._unit_conversion(
81                        x, lam_unit,
82                        _fetch_unit(headers, "spin echo length"))
83                    dx, dx_unit = self._unit_conversion(
84                        dx, lam_unit,
85                        _fetch_unit(headers, "error SEL"))
86                    dlam, dlam_unit = self._unit_conversion(
87                        dlam, lam_unit,
88                        _fetch_unit(headers, "error wavelength"))
89                    y_unit = r'\AA^{-2} cm^{-1}'
90
91                    output = Data1D(x=x, y=y, lam=lam, dy=dy, dx=dx, dlam=dlam,
92                                    isSesans=True)
93                    self.filename = output.filename = basename
94                    output.xaxis(r"\rm{z}", x_unit)
95                    # Adjust label to ln P/(lam^2 t), remove lam column refs
96                    output.yaxis(r"\rm{ln(P)/(t \lambda^2)}", y_unit)
97                    # Store loading process information
98                    output.meta_data['loader'] = self.type_name
99                    output.sample.name = params["Sample"]
100                    output.sample.ID = params["DataFileTitle"]
101
102                    output.sample.zacceptance = (
103                        float(_header_fetch(params, "Q_zmax")),
104                        _fetch_unit(params, "Q_zmax"))
105
106                    output.sample.yacceptance = (
107                        float(_header_fetch(params, "Q_ymax")),
108                        _fetch_unit(params, "Q_ymax"))
109
110                if len(output.x) < 1:
111                    raise RuntimeError("%s is empty" % path)
112                return output
113
114        else:
115            raise RuntimeError("%s is not a file" % path)
116        return None
117
118    def _unit_conversion(self, value, value_unit, default_unit):
119        if has_converter and value_unit != default_unit:
120            data_conv_q = Converter(value_unit)
121            value = data_conv_q(value, units=default_unit)
122            new_unit = default_unit
123        else:
124            new_unit = value_unit
125        return value, new_unit
126
127
128def _header_fetch(headers, key):
129    index = [k for k in headers.keys()
130             if k.startswith(key)][0]
131    return headers[index]
132
133
134def _fetch_unit(params, key):
135    index = [k for k in params.keys()
136             if k.startswith(key)][0]
137    unit = index.strip().split()[-1][1:-1]
138    if unit.startswith(r"\A"):
139        unit = "1/A"
140    return unit
Note: See TracBrowser for help on using the repository browser.