FIX: expose sum and maxval modes in public API per reviewer feedback

Author: Famous077

doc/changes/dev/13754.bugfix.rst

@@ -1 +1 @@
-Fix ``mode`` parameter in :func:`~mne.minimum_norm.get_point_spread` and :func:`~mne.minimum_norm.get_cross_talk` to correctly map public mode names (``'max'``, ``'svd'``) to internal names, and raise :class:`ValueError` for invalid mode values, by :newcontrib:`Famous077`.
+Fix ``mode`` parameter in :func:`~mne.minimum_norm.get_point_spread` and :func:`~mne.minimum_norm.get_cross_talk` to correctly map public mode names (``'max'``, ``'svd'``) to internal names, expose previously hidden modes ``'sum'`` and ``'maxval'`` in the public API, and raise :class:`ValueError` for invalid mode values, by :newcontrib:`Famous077`.

mne/minimum_norm/resolution_matrix.py

@@ -160,6 +160,8 @@ def _get_psf_ctf(
                 "max": "maxnorm",
                 "svd": "pca",
                 "mean": "mean",
+                "sum": "sum",
+                "maxval": "maxval",
             }
             funcs, pca_var = _summarise_psf_ctf(
                 funcs, _mode_map[mode], n_comp, return_pca_vars, nn
@@ -199,10 +201,10 @@ def _get_psf_ctf(
 
 def _check_get_psf_ctf_params(mode, n_comp, return_pca_vars):
     """Check input parameters of _get_psf_ctf() for consistency."""
-    valid_modes = (None, "mean", "max", "svd")
+    valid_modes = (None, "mean", "max", "svd", "sum", "maxval")
     if mode not in valid_modes:
         raise ValueError(f"mode must be one of {valid_modes}, got {mode!r} instead.")
-    if mode in [None, "mean"] and n_comp > 1:
+    if mode in [None, "mean", "sum"] and n_comp > 1:
         msg = f"n_comp must be 1 for mode={mode}."
         raise ValueError(msg)
     if mode != "svd" and return_pca_vars:

mne/minimum_norm/tests/test_resolution_matrix.py

@@ -68,9 +68,9 @@ def test_resolution_matrix_free(src_type, fwd_volume_small):
     )
     assert_array_almost_equal(rm_mne_free, rm_mne_free.T)
     # check various summary and normalisation options
-    for mode in [None, "mean", "max", "svd"]:
+    for mode in [None, "mean", "max", "svd", "sum", "maxval"]:
         n_comps = [1, 3]
-        if mode in [None, "sum", "mean"]:
+        if mode in [None, "mean", "sum"]:
             n_comps = [1]
         for n_comp in n_comps:
             for norm in [None, "max", "norm", True]:
@@ -184,9 +184,9 @@ def test_resolution_matrix_fixed():
     # Some arbitrary vertex numbers
     idx = [1, 100, 400]
     # check various summary and normalisation options
-    for mode in [None, "mean", "max", "svd"]:
+    for mode in [None, "mean", "max", "svd", "sum", "maxval"]:
         n_comps = [1, 3]
-        if mode in [None, "mean"]:
+        if mode in [None, "mean", "sum"]:
             n_comps = [1]
         for n_comp in n_comps:
             for norm in [None, "max", "norm", True]: