Skip to content

Commit 5ddb1df

Browse files
authored
Clarify expanded signal format in docstrings (#556)
The docstrings for `e_p_signal` and `e_d_signal` incorrectly stated these could be either a 2D numpy array or a list of 1D numpy arrays. In practice, expanded signals are always stored as a list of 1D numpy arrays to support cases where different channels have different `samps_per_frame` values.
2 parents 860cdb2 + 13bf390 commit 5ddb1df

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

wfdb/io/record.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -712,11 +712,9 @@ class Record(BaseRecord, _header.HeaderMixin, _signal.SignalMixin):
712712
must be set, but not both. In addition, if d_signal is set, fmt, gain
713713
and baseline must also all be set.
714714
e_p_signal : ndarray, optional
715-
The expanded physical conversion of the signal. Either a 2d numpy
716-
array or a list of 1d numpy arrays.
715+
The expanded physical conversion of the signal as a list of 1d numpy arrays.
717716
e_d_signal : ndarray, optional
718-
The expanded digital conversion of the signal. Either a 2d numpy
719-
array or a list of 1d numpy arrays.
717+
The expanded digital conversion of the signal as a list of 1d numpy arrays.
720718
record_name : str, optional
721719
The name of the WFDB record to be read, without any file
722720
extensions. If the argument contains any path delimiter
@@ -2896,11 +2894,9 @@ def wrsamp(
28962894
must be set, but not both. In addition, if d_signal is set, fmt, gain
28972895
and baseline must also all be set.
28982896
e_p_signal : ndarray, optional
2899-
The expanded physical conversion of the signal. Either a 2d numpy
2900-
array or a list of 1d numpy arrays.
2897+
The expanded physical conversion of the signal as a list of 1d numpy arrays.
29012898
e_d_signal : ndarray, optional
2902-
The expanded digital conversion of the signal. Either a 2d numpy
2903-
array or a list of 1d numpy arrays.
2899+
The expanded digital conversion of the signal as a list of 1d numpy arrays.
29042900
samps_per_frame : int or list of ints, optional
29052901
The total number of samples per frame.
29062902
fmt : list, optional

0 commit comments

Comments
 (0)