You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -335,27 +335,28 @@ Input Arguments:
335
335
- ``recordname`` (required): The string name of the WFDB record to be written (without any file extensions).
336
336
- ``extension`` (required): The string annotation file extension.
337
337
- ``sample`` (required): The annotation location in samples relative to the beginning of the record. Numpy array.
338
-
- ``symbol (default=None): The symbols used to display the annotation labels. List or numpy array. If this field
339
-
is present, 'label_store' must not be present.
338
+
- ``symbol`` (default=None): The symbols used to display the annotation labels. List or numpy array. If this field is present, 'label_store' must not be present.
340
339
- ``subtype`` (default=None): The marked class/category of each annotation. Numpy array.
341
-
- ``chan (default=None): The signal channel associated with each annotation. Numpy array.
342
-
- ``num ``(default=None): The labelled annotation number of each annotation. Numpy array.
340
+
- ``chan`` (default=None): The signal channel associated with each annotation. Numpy array.
341
+
- ``num`` (default=None): The labelled annotation number of each annotation. Numpy array.
343
342
- ``aux_note`` (default=None): The auxiliary information strings. List or numpy array.
344
-
- ``label_store`` (default=None): The integer values used to store the annotation labels. Numpy array.
345
-
If this field is present, 'symbol' must not be present.
343
+
- ``label_store`` (default=None): The integer values used to store the annotation labels. Numpy array. If this field is present, 'symbol' must not be present.
346
344
- ``fs`` (default=None): The numerical sampling frequency of the record to be written to the file.
347
-
- ``custom_labels`` (default=None): The map of custom defined annotation labels used for this annotation, in
348
-
addition to the standard WFDB annotation labels. The custom labels are defined by two or three fields:
345
+
- ``custom_labels`` (default=None): The map of custom defined annotation labels used for this annotation, in addition to the standard WFDB annotation labels. The custom labels are defined by two or three fields:
346
+
349
347
- The integer values used to store custom annotation labels in the file (optional)
350
348
- Their short display symbols
351
349
- Their long descriptions.
350
+
352
351
This input argument may come in four formats:
352
+
353
353
1. A pandas.DataFrame object with columns: ['label_store', 'symbol', 'description']
354
354
2. A pandas.DataFrame object with columns: ['symbol', 'description']
355
355
If this option is chosen, label_store values are automatically chosen.
356
356
3. A list or tuple of tuple triplets, with triplet elements representing: (label_store, symbol, description).
357
357
4. A list or tuple of tuple pairs, with pair elements representing: (symbol, description).
358
358
If this option is chosen, label_store values are automatically chosen.
359
+
359
360
If the 'label_store' field is given for this function, and 'custom_labels' is defined, 'custom_labels'
360
361
must contain 'label_store' in its mapping. ie. it must come in format 1 or 3 above.
0 commit comments