Private Documentation

Documentation for WaveformDB.jl's public interface.

See the Internals section of the manual for internal package docs covering all submodules.

WaveformDB

WaveformDB.WaveformDBModule

Main module for WaveformDB.jl – is a A Julia-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) specifications..

This package is heavily inspired by the original WFDB Software Package, and initially aimed to replicate many of its command-line APIs. However, the projects are independent, and there is no promise of consistency between the two, beyond each package adhering to the core specifications.

WaveformDB.jl can be used to read an ECG signal e.g.:

julia> using WaveformDB

julia> rdrecord("foo.hea")

Exports:

source
WaveformDB.adc_gainMethod
adc_gain(s::SignalSpecLine)

a getter method for the adc_gain field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.adc_resolutionMethod
adc_resolution(s::SignalSpecLine)

a getter method for the adc_resolution field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.adc_zeroMethod
adc_zero(s::SignalSpecLine)

a getter method for the adc_zero field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.baselineMethod
baseline(s::SignalSpecLine)

a getter method for the baseline field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.block_sizeMethod
block_size(s::SignalSpecLine)

a getter method for the block_size field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.byte_offsetMethod
byte_offset(s::SignalSpecLine)

a getter method for the byte_offset field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.checksumFunction
checksum(h::Header) # retrieves the checksums from a header file
checksum(h::Header,signal)  # *calculates* the checksum of a decoded symbol
source
WaveformDB.checksumMethod
checksum(s::SignalSpecLine)

a getter method for the checksum field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.descriptionMethod
description(s::SignalSpecLine)

a getter method for the description field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.filenameMethod
filename(s::SignalSpecLine)

a getter method for the filename field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.formatMethod
format(s::SignalSpecLine)

a getter method for the format field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.initial_valueMethod
initial_value(s::SignalSpecLine)

a getter method for the initial_value field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.samples_per_frameMethod
samples_per_frame(s::SignalSpecLine)

a getter method for the samplesperframe field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.skewMethod
skew(s::SignalSpecLine)

a getter method for the skew field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source
WaveformDB.unitsMethod
units(s::SignalSpecLine)

a getter method for the units field in the header. can either be used on:

  • Header
  • SignalSpecLine
  • Vector{SignalSpecLine}
source

Interface

WaveformDB.rdsignalMethod
rdsignal(h::Header,physical::Bool = true)::Tuple{Int64, Matrix{Int32}}

read the samples described in the header's signal_specs field. Header - a parsed header (.hea) file

physical - optional (defaults to true) Specifies whether to return signals in physical units in the p_signal field (True), or digital units in the d_signal field (False).

source

Readers

Writers

utils