Skip to content
Web-based viewer for DICOM Visible Light Whole Slide Microscopy Images
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src fix(api.js): Update DICOMWebClient usage to use mediatypes array form… Jul 16, 2019
test
.gitignore
.npmignore
.travis.yml updating travis ci with build step Feb 6, 2019
LICENSE
README.md Update README Jul 4, 2019
mocha.opts
package-lock.json
package.json Increase package version Jul 22, 2019
rollup.config.js

README.md

Build Status

DICOM Microscopy Viewer

Vanilla JS library for web-based visualization of DICOM VL Whole Slide Microscopy Image datasets.

Motivation and implementation

The library is intended to provide a lightweight and standard-compliant viewer for microscopy images in DICOM format. The viewer relies on Openlayers for rendering pyramid images and dynamically retrieves pyramid tiles (image frames) via DICOMweb WADO-RS using dicomweb-client. However, the viewer API fully abstracts the underlying rendering library and doesn't expose the lower level Openlayers API directly, such that another rendering library could in principle be used in the future if this would be of advantage.

Installation

Install the dicom-microscopy-viewer package using the npm package manager:

npm install dicom-microscopy-viewer

Building and testing

Build and test code locally:

git clone https://github.com/dcmjs-org/dicom-microscopy-viewer ~/dicom-microscopy-viewer
cd ~/dicom-microscopy-viewer
npm install
npm run build
npm test

We use rollup for bundling and mochify for testing (based on mocha and chai).

Usage

<script type="text/javascript" src="https://unpkg.com/dicom-microscopy-viewer"></script>

The viewer can be embedded in any website, one only needs to

  • Create an instance of the VLWholeSlideMicroscopyImageViewer. The constructor requires an instance of DICOMwebClient for retrieving frames from the archive as well as the metadata for each DICOM image instance formatted according to the DICOM JSON Model.

  • Call the render() method, passing it the HTML element (or the name of the element), which shall contain the viewport.

const url = 'http://localhost:8080/dicomweb';
const client = new DICOMwebClient.api.DICOMwebClient({url});
const studyInstanceUID = '1.2.3.4';
const seriesInstanceUID = '1.2.3.5';
const searchInstanceOptions = {
  studyInstanceUID,
  seriesInstanceUID
};
client.searchForInstances(searchInstanceOptions).then((instances) => {
  const promises = []
  for (let i = 0; i < instances.length; i++) {
    const sopInstanceUID = instances[i]["00080018"]["Value"][0];
    const retrieveInstanceOptions = {
      studyInstanceUID,
      seriesInstanceUID,
      sopInstanceUID,
    };
    const promise = client.retrieveInstanceMetadata(retrieveInstanceOptions).then(metadata => {
      const imageType = metadata[0]["00080008"]["Value"];
      if (imageType[2] === "VOLUME") {
        return(metadata[0]);
      }
    });
    promises.push(promise);
  }
  return(Promise.all(promises));
}).then(metadata => {
  metadata = metadata.filter(m => m);
  const viewer = new DICOMMicroscopyViewer.api.VLWholeSlideMicroscopyImageViewer({
    client,
    metadata
  });
  viewer.render({container: 'viewport'});
});

Status

This is work-in-progress and should not be used in clinical practice.

The viewer allows visualization of VL Whole Slide Microscopy Image datasets stored in a DICOMweb compatible archive. It leverages the dicomweb-client JavaScript library to retrieve data from the archive.

Limitations

Currently, the viewer only supports

  • brightfield illumination (no fluorescence)
  • 2D images (no z-stacks)

Citation

Please cite the following article when using the viewer for scientific studies: Herrmann et al. J Path Inform. 2018:

@article{jpathinform-2018-9-37,
    Author={
        Herrmann, M. D. and Clunie, D. A. and Fedorov A. and Doyle, S. W. and Pieper, S. and
        Klepeis, V. and Le, L. P. and Mutter, G. L. and Milstone, D. S. and Schultz, T. J. and
        Kikinis, R. and Kotecha, G. K. and Hwang, D. H. and Andriole, K, P. and Iafrate, A. J. and
        Brink, J. A. and Boland, G. W. and Dreyer, K. J. and Michalski, M. and
        Golden, J. A. and Louis, D. N. and Lennerz, J. K.
    },
    Title={Implementing the {DICOM} standard for digital pathology},
    Journal={Journal of Pathology Informatics},
    Year={2018},
    Number={1},
    Volume={9},
    Number={37}
}

Support

The developers gratefully acknowledge their reseach support:

You can’t perform that action at this time.