API Docs

7. API Docs#

7.1. High Level API#

`EncoderParams`	The set of parameters to configure the ECG encoder
`EncodedData`	Encoded bitstream and encoding summary
`encode`	Encodes ECG data into a bitstream
`DecodedData`	Decoded ECG signal and decoding summary
`decode`	Decodes an encoded bitstream
`CompressionStats`	Compression statistics
`compression_stats`	Computes the compression statistics from the original ECG signal, encoded bitstream and decoded signal

`EncodedFrame`	Information about each encoded frame
`EncodedStream`	Information about the encoded bitstream
`encode_frame`	Encodes a single frame of ECG signal
`sense`	Performs windowing, compressing sensing and flattening of ECG signal
`build_sensor`	Constructs a sparse binary sensing matrix based on the encoding parameters.