Git Product home page Git Product logo

cornerstonewadoimageloader's Introduction

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 [email protected]

cornerstonewadoimageloader's People

Contributors

andrebot avatar ayselafsar avatar brunoalvesdefaria avatar campanflaviu avatar chafey avatar dannyrb avatar deminoth avatar diego0020 avatar eloisalgado avatar evren217 avatar fbonnet-creative avatar jdnarvaez avatar jmiha avatar jpambrun avatar kofifus avatar leonardorame avatar lscoder avatar simonmd avatar swederik avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.