@cleerly/cornerstone-wado-image-loader
[Deprecated] Use Cornerstone3D Instead https://cornerstonejs.org/
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
2 of 49 committers (4.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
[Deprecated] Use Cornerstone3D Instead https://cornerstonejs.org/
Basic Info
Statistics
- Stars: 286
- Watchers: 41
- Forks: 265
- Open Issues: 164
- Releases: 43
Topics
Metadata Files
README.md
:no_entry: [DEPRECATED] Active at new home @cornerstonejs/dicom-image-loader
This repo is no longer supported, please consider using @cornerstonejs/dicom-image-loader instead. There you can find - Typescript support (and type definitions) - Better developer experience (e.g. mono repo, linting, etc)
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)
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)
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 file:
or the distributed minimized file:
Usage
The cornerstoneWADOImageLoader depends on the following external libraries which should be loaded before cornerstoneWADOImageLoader.js:
New in 1.0.0: Specify the cornerstone instance you want to register the loader with.
javascript
cornerstoneWADOImageLoader.external.cornerstone = cornerstone;
Have your code configure the web worker framework:
javascript
var config = {
maxWebWorkers: navigator.hardwareConcurrency || 1,
startWebWorkersOnDemand: true,
};
cornerstoneWADOImageLoader.webWorkerManager.initialize(config);
See the web workers documentation for more details on configuring.
Upgrade to CWIL v4.x
Cornerstone-WADO-Image-Loader (CWIL) v4.0.x has been released, which adds support for using WebAssembly (WASM) builds of each codec. This significantly improves image decoding performance and enables us to load codec at runtime when needed dynamically, which reduces the build time and complexity.
In addition, we have improved the image loading performance in CWIL v4.x. In previous versions of CWIL, image loading includes fetching AND decoding an image before returning a promise completion, preventing more requests from being made until the queue is empty. This limitation has been fixed in CWIL v4, which separates image retrieval and decoding into two steps. Now after an image is retrieved, a new request is sent to the server immediately.
| | Improvement | | ------------------- | -------------------------------------------------- | | CWIL Bundle Size | 30x smaller (3.0 MB vs 87 kb with dynamic import) | | JPEG Baseline Codec | 4.5x faster (2.87 ms for 512x512 16 bit CT Slice) | | JPEG 2000 Codec | 1.8x faster (41.02 ms for 512x512 16 bit CT Slice) |
Steps to upgrade
Dynamic Import
In v4.x, we have added dynamic importing support for the codecs as needed. To be able to use such feature, instead of
js
import cornerstoneWADOImageLoader from 'cornerstone-wado-image-loader';
you need to do:
js
import cornerstoneWADOImageLoader from 'cornerstone-wado-image-loader/dist/dynamic-import/cornerstoneWADOImageLoader.min.js';
This way, codecs are loaded dynamically when needed. You have another option to create an alias in the webpack config file as we do here for OHIF Viewer.
js
resolve: {
alias: {
'cornerstone-wado-image-loader':
'cornerstone-wado-image-loader/dist/dynamic-import/cornerstoneWADOImageLoader.min.js',
},
},
In addition WASM builds of the codec files should be made available in the build
folder. We use CopyWebpackPlugin to copy the WASM files to the build folder.
See
here
for how we do it in OHIF Viewer.
js
plugins: [
new CopyWebpackPlugin([
{
from:
'../../../node_modules/cornerstone-wado-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.
Troubleshooting
Having problems viewing your images with cornerstonWADOImageLoader? Check out the troubleshooting guide.
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 EMSCRIPTEN 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
What Transfer Syntaxes are supported?
Copyright
Copyright 2016 Chris Hafey chafey@gmail.com
```
```
Owner
- Name: cornerstone.js
- Login: cornerstonejs
- Kind: organization
- Email: contact@ohif.org
- Website: https://cornerstonejs.org/
- Twitter: OHIFViewer
- Repositories: 19
- Profile: https://github.com/cornerstonejs
JavaScript library to display interactive medical images including but not limited to DICOM
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Ziegler" given-names: "Erik" orcid: "https://orcid.org/0000-0003-1857-8129" - family-names: "Urban" given-names: "Trinity" - family-names: "Brown" given-names: "Danny" - family-names: "Petts" given-names: "James" - family-names: "Pieper" given-names: "Steve D" - family-names: "Lewis" given-names: "Rob" - family-names: "Hafey" given-names: "Chris" - family-names: "Harris" given-names: "Gordon J" title: "Open Health Imaging Foundation Viewer: An Extensible Open-Source Framework for Building Web-Based Imaging Applications to Support Cancer Research" doi: 10.1200/CCI.19.00131 version: 1.0.0 url: "https://github.com/cornerstonejs/cornerstoneWADOImageLoader"
GitHub Events
Total
- Issues event: 1
- Watch event: 4
- Issue comment event: 9
- Fork event: 2
Last Year
- Issues event: 1
- Watch event: 4
- Issue comment event: 9
- Fork event: 2
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| chafey | c****y@g****m | 131 |
| Erik Ziegler | e****d@g****m | 96 |
| DREYFUS ALOIS | a****s@i****m | 31 |
| Leonardo Campos | l****s@g****m | 19 |
| Alireza | a****i@g****m | 18 |
| James A. Petts | j****s@g****m | 18 |
| Gustavo André Lelis | g****s@g****m | 9 |
| Danny Brown | d****n@g****m | 9 |
| Kofifus | m****c@g****m | 7 |
| Bill Wallace | w****0@g****m | 5 |
| Ouwen Huang | o****g@d****u | 5 |
| dependabot[bot] | 4****] | 5 |
| Andre Botelho | a****a@h****m | 5 |
| Erik Ziegler | e****r@u****e | 4 |
| chafey | c****y@l****t | 4 |
| Evren Ozkan | e****7@g****m | 3 |
| Jason Hostetter | j****r@g****m | 3 |
| sisobus | s****1@g****m | 3 |
| maltempi | t****i@g****m | 3 |
| Aysel Afsar | a****r@g****m | 2 |
| Saucistophe | S****e | 2 |
| rodrigobasilio2022 | 1****2 | 2 |
| Zaid Safadi | z****i@h****m | 2 |
| Frédéric Bonnet | f****t@g****r | 2 |
| Simon Rascovsky | s****d@g****m | 1 |
| SangYeob Bono Yu | d****h@g****m | 1 |
| diego0020 | d****0 | 1 |
| Georg Grab | g****b@o****m | 1 |
| kevin | 3****6@q****m | 1 |
| Davide Punzo | p****e@h****t | 1 |
| and 19 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 61
- Total pull requests: 56
- Average time to close issues: 23 days
- Average time to close pull requests: 2 months
- Total issue authors: 56
- Total pull request authors: 21
- Average comments per issue: 2.23
- Average comments per pull request: 2.27
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 12
Past Year
- Issues: 3
- Pull requests: 0
- Average time to close issues: 2 days
- Average time to close pull requests: N/A
- Issue authors: 2
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- DarineZeyad (3)
- sedghi (2)
- ali-hashem-hamed (2)
- minigemzhen (2)
- syedkibrahim (1)
- lambacini (1)
- jcardell4 (1)
- toropok (1)
- newPeter7 (1)
- 1009058470 (1)
- will093 (1)
- AmrGablla (1)
- Cadda (1)
- jpchev (1)
- facuescobar (1)
Pull Request Authors
- sedghi (13)
- dependabot[bot] (12)
- Ouwen (6)
- rodrigobasilio2022 (5)
- wayfarer3130 (4)
- selimcanglr (2)
- NikGurev (1)
- IbrahimCSAE (1)
- Punzo (1)
- zqian11 (1)
- kunjesh1 (1)
- horner (1)
- syed-qure (1)
- laura-borghesi-lum00n (1)
- lscoder (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 18
-
Total downloads:
- npm 39,471 last-month
- Total docker downloads: 343
-
Total dependent packages: 77
(may contain duplicates) -
Total dependent repositories: 164
(may contain duplicates) - Total versions: 262
- Total maintainers: 23
npmjs.org: cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 4.13.2
published over 2 years ago
Rankings
Maintainers (10)
proxy.golang.org: github.com/cornerstonejs/cornerstonewadoimageloader
- Documentation: https://pkg.go.dev/github.com/cornerstonejs/cornerstonewadoimageloader#section-documentation
- License: mit
-
Latest release: v4.13.2+incompatible
published over 2 years ago
Rankings
proxy.golang.org: github.com/cornerstonejs/cornerstoneWADOImageLoader
- Documentation: https://pkg.go.dev/github.com/cornerstonejs/cornerstoneWADOImageLoader#section-documentation
- License: mit
-
Latest release: v4.13.2+incompatible
published over 2 years ago
Rankings
npmjs.org: @cleerlycode/cornerstone-wado-image-loader
Cornerstone ImageLoader for DICOM WADO-URI
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 2.0.0
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: cz-cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.3.0-cz-0.0.1
published almost 5 years ago
Rankings
Maintainers (1)
npmjs.org: opera-cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS 3.0.7
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.0.12
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: iyunto-cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 4.13.2-iyunto-0.0.1
published 5 months ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-wado-image-loader-addcache
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.0.6
published almost 6 years ago
Rankings
Maintainers (1)
npmjs.org: @scollect/cornerstone-wado-image-loader
Cornerstone ImageLoader for DICOM WADO-URI
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 2.2.13
published 10 months ago
Rankings
Maintainers (1)
npmjs.org: dk-cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.0.7
published over 4 years ago
Rankings
Maintainers (1)
npmjs.org: @dcyao/cornerstone-wado-image-loader
测试基石的库和修改基石的源码
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 1.6.0
published about 1 year ago
Rankings
Maintainers (1)
npmjs.org: vindr-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.0.8
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-fs-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 0.0.2
published almost 6 years ago
Rankings
Maintainers (1)
npmjs.org: @cleerly/cornerstone-wado-image-loader
Cornerstone ImageLoader for DICOM WADO-URI
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
- Status: removed
-
Latest release: 2.0.1
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: @fang-bing-jiang/cornerstone-wado-image-loader
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 0.2.4
published 6 months ago
Rankings
Maintainers (1)
npmjs.org: image-loader-yj
[![NPM version][npm-version-image]][npm-url] [![NPM downloads][npm-downloads-image]][npm-url] [![MIT License][license-image]][license-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coverage-image]][coverage-url]
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 3.0.4
published over 1 year ago
Rankings
Maintainers (1)
repo1.maven.org: org.webjars.npm:cornerstone-wado-image-loader
WebJar for cornerstone-wado-image-loader
- Homepage: https://www.webjars.org
- Documentation: https://appdoc.app/artifact/org.webjars.npm/cornerstone-wado-image-loader/
- License: MIT
-
Latest release: 3.1.2
published over 5 years ago
Rankings
npmjs.org: @elegentin/cornerstone-wado-image-loader
测试基石的库和修改基石的源码
- Homepage: https://github.com/cornerstonejs/cornerstoneWADOImageLoader
- License: MIT
-
Latest release: 1.6.5
published 11 months ago
Rankings
Maintainers (1)
Dependencies
- 1233 dependencies
- @babel/core ^7.15.4 development
- @babel/plugin-proposal-object-rest-spread ^7.14.7 development
- @babel/plugin-transform-runtime ^7.15.0 development
- @babel/preset-env ^7.15.4 development
- @babel/runtime-corejs3 ^7.15.4 development
- @webpack-cli/serve ^1.5.2 development
- babel-eslint ^10.1.0 development
- babel-loader ^8.2.2 development
- chai ^4.3.4 development
- clean-webpack-plugin ^4.0.0 development
- commitizen 4.2.x development
- concat ^1.0.3 development
- copy-webpack-plugin 9.0.1 development
- core-js ^3.17.2 development
- cornerstone-core ^2.5.0 development
- coveralls ^3.1.1 development
- cross-env ^7.0.3 development
- docdash ^1.2.0 development
- eslint ^7.32.0 development
- eslint-config-prettier ^8.3.0 development
- eslint-loader ^4.0.2 development
- eslint-plugin-import ^2.24.2 development
- eslint-plugin-prettier ^4.0.0 development
- exports-loader ^3.0.0 development
- fs-extra ^10.0.0 development
- istanbul-instrumenter-loader ^3.0.1 development
- jsdoc ^3.6.7 development
- karma ^6.3.4 development
- karma-chrome-launcher ^3.1.0 development
- karma-coverage ^2.0.3 development
- karma-firefox-launcher ^2.1.1 development
- karma-mocha ^2.0.1 development
- karma-spec-reporter 0.0.32 development
- karma-webpack ^5.0.0 development
- lint-staged ^11.1.2 development
- lodash ^4.17.21 development
- mocha ^9.1.1 development
- open-cli ^7.0.1 development
- prettier ^2.3.2 development
- puppeteer ^10.2.0 development
- semantic-release ^17.4.7 development
- shx ^0.3.3 development
- terser-webpack-plugin ^5.2.2 development
- webpack ^5.51.2 development
- webpack-bundle-analyzer ^4.4.2 development
- webpack-cli ^4.8.0 development
- webpack-dev-server 4.1.0 development
- worker-loader ^3.0.8 development
- @cornerstonejs/codec-charls ^0.1.1
- @cornerstonejs/codec-libjpeg-turbo-8bit ^0.0.7
- @cornerstonejs/codec-openjpeg ^0.1.0
- dicom-parser ^1.8.9
- pako ^2.0.4