add separate save_figure func for saving

Author: TomDonoghue

fooof/plts/utils.py

@@ -199,11 +199,28 @@ def decorated(*args, **kwargs):
         func(*args, **kwargs)
 
         if save_fig:
-            if not file_name:
-                raise ValueError("Input 'file_name' is required to save out the plot.")
-            plt.savefig(fpath(file_path, fname(file_name, 'png')), **save_kwargs)
-
-        if close:
-            plt.close()
+            save_figure(file_name, file_path, close, **save_kwargs)
 
     return decorated
+
+
+def save_figure(file_name, file_path=None, close=False, **save_kwargs):
+    """Save out a figure.
+
+    Parameters
+    ----------
+    file_name : str
+        File name for the figure file to save out.
+    file_path : str or Path
+        Path for where to save out the figure to.
+    close : bool, optional, default: False
+        Whether to close the plot after saving.
+    save_kwargs
+        Additional arguments to pass into the save function.
+    """
+
+    full_path = fpath(file_path, fname(file_name, 'png'))
+    plt.savefig(full_path, **save_kwargs)
+
+    if close:
+        plt.close()

fooof/tests/plts/test_utils.py

@@ -95,3 +95,9 @@ def example_plot():
     # Test does not save when `save_fig` set to False
     example_plot(save_fig=False, file_path=TEST_PLOTS_PATH, file_name='test_savefig_nope.pdf')
     assert not os.path.exists(os.path.join(TEST_PLOTS_PATH, 'test_savefig_nope.pdf'))
+
+def test_save_figure():
+
+    plt.plot([1, 2], [3, 4])
+    save_figure(file_name='test_save_figure.pdf', file_path=TEST_PLOTS_PATH)
+    assert os.path.exists(os.path.join(TEST_PLOTS_PATH, 'test_save_figure.pdf'))