Skip to content

Commit f8d5805

Browse files
committed
DOC: add maxval and sum options to mode_pctf docdict entry
1 parent 4e12888 commit f8d5805

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

mne/utils/docs.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2723,7 +2723,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
27232723
"""
27242724

27252725
docdict["mode_pctf"] = """
2726-
mode : None | 'mean' | 'max' | 'svd'
2726+
mode : None | 'mean' | 'max' | 'svd' | 'maxval' | 'sum'
27272727
Compute summary of PSFs/CTFs across all indices specified in 'idx'.
27282728
Can be:
27292729
@@ -2734,6 +2734,9 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
27342734
n_comp largest PSFs/CTFs.
27352735
* 'svd' : SVD components across PSFs/CTFs across vertices. Returns the
27362736
n_comp first SVD components.
2737+
* 'maxval' : PSFs/CTFs with maximum absolute value across vertices.
2738+
Returns the n_comp largest PSFs/CTFs.
2739+
* 'sum' : Sum of PSFs/CTFs across vertices.
27372740
"""
27382741

27392742
docdict["mode_tfr_plot"] = """

0 commit comments

Comments
 (0)