Changed XanesFrameset parameters for hdf_filename to match the conven…

…tion of the importers.
canismarko · Aug 12, 2019 · 4306d88 · 4306d88
1 parent 041bdbd
commit 4306d88
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/tests/test_frameset.py b/tests/test_frameset.py
@@ -148,7 +148,7 @@ def create_frameset(self, store=None, edge=None):
         if edge is None:
             edge = edges.k_edges['Ni_NCA']
         # Create new frameset object
-        fs = XanesFrameset(filename=self.hdf_filename, edge=edge)
+        fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=edge)
         # Mock out the `store` retrieval so we can control it
         if store is None:
             store = MockStore()
@@ -161,16 +161,16 @@ def create_frameset(self, store=None, edge=None):
     def test_init(self):
         # Check if we can pass edges as objects by calling the edge methods
         edge = edges.Edge()
-        fs = XanesFrameset(filename=self.hdf_filename, edge=edge)
+        fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=edge)
         fs.edge.mask(self.dummy_frame_data())
         # Check if we can pass an edge as a class
         Edge = edges.Edge
-        fs = XanesFrameset(filename=self.hdf_filename, edge=Edge)
+        fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=Edge)
         fs.edge.mask(self.dummy_frame_data())
         # Check that passing an edge of None raises a warning
         with warnings.catch_warnings(record=True) as w:
             warnings.resetwarnings()
-            fs = XanesFrameset(filename=self.hdf_filename, edge=None)
+            fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=None)
             self.assertEqual(len(w), 1, 'No "edge is None" warning raised.')
 
     def test_timestamps(self):
@@ -730,13 +730,13 @@ def test_switch_groups(self):
         self.assertEqual(fs.data_name, 'new_group')
 
     def test_repr(self):
-        fs = XanesFrameset(filename=self.hdf_filename, edge=edges.k_edges['Ni_NCA'],
+        fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=edges.k_edges['Ni_NCA'],
                            groupname="ssrl-test-data")
         expected = "<XanesFrameset: 'ssrl-test-data'>"
         self.assertEqual(fs.__repr__(), expected)
 
     def test_str(self):
-        fs = XanesFrameset(filename=self.hdf_filename, edge=edges.k_edges['Ni_NCA'],
+        fs = XanesFrameset(hdf_filename=self.hdf_filename, edge=edges.k_edges['Ni_NCA'],
                            groupname="ssrl-test-data")
         self.assertEqual(str(fs), 'ssrl-test-data')
 
@@ -755,7 +755,7 @@ class OldXanesFramesetTest(XanespyTestCase):
     def setUp(self):
         # Copy the HDF5 file so we can safely make changes
         shutil.copy(self.originhdf, self.temphdf)
-        self.frameset = XanesFrameset(filename=self.temphdf,
+        self.frameset = XanesFrameset(hdf_filename=self.temphdf,
                                       groupname='ssrl-test-data',
                                       edge=edges.k_edges['Ni_NCA'])
 

diff --git a/xanespy/xanes_frameset.py b/xanespy/xanes_frameset.py
@@ -80,10 +80,10 @@ class XanesFrameset():
     # Places to store staged image transformations
     _transformations = None
 
-    def __init__(self, filename, edge, groupname=None):
+    def __init__(self, hdf_filename, edge, groupname=None):
         """Parameters
         ----------
-        filename : str
+        hdf_filename : str
           Path to the HDF file that holds these data.
         edge
           An Edge object (or class) describing the meterial's X-ray
@@ -95,7 +95,7 @@ def __init__(self, filename, edge, groupname=None):
           group.
         
         """
-        self.hdf_filename = filename
+        self.hdf_filename = hdf_filename
         # Validate the edge object
         if edge is None:
             warnings.warn('``edge`` set to ``None``.'

diff --git a/xanespy/xanes_viewer.py b/xanespy/xanes_viewer.py
@@ -65,7 +65,7 @@ def launch_viewer(argv, Presenter):
     else:
         edge = None
     # Get the xanes frameset object
-    fs = XanesFrameset(filename=args.hdf_filename,
+    fs = XanesFrameset(hdf_filename=args.hdf_filename,
                        edge=edge,
                        groupname=groupname)
     # Lauch the Qt viewer