ChessAnalysisPipeline 0.0.12__py3-none-any.whl → 0.0.13__py3-none-any.whl

CHAP/common/reader.py

@@ -6,7 +6,7 @@ Description: Module for Writers used in multiple experiment-specific
              workflows.
 """
 
-# system modules
+# System modules
 from os.path import (
     isfile,
     splitext,
@@ -14,136 +14,76 @@ from os.path import (
 from sys import modules
 from time import time
 
-# local modules
+# Third party modules
+import numpy as np
+
+# Local modules
 from CHAP import Reader
 
 
 class BinaryFileReader(Reader):
-    """Reader for binary files"""
+    """Reader for binary files.
+    """
     def read(self, filename):
-        """Return a content of a given file name
+        """Return a content of a given binary file.
 
-        :param filename: name of the binart file to read from
-        :return: the content of `filename`
+        :param filename: The name of the binary file to read from.
+        :type filename: str
+        :return: The file content.
         :rtype: binary
         """
-
         with open(filename, 'rb') as file:
             data = file.read()
         return data
 
 
-class SpecReader(Reader):
-    """Reader for CHESS SPEC scans"""
-    def read(self, filename=None, spec_config=None, detector_names=[],
-            inputdir=None):
-        """Take a SPEC configuration filename or dictionary and return
-        the raw data as an NXentry.
+class H5Reader(Reader):
+    """Reader for h5 files.
+    """
+    def read(self, filename, h5path='/'):
+        """Return the data object stored at `h5path` in an h5-file.
 
-        :param filename: name of file with the SPEC configuration to
-            read and pass onto the constructor of
-            `CHAP.common.models.map.SpecConfig`
-        :type filename: str, optional
-        :param spec_config: SPEC configuration to be passed directly
-            to the constructor of
-            `CHAP.common.models.map.SpecConfig`
-        :type spec_config: dict, optional
-        :param detector_names: Detector prefixes to include raw data
-            for in the returned NXentry
-        :type detector_names: list[str]
-        :return: Data from the SPEC configuration provided
-        :rtype: nexusformat.nexus.NXentry
+        :param filename: The name of the h5-file to read from.
+        :type filename: str
+        :param h5path: The path to a specific location in the h5 file
+            to read data from, defaults to `'/'`
+        :type h5path: str, optional
+        :return: The object indicated by `filename` and `h5path`.
+        :rtype: object
         """
-        from json import dumps
-        from nexusformat.nexus import (
-            NXcollection,
-            NXdata,
-            NXentry,
-            NXfield,
-        )
-        import numpy as np
-        from CHAP.common.models.map import SpecConfig
-
-        if filename is not None:
-            if spec_config is not None:
-                raise RuntimeError('Specify either filename or spec_config '
-                                   'in common.SpecReader, not both')
-            # Read the map configuration from file
-            if not isfile(filename):
-                raise OSError(f'input file does not exist ({filename})')
-            extension = splitext(filename)[1]
-            if extension in ('.yml', '.yaml'):
-                reader = YAMLReader()
-            else:
-                raise RuntimeError('input file has a non-implemented '
-                                   f'extension ({filename})')
-            spec_config = reader.read(filename)
-        elif not isinstance(spec_config, dict):
-            raise RuntimeError('Invalid parameter spec_config in '
-                               f'common.SpecReader ({spec_config})')
+        # Third party modules
+        from h5py import File
 
-        # Validate the SPEC configuration provided by constructing a
-        # SpecConfig
-        spec_config = SpecConfig(**spec_config, inputdir=inputdir)
-
-        # Set up NXentry and add misc. CHESS-specific metadata
-        # as well as all spec_motors, scan_columns, and smb_pars
-        nxentry = NXentry(name=spec_config.experiment_type)
-        nxentry.spec_config = dumps(spec_config.dict())
-        nxentry.attrs['station'] = spec_config.station
-        nxentry.spec_scans = NXcollection()
-        for scans in spec_config.spec_scans:
-            nxscans = NXcollection()
-            nxentry.spec_scans[f'{scans.scanparsers[0].scan_name}'] = nxscans
-            nxscans.attrs['spec_file'] = str(scans.spec_file)
-            nxscans.attrs['scan_numbers'] = scans.scan_numbers
-            for scan_number in scans.scan_numbers:
-                scanparser = scans.get_scanparser(scan_number)
-                nxscans[scan_number] = NXcollection()
-                if hasattr(scanparser, 'spec_positioner_values'):
-                    nxscans[scan_number].spec_motors = dumps(
-                        {k:float(v) for k,v
-                         in scanparser.spec_positioner_values.items()})
-                if hasattr(scanparser, 'spec_scan_data'):
-                    nxscans[scan_number].scan_columns = dumps(
-                        {k:list(v) for k,v
-                         in scanparser.spec_scan_data.items() if len(v)})
-                if hasattr(scanparser, 'pars'):
-                    nxscans[scan_number].smb_pars = dumps(
-                        {k:v for k,v in scanparser.pars.items()})
-                if detector_names:
-                    nxdata = NXdata()
-                    nxscans[scan_number].data = nxdata
-                    for detector_name in detector_names:
-                        nxdata[detector_name] = NXfield(
-                           value=scanparser.get_detector_data(detector_name))
-
-        return nxentry
+        data = File(filename, 'r')[h5path]
+        return data
 
 
 class MapReader(Reader):
-    """Reader for CHESS sample maps"""
+    """Reader for CHESS sample maps.
+    """
     def read(
             self, filename=None, map_config=None, detector_names=[],
             inputdir=None):
         """Take a map configuration dictionary and return a
-        representation of the map as an NXentry. The NXentry's default
-        data group will contain the raw data collected over the course
-        of the map.
+        representation of the map as a NeXus NXentry object. The
+        NXentry's default data group will contain the raw data
+        collected over the course of the map.
 
-        :param filename: name of file with the map configuration to
-            read and pass onto the constructor of
-            `CHAP.common.models.map.MapConfig`
+        :param filename: The name of a file with the map configuration
+            to read and pass onto the constructor of
+            `CHAP.common.models.map.MapConfig`, defaults to `None`.
         :type filename: str, optional
-        :param map_config: map configuration to be passed directly to
-            the constructor of `CHAP.common.models.map.MapConfig`
+        :param map_config: A map configuration to be passed directly to
+            the constructor of `CHAP.common.models.map.MapConfig`,
+            defaults to `None`.
         :type map_config: dict, optional
         :param detector_names: Detector prefixes to include raw data
-            for in the returned NXentry
-        :type detector_names: list[str]
-        :return: Data from the map configuration provided
+            for in the returned NeXus NXentry object, defaults to `[]`.
+        :type detector_names: list[str], optional
+        :return: Data from the provided map configuration.
         :rtype: nexusformat.nexus.NXentry
         """
+        # Third party modules
         from json import dumps
         from nexusformat.nexus import (
             NXcollection,
@@ -152,7 +92,8 @@ class MapReader(Reader):
             NXfield,
             NXsample,
         )
-        import numpy as np
+
+        # Local modules
         from CHAP.common.models.map import MapConfig
 
         if filename is not None:
@@ -250,43 +191,134 @@ class MapReader(Reader):
 
 
 class NexusReader(Reader):
-    """Reader for NeXus files"""
+    """Reader for NeXus files.
+    """
     def read(self, filename, nxpath='/'):
-        """Return the NeXus object stored at `nxpath` in the nexus
-        file `filename`.
+        """Return the NeXus object stored at `nxpath` in a NeXus file.
 
-        :param filename: name of the NeXus file to read from
+        :param filename: The name of the NeXus file to read from.
         :type filename: str
-        :param nxpath: path to a specific loaction in the NeXus file
-            to read from, defaults to `'/'`
+        :param nxpath: The path to a specific location in the NeXus
+            file tree to read from, defaults to `'/'`
         :type nxpath: str, optional
-        :raises nexusformat.nexus.NeXusError: if `filename` is not a
-            NeXus file or `nxpath` is not in `filename`.
-        :return: the NeXus structure indicated by `filename` and `nxpath`.
+        :raises nexusformat.nexus.NeXusError: If `filename` is not a
+            NeXus file or `nxpath` is not in its tree.
+        :return: The NeXus object indicated by `filename` and `nxpath`.
         :rtype: nexusformat.nexus.NXobject
         """
-
+        # Third party modules
         from nexusformat.nexus import nxload
 
         nxobject = nxload(filename)[nxpath]
         return nxobject
 
 
+class SpecReader(Reader):
+    """Reader for CHESS SPEC scans"""
+    def read(self, filename=None, spec_config=None, detector_names=[],
+            inputdir=None):
+        """Take a SPEC configuration filename or dictionary and return
+        the raw data as a Nexus NXentry object.
+
+        :param filename: The name of file with the SPEC configuration
+            to read from to pass onto the constructor of
+            `CHAP.common.models.map.SpecConfig`, defaults to `None`.
+        :type filename: str, optional
+        :param spec_config: A SPEC configuration to be passed directly
+            to the constructor of `CHAP.common.models.map.SpecConfig`,
+            defaults to `None`.
+        :type spec_config: dict, optional
+        :param detector_names: Detector prefixes to include raw data
+            for in the returned NeXus NXentry object, defaults to `[]`.
+        :type detector_names: list[str], optional
+        :return: The data from the provided SPEC configuration.
+        :rtype: nexusformat.nexus.NXentry
+        """
+        # Third party modules
+        from json import dumps
+        from nexusformat.nexus import (
+            NXcollection,
+            NXdata,
+            NXentry,
+            NXfield,
+        )
+
+        # Local modules
+        from CHAP.common.models.map import SpecConfig
+
+        if filename is not None:
+            if spec_config is not None:
+                raise RuntimeError('Specify either filename or spec_config '
+                                   'in common.SpecReader, not both')
+            # Read the map configuration from file
+            if not isfile(filename):
+                raise OSError(f'input file does not exist ({filename})')
+            extension = splitext(filename)[1]
+            if extension in ('.yml', '.yaml'):
+                reader = YAMLReader()
+            else:
+                raise RuntimeError('input file has a non-implemented '
+                                   f'extension ({filename})')
+            spec_config = reader.read(filename)
+        elif not isinstance(spec_config, dict):
+            raise RuntimeError('Invalid parameter spec_config in '
+                               f'common.SpecReader ({spec_config})')
+
+        # Validate the SPEC configuration provided by constructing a
+        # SpecConfig
+        spec_config = SpecConfig(**spec_config, inputdir=inputdir)
+
+        # Set up NXentry and add misc. CHESS-specific metadata
+        # as well as all spec_motors, scan_columns, and smb_pars
+        nxentry = NXentry(name=spec_config.experiment_type)
+        nxentry.spec_config = dumps(spec_config.dict())
+        nxentry.attrs['station'] = spec_config.station
+        nxentry.spec_scans = NXcollection()
+        for scans in spec_config.spec_scans:
+            nxscans = NXcollection()
+            nxentry.spec_scans[f'{scans.scanparsers[0].scan_name}'] = nxscans
+            nxscans.attrs['spec_file'] = str(scans.spec_file)
+            nxscans.attrs['scan_numbers'] = scans.scan_numbers
+            for scan_number in scans.scan_numbers:
+                scanparser = scans.get_scanparser(scan_number)
+                nxscans[scan_number] = NXcollection()
+                if hasattr(scanparser, 'spec_positioner_values'):
+                    nxscans[scan_number].spec_motors = dumps(
+                        {k:float(v) for k,v
+                         in scanparser.spec_positioner_values.items()})
+                if hasattr(scanparser, 'spec_scan_data'):
+                    nxscans[scan_number].scan_columns = dumps(
+                        {k:list(v) for k,v
+                         in scanparser.spec_scan_data.items() if len(v)})
+                if hasattr(scanparser, 'pars'):
+                    nxscans[scan_number].smb_pars = dumps(
+                        {k:v for k,v in scanparser.pars.items()})
+                if detector_names:
+                    nxdata = NXdata()
+                    nxscans[scan_number].data = nxdata
+                    for detector_name in detector_names:
+                        nxdata[detector_name] = NXfield(
+                           value=scanparser.get_detector_data(detector_name))
+
+        return nxentry
+
+
 class URLReader(Reader):
-    """Reader for data available over HTTPS"""
+    """Reader for data available over HTTPS.
+    """
     def read(self, url, headers={}, timeout=10):
         """Make an HTTPS request to the provided URL and return the
-        results.  Headers for the request are optional.
+        results. Headers for the request are optional.
 
-        :param url: the URL to read
+        :param url: The URL to read.
         :type url: str
-        :param headers: headers to attach to the request, defaults to
-            `{}`
+        :param headers: Headers to attach to the request,
+            defaults to `{}`
         :type headers: dict, optional
-        :return: the content of the response
+        :return: The content of the response.
         :rtype: object
         """
-
+        # System modules
         import requests
 
         resp = requests.get(url, headers=headers, timeout=timeout)
@@ -298,15 +330,17 @@ class URLReader(Reader):
 
 
 class YAMLReader(Reader):
-    """Reader for YAML files"""
+    """Reader for YAML files.
+    """
     def read(self, filename):
         """Return a dictionary from the contents of a yaml file.
 
-        :param filename: name of the YAML file to read from
-        :return: the contents of `filename`
+        :param filename: The name of the YAML file to read from.
+        :type filename: str
+        :return: The contents of the file.
         :rtype: dict
         """
-
+        # Third party modules
         import yaml
 
         with open(filename) as file:
@@ -315,5 +349,7 @@ class YAMLReader(Reader):
 
 
 if __name__ == '__main__':
+    # Local modules
     from CHAP.reader import main
+
     main()