Skip to content

Add whitening_seed parameter to MountainSort5 #4600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrishalcrow merged 1 commit into from
Jun 1, 2026
+3 −1
Merged

Add whitening_seed parameter to MountainSort5 #4600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/spikeinterface/sorters/external/mountainsort5.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class Mountainsort5Sorter(BaseSorter):
"freq_max": 6000,
"filter": True,
"whiten": True, # Important to do whitening
"whitening_seed": None, # seed for whitening's random chunk selection (None = nondeterministic)
"delete_temporary_recording": True,
}

Expand All @@ -67,6 +68,7 @@ class Mountainsort5Sorter(BaseSorter):
"freq_max": "Low-pass filter cutoff frequency",
"filter": "Enable or disable filter",
"whiten": "Enable or disable whitening",
"whitening_seed": "Seed for the random data chunks used to estimate the whitening matrix. Set an int for reproducible (deterministic) whitening; None (default) uses fresh randomness each run.",
"delete_temporary_recording": "If True, the temporary recording file is deleted after sorting (this may fail on Windows requiring the end-user to delete the file themselves later)",
}

Expand Down Expand Up @@ -142,7 +144,7 @@ def _run_from_folder(cls, sorter_output_folder, params, verbose):
if p["whiten"]:
if verbose:
print("whitening")
recording = whiten(recording=recording, dtype="float32")
recording = whiten(recording=recording, dtype="float32", seed=p["whitening_seed"])
else:
warn("Not whitening (MountainSort5 expects whitened data)")

Expand Down
Loading