DICOM WADO Image Loader for the cornerstone library
jssuttles and swederik chore(webpack): Fixed failing build (#222)
* fixed build failing because of webpack/webpack#8082

* used yarn instead of npm, making ci fail
Latest commit abc3608 Sep 27, 2018
Permalink
Failed to load latest commit information.
codecs fix(jpeg.js) Fix decoder jpeg lossy bug (#203) May 25, 2018
config feat(dev-server) Add webpack-dev-server and hot reloading for develop… Jul 16, 2018
docs Switch /chafey/ references to /cornerstonejs/ Dec 6, 2017
examples fix(pixelSpacing) Fix Pixel spacing is mistakenly being set to 1.0 / … Jul 19, 2018
scripts Chore: Get DIST folder removed and ignored by git. (#183) Apr 10, 2018
src fix(tests) Remove odd timeout from lossy image tests Jul 19, 2018
test Adding timeouts everywhere that need to load the image Jul 19, 2018
testImages fix(pixelSpacing) Fix Pixel spacing is mistakenly being set to 1.0 / … Jul 19, 2018
.babelrc es6 May 19, 2017
.eslintignore ES6 support Apr 19, 2017
.eslintrc.js Remove jQuery and Bootstrap JS from examples Dec 15, 2017
.gitignore feat(webWorker) Allow disabling of Web Workers through configuration (#… Apr 11, 2018
.jsdocrc ES6 support Apr 19, 2017
.npmignore Chore: Get DIST folder removed and ignored by git. (#183) Apr 10, 2018
.travis.yml feat(webWorker) Allow disabling of Web Workers through configuration (#… Apr 11, 2018
Contributors.md * Added more documentation Aug 22, 2016
LICENSE updated to bower package, added license Apr 14, 2014
README.md Update README: Project file links from rawgit to unpkg (#188) Apr 11, 2018
changelog.md Bump to version 2.1.4 Jul 11, 2018
package-lock.json chore(webpack): Fixed failing build (#222) Sep 27, 2018
package.json chore(webpack): Fixed failing build (#222) Sep 27, 2018

README.md

NPM version NPM downloads MIT License Build Status Coverage Status

cornerstone WADO Image Loader

A cornerstone Image Loader for DICOM P10 instances over HTTP (WADO-URI) or DICOMWeb (WADO-RS). 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)

Troubleshooting

Having problems viewing your images with cornerstonWADOImageLoader? Check out the troubleshooting guide.

Live Examples

Click here for a live example of this library in use!

You can also see it in action with the cornerstoneDemo application.

Install

Get the distributed unminimized files:

or the distributed minimized files:

Usage

The cornerstoneWADOImageLoader depends on the following external libraries which should be loaded before cornerstoneWADOImageLoader.js:

  1. dicomParser
  2. cornerstone

New in 1.0.0: Specify the cornerstone instance you want to register the loader with.

cornerstoneWADOImageLoader.external.cornerstone = cornerstone;

Have your code configure the web worker framework with the paths to the web worker and the codecs:

   var config = {
        webWorkerPath : '../../dist/cornerstoneWADOImageLoaderWebWorker.js',
        taskConfiguration: {
            'decodeTask' : {
                codecsPath: '../dist/cornerstoneWADOImageLoaderCodecs.js'
            }
        }
    };
    cornerstoneWADOImageLoader.webWorkerManager.initialize(config);

See the web workers documentation for more details on configuring.

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.
  • 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)

Backlog

  • Support for images with pixel padding
  • Support for high bit (e.g. mask out burned in overlays)
  • Free up DICOM P10 instance after decoding to reduce memory consumption
  • Add support for compressed images to WADO-RS loader
  • Look at using EMSCRIPEN based build of IJG for JPEG
  • Consolidate all EMSCRIPTEN codecs into one build to cut down on memory use and startup times
  • Add support for bulk data items to WADO-RS Loader
  • 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

Copyright

Copyright 2016 Chris Hafey chafey@gmail.com