README

dicom.ts

A small, super-fast javascript DICOM renderer

We had a requirement to display greyscale, single frame dicom files as quickly as possible in the browser. Cornerstone.js, which seems ubiquitous and feature rich - just seemed too big and complex for the task, and saw that performance could be improved. We thought it was worth investigating accelerating things as much as possible with WebGl.

By tightly integrating the parser, decoders and renderer, moving as much as possibile to the GPU (LUT & palette conversion etc), only allowing modern browsers and using browsers jpeg decoder & safari's native jpeg2000 decoder, some decent perfomance improvements over cornerstone can be seen; ranging from 10% to 1800% faster, depending on the image type and wether it was the first decode of the library. Also library size is about a 5th of using cornerstone core & wado loader, so page load times will be quicker too.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

node
npm

Install via npm

npm install --save dicom.ts

Or clone locally

git clone https://github.com/wearemothership/dicom.ts

Demo

We have provied some demos of how this can be used in your project.

Online demos

Or build and run the demos locally

git clone https://github.com/wearemothership/dicom.ts
cd dicom.ts
npm install
npm run build

dicom.ts vs cornerstone.js performance demo

cd example-vs-cornerstone
npm install
npm start

Some DICOM test files can be found in:

dicom.ts/node_modules/dicom-test-files/

Usage

Some usage examples of how this can be used in you project.

Display on a given canvas

import dicomjs from 'dicom.ts'

const displayDicom = async (canvas, buffer) => {
    try {
        // get the DCM image
        const image = dicomjs.parseImage(buffer);

        // access any tags needed, common ones have parameters
        console.log("PatientID:", image.patientID);
        // or use the DICOM tag group, element id pairs
        console.log("PatientName:", image.getTagValue([0x0010, 0x0010]));

        // create the renderer (keeping hold of an instance for the canvas can
        // improve 2nd image decode performance hugely - see examples)
        const renderer = new dicomjs.Renderer(canvas);

        // decode, and display frame 0 on the canvas
        await renderer.render(image, 0);


    }
    catch (e) {
        // ...
        console.error(e);
    }
}

// get an ArrayBuffer of the file
const dataBuffer = ...

// get your canvas, and ensure add to the DOM
// dicomjs will create one if none provided
const canvas = document.createElement("canvas");
document.body.appendChild(canvas);

displayDicom(canvas, dataBuffer);

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. https://github.com/wearemothership/dicom.ts/blob/main/LICENSE.md

dicom.ts is used in…

vPOP PRO

Please let us know if you wish us to add your project to this list.

Acknowledgements

Parser based heavily on https://github.com/rii-mango/Daikon thank you - RII-UTHSCSA / martinezmj

Made by Mothership

wearemothership.com

Usage no npm install needed!