.TH MSE 1 "4 August 2004" "PhysioToolkit" "WFDB Applications Guide"
.SH NAME
mse \- calculates multiscale entropy (MSE) of one or multiple data sets
.SH SYNOPSIS
\fBmse\fR [ \fBoption\fR ... ]
.SH DESCRIPTION
This program reads data (a column of numbers in text form) from its standard
input (or optionally from a list of input files;  see the \fB-F\fR option
below), creates a set of coarse-grained series with a user-selected range
of scales, and calculates sample entropy (SampEn) for each coarse-grained
series.  The user may specify the pattern length (\fIm\fR) and the similarity
criterion (\fIr\fR) for the SampEn calculations, and may select any contiguous
subset of the input data.  The program can also iterate over a set of
user-specified \fIm\fR and \fIr\fR values.  If multiple data sets are provided,
these calculations are performed separately for each data set, and then the
mean and sample deviation of these SampEn values at each scale are calculated.
The results are written to the standard output.
.P
\fIOptions\fR are:
.TP
\fB-a\fR \fIdn\fR
Set the scale increment to \fIdn\fR (1-40; default: 1).
.TP
\fB-b\fR \fIdm\fR
Set the \fIm\fR increment to \fIdm\fR (1-10; default: 1).
.TP
\fB-c\fR \fIdr\fR
Set the scale increment to \fIdr\fR (>0; default: 0.05).
.TP
\fB-F\fR \fIlistfile\fR
Read and process up to 100 data sets from the files named in
\fIlistfile\fR (a text file containing a column of file names).
The output includes results for each file, followed by means and sample
deviations of the per-file results.
.TP
\fB-i\fR \fIn\fR
Begin the analysis with row \fIn\fR of (each) data set.  Rows are numbered
beginning with 0;  by default, analysis begins with row 0.
.TP
\fB-I\fR \fIn\fR
Stop the analysis with row \fIn\fR of (each) data set.  By default, analysis
ends at row 39999, or at the end of the data set if there are fewer rows.
.TP
\fB-m\fR \fIn\fR
Set the minimum \fIm\fR (pattern length for SampEn) to \fIn\fR (1-10;
default: 2).
.TP
\fB-M\fR \fIn\fR
Set the maximum \fIm\fR to \fIn\fR (1-10; default: 2).
.TP
\fB-n\fR \fIn\fR
Set the maximum scale for coarse-graining to \fIn\fR (1-40; default: 20).
.TP
\fB-r\fR \fIn\fR
Set the minimum \fIr\fR (similarity criterion for SampEn) to \fIn\fR (>0;
default: 0.15).
.TP
\fB-R\fR \fIn\fR
Set the maximum \fIm\fR to \fIn\fR (>0; default: 0.15).
.SH EXAMPLE
To obtain MSE results with default settings for the first 40,000 RR intervals
in record nsr047 of the Normal Sinus Rhythm RR Interval Database (nsr2db),
use this command:
.br
     \fBann2rr -r nsr2db/nsr047 -a ecg -A -i s4 | mse\fR
.br
(\fBann2rr\fR(1) reads the \fBecg\fR annotations for the record, calculates
the RR intervals, and writes them to its standard output, which is connected
to \fBmse\fR's standard input. \fBmse\fR reads the intervals and calculates
SampEn for scales 1 through 20, for \fIm\fR = 2 and \fIr\fR = 0.15.)
.PP
For additional examples illustrating the use of \fBmse\fR's options, see
the tutorial at http://www.physionet.org/physiotools/mse/tutorial/.
.SH AUTHOR
Madalena Costa (mcosta@fas.harvard.edu)
.SH SOURCE
http://www.physionet.org/physiotools/mse/mse.c