reference
labkit.biosignal.defaultEcgPeakOptions
Return documented defaults for ECG/QRS peak detection.
Syntax
opts = labkit.biosignal.defaultEcgPeakOptions()
opts = labkit.biosignal.defaultEcgPeakOptions(method)Description
Returns a complete starting options structure for one ECG peak detector. Modify only the fields needed for a recording, then pass the structure to labkit.biosignal.detectEcgPeaks. Fields that do not apply to the selected method are omitted, which makes saved settings easier to interpret.
Inputs
method- Optional character vector or scalar string. Canonical values are "qrs-streaming" (default), "pan-tompkins", and "local". Common spellings such as "streaming", "pantompkin", and "simple" are accepted and normalized to a canonical value.
Outputs
opts- Scalar structure containing the selected method and its defaults.
Common Options
method- Canonical detector name.
polarity- Peak direction: "auto", "positive", "negative", or "absolute". The default is "auto".
minDistanceSec- Minimum interval between accepted peaks. The default is 0.25 seconds for qrs-streaming and pan-tompkins, and 0.05 seconds for local.
Local Options
thresholdStd- Number of robust standard deviations above the median score used as the automatic threshold. Default 3.
smoothSec- Moving-average duration applied to the peak score. Default 0.01 seconds.
Pan-Tompkins Options
integrationWindowSec- Moving integration duration for squared QRS-band slope energy. Default 0.150 seconds.
refineSearchSec- Half-width used to move an energy candidate to the nearest peak in the detector trace. Default 0.120 seconds.
rawRefineSearchSec- Half-width for the final move to a peak in the raw signal. Default 0.020 seconds.
Streaming QRS Options
baselineWindowSec- Causal moving-baseline duration. Default 0.600 seconds.
envelopeWindowSec- Causal slope-envelope duration. Default 0.080 seconds.
lookaheadSec- Forward interval used to confirm a local envelope maximum. Default 0.080 seconds.
refineSearchSec- Half-width used to move a candidate from the envelope to the baseline-corrected signal. Default 0.090 seconds.
rawRefineSearchSec- Half-width for the final move to a raw-signal peak. Default 0.020 seconds.
minTemplateScore- Minimum correlation with the rolling QRS template once at least four templates are available. Default 0.45.
medianPolarityCorrection- Logical value that enables a final correction of isolated opposite-polarity anchors. Default true.
medianReviewPeakCount- Number of accepted peaks used by the polarity review. Default 3.
Errors
labkit:biosignal:UnsupportedPeakMethod- method cannot be normalized to a supported detector.
Example
opts = labkit.biosignal.defaultEcgPeakOptions("pan-tompkins");
opts.minDistanceSec = 0.35;Related APIs
labkit.biosignal.detectEcgPeaks— Detect ECG/QRS peaks as event anchors.labkit.biosignal.buildTemplate— Build a representative segment template.labkit.biosignal.compareGroups— Summarize groups and compute pairwise Welch comparisons.labkit.biosignal.cropSignal— Return a signal clipped to a time range in seconds.labkit.biosignal.filterSignal— Apply a zero-phase FFT-domain filter to a biosignal.labkit.biosignal.getChannel— Return one signal from a recording by display name or index.labkit.biosignal.listChannels— Return display names for all channels in a recording.labkit.biosignal.measureSegments— Measure generic template-residual segment quality.
Source
This page is generated from the MATLAB help text in +labkit/+biosignal/defaultEcgPeakOptions.m.