Skip to content

DICOM electrocardiography (ECG) rendering for Node.js and browser using dcmjs

License

Notifications You must be signed in to change notification settings

HeartLab/dcmjs-ecg

 
 

Repository files navigation

NPM version NPM downloads build MIT License

dcmjs-ecg

DICOM electrocardiography (ECG) rendering for Node.js and browser using Steve Pieper's dcmjs library.

Note

This effort is a work-in-progress and should not be used for production or clinical purposes.

Install

Node.js

npm install dcmjs-ecg

Browser

<script type="text/javascript" src="https://unpkg.com/dcmjs"></script>
<script type="text/javascript" src="https://unpkg.com/dcmjs-ecg"></script>

Build

npm install
npm run build

Usage

// Import objects in Node.js
const dcmjsEcg = require('dcmjs-ecg');
const { DicomEcg } = dcmjsEcg;

// Import objects in Browser
const { DicomEcg } = window.dcmjsEcg;

// Create an ArrayBuffer with the contents of the DICOM P10 ECG byte stream.
const ecg = new DicomEcg(arrayBuffer);

// Create rendering options.
const renderingOpts = {
  // Optionally provide the rendering speed in millimeter per second.
  // If not provided, the default value of 25 millimeter per second is used.
  speed: 25.0,
  // Optionally provide the rendering amplitude in millimeter per millivolt.
  // If not provided, the default value of 5 millimeter per millivolt is used.
  amplitude: 5.0,
  // Optionally apply a Butterworth low pass filter with 40Hz cut off frequency.
  // If not provided, the filter is not applied.
  applyLowPassFilter: false
};

// Render ECG.
const renderingResult = ecg.render(renderingOpts);

// Rendered waveform in SVG format.
const svg = renderingResult.svg;

// Array of key-value-unit objects containing waveform information and interpretation.
const info = renderingResult.info;

Please check a live example here.

Related libraries

  • dcmjs-dimse - DICOM DIMSE implementation for Node.js using dcmjs.
  • dcmjs-imaging - DICOM image and overlay rendering pipeline for Node.js and browser using dcmjs.

License

dcmjs-ecg is released under the MIT License.

About

DICOM electrocardiography (ECG) rendering for Node.js and browser using dcmjs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.5%
  • TypeScript 1.5%