ENH: Add eSSS

docs/source/settings/preprocessing/maxfilter.md

@@ -17,6 +17,8 @@ tags:
         - mf_reference_run
         - mf_cal_fname
         - mf_ctc_fname
+        - mf_esss
+        - mf_esss_reject
         - mf_mc
         - mf_mc_t_step_min
         - mf_mc_t_window

docs/source/v1.5.md.inc

@@ -4,6 +4,7 @@
 
 - Added support for annotating bad segments based on head movement velocity (#757 by @larsoner)
 - Added examples of T1 and FLASH BEM to website (#758 by @larsoner)
+- Added support for extended SSS (eSSS) in Maxwell filtering (#762 by @larsoner)
 
 [//]: # (### :warning: Behavior changes)
 

mne_bids_pipeline/_config.py

@@ -681,6 +681,16 @@
     ```
 """  # noqa : E501
 
+mf_esss: int = 0
+"""
+Number of extended SSS (eSSS) basis projectors to use from empty-room data.
+"""
+
+mf_esss_reject: Optional[Dict[str, float]] = None
+"""
+Rejection parameters to use when computing the extended SSS (eSSS) basis.
+"""
+
 mf_mc: bool = False
 """
 If True, perform movement compensation on the data.

mne_bids_pipeline/_run.py

@@ -220,7 +220,9 @@ def wrapper(*args, **kwargs):
                     emoji = "🔂"
                 else:
                     # Check our output file hashes
-                    out_files_hashes = memorized_func(*args, **kwargs)
+                    # Need to make a copy of kwargs["in_files"] in particular
+                    use_kwargs = copy.deepcopy(kwargs)
+                    out_files_hashes = memorized_func(*args, **use_kwargs)
                     for key, (fname, this_hash) in out_files_hashes.items():
                         fname = pathlib.Path(fname)
                         if not fname.exists():
@@ -303,8 +305,8 @@ def save_logs(*, config: SimpleNamespace, logs) -> None:  # TODO add type
 
 
 def _update_for_splits(
-    files_dict: Dict[str, BIDSPath],
-    key: str,
+    files_dict: Union[Dict[str, BIDSPath], BIDSPath],
+    key: Optional[str],
     *,
     single: bool = False,
     allow_missing: bool = False,