WFDB Software Package 10.7.0

File: <base>/doc/wag-src/rxr.1 (4,168 bytes)
.TH RXR 1 "22 November 2002" "WFDB 10.3.0" "WFDB Applications Guide"
.SH NAME
rxr \- ANSI/AAMI-standard run-by-run annotation comparator
.SH SYNOPSIS
\fBrxr -r\fR \fIrecord\fR \fB-a\fR \fIreference-annotator test-annotator\fR [ \fIoptions ... \fR ]
.SH DESCRIPTION
.PP
Using options \fB-C\fR, \fB-L\fR, or \fB-S\fR, \fIrxr\fR implements the
run-by-run comparison algorithms described in ANSI/AAMI EC38:1998, the American
National Standard for Ambulatory ECGs, and in ANSI/AAMI EC57:1998, the American
National Standard for Testing and Reporting Performance Results of Cardiac
Rhythm and ST Segment Measurement Algorithms.  \fBrxr\fR is the reference
implementation of these algorithms, and must be used to obtain the run-by-run
performance statistics cited in EC38 and EC57 in order to be in compliance with
the standards (see EC38, section 5.2.14, and EC57, section 4.2).
.PP
Input to this program consists of two annotation files associated with the same
\fIrecord\fR.  One of these is designated the \fIreference\fR annotation file,
the other the \fItest\fR annotation file (called the `algorithm' annotation
file in EC38 and in EC57).
.PP
\fIOptions\fR include:
.TP
\fB-c\fR \fIfile\fR
Append condensed reports to \fIfile\fR.
.TP
\fB-C\fR \fIfile\fR
As for \fB-c\fR, but report SVE run statistics also.
.TP
\fB-f\fR \fItime\fR
Begin the comparison at the specified \fItime\fR (default: 5 minutes after the
beginning of the record).
.TP
\fB-h\fR
Print a usage summary.
.TP
\fB-l\fR \fIfile\fR
Append line-format reports (EC57 Table A.7 format) to \fIfile\fR (see below).
.TP
\fB-L\fR \fIfile file2\fR
As for \fB-l\fR, but report SVE run statistics in \fIfile2\fR.
.TP
\fB-s\fR \fIfile\fR
Append standard reports (EC38 section 5.2.14, EC57 Tables 7, 8 format) to
\fIfile\fR.
.TP
\fB-S\fR \fIfile\fR
As for \fB-s\fR, but report SVE run statistics also.
.TP
\fB-t\fR \fItime\fR
Stop the comparison at the specified \fItime\fR (default: the end of the record
if it is defined, the end of the reference annotation file otherwise;  if
\fItime\fR is 0, the comparison ends when the end of either annotation file is
reached).
.TP
\fB-v\fR
Verbose mode (list all discrepancies;  see below).
.TP
\fB-w\fR \fItime\fR
Set the \fImatch window\fR (default: 0.15 seconds;  see below).
.PP
.PP
At most one of \fB-c\fR, \fB-C\fR, \fB-l\fR, \fB-L\fR, \fB-s\fR, and \fB-S\fR
can be given as an option.  If `\fB-\fR' is given as a \fIfile\fR argument,
reports are written on the standard output.  If no options are specified,
\fIrxr\fR writes standard reports on the standard output (equivalent to using
the option \fB-s -\fR).  The output generated by selecting \fB-l\fR or
\fB-L\fR includes column headings only if a \fIfile\fR other than `\fB-\fR' is
specified, and only if the specified \fIfile\fR does not already exist.  In
this way, \fIrxr\fR can be used repeatedly to build up a line-format table for
multiple records, for further processing by \fBsumstats\fR(1).
.PP
The \fB-v\fR option specifies that each mismatch is described on the standard
output in a format similar to:
.br
	3/5(120188-121065)
.br
where the first number is the reference run length, the second is the test
run length (each of these is between 0 and 6), and the numbers in parentheses
indicate the location of the match window in sample intervals.
.SH ENVIRONMENT
.PP
It may be necessary to set and export the shell variable \fBWFDB\fR (see
\fBsetwfdb\fR(1)).
.SH BUGS
.PP
Since \fBrxr\fR performs multiple passes over its input files, it cannot be
used at the end of a pipe.
.SH SEE ALSO
\fBbxb\fR(1), \fBecgeval\fR(1), \fBepicmp\fR(1), \fBmxm\fR(1),
\fBsetwfdb\fR(1), \fBsumstats\fR(1)
.PP
\fIEvaluating ECG Analyzers\fR
(in the \fIWFDB Applications Guide\fR)
.br
\fIAmbulatory Electrocardiographs\fR (ANSI/AAMI EC38:1998)
.br
\fITesting and Reporting Performance Results of Cardiac Rhythm and ST
Segment Measurement Algorithms\fR (ANSI/AAMI EC57:1998)
.PP
The last two of these publications are available from AAMI, 1110 N Glebe Road,
Suite 220, Arlington, VA 22201 USA (http://www.aami.org/).
.SH AUTHOR
George B. Moody (george@mit.edu)
.SH SOURCE
http://www.physionet.org/physiotools/wfdb/app/rxr.c