Most of this guide consists of UNIX man pages that describe the applications included in the WFDB (Waveform Database) Software Package (and related software from PhysioToolkit). This introduction contains important information about how to interpret the material in the main sections of the guide, and about common conventions for using all of the WFDB applications that are not described in the main sections. The FAQ contains additional information that will be particularly helpful if you are using MS-Windows (but it may be of interest even if you are not).
The organization follows the traditional arrangement of the UNIX Reference Manual: section 1 contains programs, section 3 contains libraries, and section 5 contains file formats. In the UNIX Reference Manual, sections 2 and 4 are reserved for system calls and device interfaces respectively; these sections do not exist in this guide. Following convention, a citation such as rdann(1) refers to the page titled rdann in section 1 of this guide.
A man "page" may span more than one physical page, although most do not. Each man page in section 1 of this guide documents one or more applications, as indicated in the NAME section at the top. The SYNOPSIS appears next; it illustrates the form of the command line needed to run the application. In the synopsis, boldface indicates text to be typed as is, and italics indicate replaceable arguments; brackets (, which are not to be typed) surround arguments that may be omitted, and ellipses (...) follow arguments that can be repeated. The DESCRIPTION sections are intentionally terse; this is a reference manual and not a tutorial introduction to the software described within. In those cases for which relevant tutorial material exists elsewhere, references appear in the SEE ALSO sections of each man page. A unique feature of this guide is the SOURCE section at the end of each page, which provides a URL where you may find the current version of the source(s) for each application.
Under GNU/Linux, Mac OS X, or UNIX, if the WFDB Software Package has been installed on your system, you can also access the information contained in the main sections of this guide using man and related programs. For example, to see the manual page for rdsamp, run the command
man rdsamp(This also works under MS-Windows if you have installed the Cygwin package, which includes the man utility for formatting and reading manual pages.) In some cases you may need to add /usr/local/man to your MANPATH environment variable, in order to make these pages accessible to man.
If you have not used any of these programs before, you may need to set up your environment properly so that WFDB applications can find their input files. See setwfdb(1) for information about doing this; a more detailed discussion may be found in the first chapter of the WFDB Programmer's Guide, in the section about the database path. Most users will not need to do this, however.
Certain types of command arguments are used by many of the applications described in this guide. These include:
Wherever a record name can be supplied to a WFDB application, you may include path information if necessary. For example, if the WFDB path includes the current directory, and if the current directory includes a subdirectory named my_records, and if that directory contains a record named record_23, you can supply my_records/record_23 as a record argument. See the WFDB Programmer's Guide for further details on record names.
Each PhysioBank database directory includes a text file named RECORDS,
which lists the record names for all records in that directory.
Each PhysioBank database directory includes a text file named
ANNOTATORS, which lists the annotator names for all annotation files in
|2:14.875||2 minutes + 14.875 seconds|
|143||143 seconds (2 minutes + 23 seconds)|
|4:02:01||4 hours + 2 minutes + 1 second|
|4:2:1||same as above|
|s12345||12345 sample intervals|
|e||time of the end of the record|
Your comments on this guide, and on the software that it documents, are welcome. Please send them to:
28 November 2018
Up: WFDB Applications Guide
Please e-mail your comments and suggestions to email@example.com, or post them to:PhysioNet
Updated 28 November 2018