Skip to content

Commit b5c260a

Browse files
committed
Update docstring.
1 parent f66ae7f commit b5c260a

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

src/spikeinterface/preprocessing/whiten.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ class WhitenRecording(BasePreprocessor):
1919
recording : RecordingExtractor
2020
The recording extractor to be whitened.
2121
dtype : None or dtype, default: None
22+
Datatype of the output recording (covariance matrix estimation
23+
and whitening are performed in float64.
2224
If None the the parent dtype is kept.
2325
For integer dtype a int_scale must be also given.
2426
mode : "global" | "local", default: "global"
@@ -74,7 +76,8 @@ def __init__(
7476
dtype_ = fix_dtype(recording, dtype)
7577

7678
if dtype_.kind == "i":
77-
assert int_scale is not None, "For recording with dtype=int you must set dtype=float32 OR set a int_scale"
79+
assert int_scale is not None, ("For recording with dtype=int you must set the output dtype to float "
80+
" OR set a int_scale")
7881

7982
if W is not None:
8083
W = np.asarray(W)

0 commit comments

Comments
 (0)