@cornerstonejs/dicom-image-loader

DICOM Image Loader

This package provides a DICOM image loader for the Cornerstone library. This is the successor to the [cornerstoneDICOMImageLoader] which provides the following added features:

• Typescript support (and type definitions)
• Better developer experience (e.g. mono repo, linting, etc)

A cornerstone Image Loader for DICOM P10 instances over HTTP (WADO-URI) or DICOMWeb (WADO-RS) and Local filedisk. This can be used to integrate cornerstone with WADO-URI servers, DICOMWeb servers or any other HTTP based server that returns DICOM P10 instances (e.g. Orthanc or custom servers)

Key Features

• Implements a cornerstone ImageLoader for DICOM P10 Instances via a HTTP get request.
  • Can be used with a WADO-URI server
  • Can be used with Orthanc's file endpoint
  • Can be used with any server that returns DICOM P10 instances via HTTP GET
• Implements a cornerstone ImageLoader for WADO-RS (DICOMWeb)
• Supports many popular transfer syntaxes and photometric interpretations see full list and codec for more information.
• Dynamicly Utilizes WebAssembly (WASM) builds of each codec which sgnificantly improves image decoding performance and enables us to load codec at runtime when needed dynamically, which reduces the build time and complexity.
• Framework to execute CPU intensive tasks in web workers
  • Used for image decoding
  • Can be used for your own CPU intensive tasks (e.g. image processing)

Install

NPM

yarn add @cornerstonejs/dicom-image-loader

Usage

Specify the cornerstone instance you want to register the loader with.

cornerstoneDICOMImageLoader.external.cornerstone = cornerstone;

Have your code configure the web worker framework:

var config = {
  maxWebWorkers: navigator.hardwareConcurrency || 1,
  startWebWorkersOnDemand: true,
};
cornerstoneDICOMImageLoader.webWorkerManager.initialize(config);

See the web workers documentation for more details on configuring.

Dynamic Import

To be able to use the dynamic import feature for CDIL, instead of

import cornerstoneDICOMImageLoader from '@cornerstonejs/dicom-image-loader';

you need to do:

import cornerstoneDICOMImageLoader from '@cornerstonejs/dicom-image-loader/dist/dynamic-import/cornerstoneDICOMImageLoader.min.js';

This way, codecs are loaded dynamically when needed. You have another option to create an alias in the webpack config file:

resolve: {
  alias: {
    '@cornerstonejs/dicom-image-loader':
      '@cornerstonejs/dicom-image-loader/dist/dynamic-import/cornerstoneDICOMImageLoader.min.js',
  },
},

In addition WASM builds of the codec files should be made available in the build folder. You can use CopyWebpackPlugin to copy the WASM files to the build folder.

 plugins: [
  new CopyWebpackPlugin([
    {
      from:
        '../../../node_modules/@cornerstonejs/dicom-image-loader/dist/dynamic-import',
      to: DIST_DIR,
    },
  ]),

Note 1: You need to give the correct path in the CopyWebpackPlugin, the above path is relative to the node_modules folder in the OHIF Viewer.

Note 2: For other http servers like IIS, you need to configure it to serve WASM files with the correct MIME type.

Loading

Backlog

• ESM build for the library
• Make the examples work again
• Free up DICOM P10 instance after decoding to reduce memory consumption
• Look at using EMSCRIPTEN based build of IJG for JPEG
• Add support for bulk data items to WADO-RS Loader
• WebWorker Manager
  • Better handling of web worker loading
  • Add events to webWorkerManager so its activity can be monitored
  • Add support for issuing progress events from web worker tasks

FAQ

Why is this a separate library from cornerstone?

Mainly to avoid adding a dependency to cornerstone for the DICOM parsing library. While cornerstone is intended to be used to display medical images that are stored in DICOM, cornerstone aims to simplify the use of medical imaging and therefore tries to hide some of the complexity that exists within DICOM. It is also desirable to support display of non DICOM images so a DICOM independent image model makes sense.

How do I build this library myself?

See the documentation here

How do I add my own custom web worker tasks?

See the documentation here

How do I create imageIds that work with this image loader?

See the documentation here

What Transfer Syntaxes are supported?

See transfer syntaxes