readme.md

Electrode

This library aims to read, parse and visualize DICOM files described in the A.34 section of part3 of the standard. At the moment it has been tested only on 12-Lead Electrocardiogram IOD (section A.34.3).

Install

yarn add electrode-ts or npm install electrode-ts.
Typings are included.

Usage

import { readFile, createInstanceObjects, renderInstance } from "electrode-ts";
import { MultiplexGroup } from "electrode-ts";

const filePath = "test.dcm";

// read dicom file
readFile(filePath).then(dataset => {
  // create instance object
  let instances = createInstanceObjects(dataset);
  // get target div
  let containerDiv = document.getElementById("main-content")!;

  if (instances !== undefined) {
    // create a div for each instance
    let cols = instances.length < 12 ? Math.floor(12 / instances.length) : "";
    instances.forEach((instance, i) => {
      const div = document.createElement("div");
      div.id = `div_${i}`;
      div.classList.add(`col-${cols}`);
      containerDiv.appendChild(div);
      // render the instance passing the target div id 
      renderInstance(div.id, instance as MultiplexGroup);
    });
  }
});

Screeshot

Dev Setup

Download Node.js. Run these commands:

# Install dependencies (only the first time)
yarn install

# Run the local server at localhost:8080
yarn run dev

# Build for production in the dist/ directory
yarn run build

Roadmap

[x] Plotly rendering
[x] Responsive layout
[x] Tools (zoom, pan, ...)
[x] Finalize visualization (axis, grid)
[-] Reworking
[ ] Live example
[ ] Test with different dicom datasets
[ ] Check Axis min/max and units
[ ] Test Performance with more points