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.WaveformDB — ModuleMain 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:
Header
WaveformDB.adc_gain — Methodadc_gain(s::SignalSpecLine)a getter method for the adc_gain field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.adc_resolution — Methodadc_resolution(s::SignalSpecLine)a getter method for the adc_resolution field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.adc_zero — Methodadc_zero(s::SignalSpecLine)a getter method for the adc_zero field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.base_counter_value — Methodbase_counter_value(h::Header)a getter method for the basecountervalue field in the header
WaveformDB.base_date — Methodbase_date(h::Header)a getter method for the base_date field in the header
WaveformDB.base_time — Methodbase_time(h::Header)a getter method for the base_time field in the header
WaveformDB.baseline — Methodbaseline(s::SignalSpecLine)a getter method for the baseline field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.block_size — Methodblock_size(s::SignalSpecLine)a getter method for the block_size field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.byte_offset — Methodbyte_offset(s::SignalSpecLine)a getter method for the byte_offset field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.checksum — Functionchecksum(h::Header) # retrieves the checksums from a header file
checksum(h::Header,signal) # *calculates* the checksum of a decoded symbolWaveformDB.checksum — Methodchecksum(s::SignalSpecLine)a getter method for the checksum field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.counter_frequency — Methodcounter_frequency(h::Header)a getter method for the counter_frequency field in the header
WaveformDB.description — Methoddescription(s::SignalSpecLine)a getter method for the description field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.filename — Methodfilename(s::SignalSpecLine)a getter method for the filename field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.format — Methodformat(s::SignalSpecLine)a getter method for the format field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.initial_value — Methodinitial_value(s::SignalSpecLine)a getter method for the initial_value field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.nsignals — Methodnsignals(h::Header)number of signal specs present in a header
WaveformDB.number_of_segments — Methodnumber_of_segments(h::Header)a getter method for the numberofsegments field in the header
WaveformDB.number_of_signals — Methodnumber_of_signals(h::Header)a getter method for the numberofsignals field in the header
WaveformDB.parentdir — Methodparentdir(h::Header)a getter method for the parentdir field in the header
WaveformDB.record_name — Methodrecord_name(h::Header)a getter method for the record_name field in the header
WaveformDB.samples_per_frame — Methodsamples_per_frame(s::SignalSpecLine)a getter method for the samplesperframe field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.samples_per_signal — Methodsamples_per_signal(h::Header)a getter method for the samplespersignal field in the header
WaveformDB.sampling_frequency — Methodsampling_frequency(h::Header)a getter method for the sampling_frequency field in the header
WaveformDB.skew — Methodskew(s::SignalSpecLine)a getter method for the skew field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
WaveformDB.units — Methodunits(s::SignalSpecLine)a getter method for the units field in the header. can either be used on:
- Header
- SignalSpecLine
- Vector{SignalSpecLine}
Interface
WaveformDB.rdsignal — Methodrdsignal(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).