Skip to content

Commit c5f839b

Browse files
committed
doc
1 parent a78a7a8 commit c5f839b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

wfdb/records.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,15 +339,18 @@ class MultiRecord(BaseRecord, _headers.MultiHeadersMixin):
339339
The class representing multi-segment WFDB records.
340340
341341
MultiRecord objects can be created as with any other class, or by reading a multi-segment
342-
WFDB record using 'rdsamp' with 'm2s' (multi to single) set to False.
342+
WFDB record using 'rdsamp' with the 'm2s' (multi to single) input parameter set to False.
343343
344344
The attributes of the MultiRecord object give information about the record as specified
345345
by https://www.physionet.org/physiotools/wag/header-5.htm
346346
347-
In addition, the
347+
In addition, the 'segments' parameter is a list of Record objects representing each
348+
individual segment of the entire multi-segment record.
348349
349350
Noteably, the 'multi_to_single' instance method can be called on MultiRecord objects
350-
to return a single segment representation of the record as a Record object.
351+
to return a single segment representation of the record as a Record object. The resulting
352+
Record object will have its 'p_signals' field set.
353+
351354
"""
352355
# Constructor
353356
def __init__(self, segments = None, layout = None,

0 commit comments

Comments
 (0)