feat: Load data from a matflow workflow

Author: mikesmic

defdap/base.py

@@ -44,7 +44,7 @@ class Map(ABC):
 
     """
     def __init__(self, file_name, data_type=None, experiment=None,
-                 increment=None, frame=None, map_name=None):
+                 increment=None, frame=None, map_name=None, **kwargs):
         """
 
         Parameters
@@ -83,8 +83,12 @@ def __init__(self, file_name, data_type=None, experiment=None,
         self.grain_plot = None
         self.profile_plot = None
 
-        self.file_name = Path(file_name)
-        self.load_data(self.file_name, data_type=data_type)
+        self.file_name = None
+        if isinstance(file_name, str):
+            file_name = Path(file_name)
+        if isinstance(file_name, (str, Path)):
+            self.file_name = file_name
+        self.load_data(file_name, data_type=data_type, **kwargs)
 
         self.data.add_generator(
             'proxigram', self.calc_proxigram, unit='', type='map', order=0,

defdap/ebsd.py

@@ -148,7 +148,7 @@ def __init__(self, *args, **kwargs):
         )
 
     @report_progress("loading EBSD data")
-    def load_data(self, file_name, data_type=None):
+    def load_data(self, file_name, data_type=None, **kwargs):
         """Load in EBSD data from file.
 
         Parameters
@@ -160,7 +160,7 @@ def load_data(self, file_name, data_type=None):
 
         """
         data_loader = EBSDDataLoader.get_loader(data_type, file_name)
-        data_loader.load(file_name)
+        data_loader.load(file_name, **kwargs)
 
         metadata_dict = data_loader.loaded_metadata
         self.shape = metadata_dict['shape']

defdap/file_readers.py

@@ -640,7 +640,8 @@ def get_loader(data_type: str) -> 'Type[DICDataLoader]':
                 'openpiv': OpenPivTextLoader,    #Backwards compatability
                 'openpivtext': OpenPivTextLoader,
                 'openpivbinary': OpenPivBinaryLoader,
-                'pyvale': PyValeLoader
+                'pyvale': PyValeLoader,
+                'matflow': MatflowLoader,
             }[data_type]
         except KeyError:
             raise ValueError(f"No loader for DIC data of type {data_type}.")
@@ -790,6 +791,7 @@ def load(self, file_name: pathlib.Path) -> None:
 
         self.check_data()
 
+
 class OpenPivBinaryLoader(DICDataLoader):
     def load(self, file_name: pathlib.Path) -> None:
         """ Load from Open PIV .npz file.
@@ -902,6 +904,45 @@ def load(self, file_name: pathlib.Path) -> None:
         self.check_data()
 
 
+class MatflowLoader(DICDataLoader):
+    def load(self, data_dict: Dict[str, Any], step_index: int = 0) -> None:
+        """ Load from matflow workflow element output.
+
+        Parameters
+        ----------
+        data_dict
+            Dictionary with keys:
+                'ss_x'
+                'ss_y'
+                'u'
+                'v'
+
+        """
+        # Software name and version
+        self.loaded_metadata['format'] = 'PyVale'
+        self.loaded_metadata['version'] = 'n/a'
+
+        # Sub-window width in pixels
+        binning_x = np.diff(data_dict['ss_x'], axis=1)
+        binning = int(binning_x[0, 0])
+        assert np.all(binning_x == binning)
+        binning_y = np.diff(data_dict['ss_y'], axis=0)
+        assert np.all(binning_y == binning)
+        self.loaded_metadata['binning'] = binning
+        self.loaded_metadata['shape'] = data_dict['ss_x'].shape
+
+        self.checkMetadata()
+
+        self.loaded_data.coordinate = np.stack(
+            (data_dict['ss_x'], data_dict['ss_y'])
+        )
+        self.loaded_data.displacement = np.stack(
+            (data_dict['u'][step_index], data_dict['v'][step_index])
+        )
+
+        self.check_data()
+
+
 def read_until_string(
     file: TextIO,
     term_string: str,

defdap/hrdic.py

@@ -185,7 +185,7 @@ def crystal_sym(self):
         return self.ebsd_map.crystal_sym
 
     @report_progress("loading HRDIC data")
-    def load_data(self, file_name, data_type=None):
+    def load_data(self, file_name, data_type=None, **kwargs):
         """Load DIC data from file.
 
         Parameters
@@ -197,7 +197,7 @@ def load_data(self, file_name, data_type=None):
 
         """
         data_loader = DICDataLoader.get_loader(data_type)
-        data_loader.load(file_name)
+        data_loader.load(file_name, **kwargs)
 
         metadata_dict = data_loader.loaded_metadata
         self.format = metadata_dict['format']      # Software name