@cornerstonejs/dicom-image-loader 0.1.4

package/.browserslistrc

@@ -0,0 +1,6 @@
+# Browsers that we support
+
+> 1%
+IE 11
+not dead
+not op_mini all

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Chris Hafey (chafey@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,225 @@
+[![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]
+
+# cornerstone WADO Image Loader
+
+A [cornerstone](https://github.com/cornerstonejs/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](http://www.orthanc-server.com/) or custom servers)
+
+## Key Features
+
+- Implements a
+  [cornerstone ImageLoader](https://github.com/cornerstonejs/cornerstone/wiki/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](https://github.com/cornerstonejs/cornerstone/wiki/ImageLoader)
+  for WADO-RS (DICOMWeb)
+- Supports many popular transfer syntaxes and photometric interpretations
+  [see full list](https://github.com/cornerstonejs/cornerstoneWADOImageLoader/blob/master/docs/TransferSyntaxes.md)
+  and [codec](docs/Codecs.md) for more information.
+- Framework to execute CPU intensive tasks in [web workers](docs/WebWorkers.md)
+  - 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!](http://rawgithub.com/cornerstonejs/cornerstoneWADOImageLoader/master/examples/index.html)
+
+You can also see it in action with the
+[cornerstoneDemo application](https://github.com/chafey/cornerstoneDemo).
+
+## Install
+
+Get the distributed unminimized file:
+
+- [cornerstoneWADOImageLoader.js](https://unpkg.com/cornerstone-wado-image-loader)
+
+or the distributed minimized file:
+
+- [cornerstoneWADOImageLoader.bundle.min.js](https://unpkg.com/cornerstone-wado-image-loader)
+
+## Usage
+
+The cornerstoneWADOImageLoader depends on the following external libraries which
+should be loaded before cornerstoneWADOImageLoader.js:
+
+1. [dicomParser](https://github.com/cornerstonejs/dicomParser)
+2. [cornerstone](https://github.com/cornerstonejs/cornerstone)
+
+_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](docs/WebWorkers.md) 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](https://github.com/OHIF/Viewers/blob/33307d3cd28599cbb4d7189560afdd7f65033ab8/platform/viewer/.webpack/webpack.pwa.js#L65)
+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](https://github.com/OHIF/Viewers/blob/33307d3cd28599cbb4d7189560afdd7f65033ab8/platform/viewer/.webpack/webpack.pwa.js#L100)
+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](https://github.com/cornerstonejs/cornerstoneWADOImageLoader/wiki/troubleshooting).
+
+## 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](docs/Building.md)
+
+_How do I add my own custom web worker tasks?_
+
+See the documentation [here](docs/WebWorkers.md)
+
+_How do I create imageIds that work with this image loader?_
+
+See the documentation [here](docs/ImageIds.md)
+
+# What Transfer Syntaxes are supported?
+
+See [transfer syntaxes](docs/TransferSyntaxes.md)
+
+# Copyright
+
+Copyright 2016 Chris Hafey [chafey@gmail.com](mailto:chafey@gmail.com)
+
+<!--
+  LINKS
+-->
+
+<!-- prettier-ignore-start -->
+
+[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
+[license-url]: LICENSE
+
+[npm-url]: https://npmjs.org/package/cornerstone-wado-image-loader
+[npm-version-image]: http://img.shields.io/npm/v/cornerstone-wado-image-loader.svg?style=flat
+[npm-downloads-image]: http://img.shields.io/npm/dm/cornerstone-wado-image-loader.svg?style=flat
+
+[travis-url]: http://travis-ci.org/cornerstonejs/cornerstoneWADOImageLoader
+[travis-image]: https://travis-ci.org/cornerstonejs/cornerstoneWADOImageLoader.svg?branch=master
+
+[coverage-url]: https://coveralls.io/github/cornerstonejs/cornerstoneWADOImageLoader?branch=master
+[coverage-image]: https://coveralls.io/repos/github/cornerstonejs/cornerstoneWADOImageLoader/badge.svg?branch=master
+
+<!-- prettier-ignore-end -->
+
+```
+
+```

package/babel.config.json

@@ -0,0 +1,11 @@
+{
+  "presets": ["@babel/preset-env"],
+  "plugins": [
+    ["@babel/plugin-proposal-object-rest-spread"],
+    ["@babel/plugin-transform-runtime",
+    {
+      "regenerator": true,
+      "corejs": 3
+    }]
+  ]
+}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@cornerstonejs/dicom-image-loader",
+  "version": "0.1.4",
+  "description": "Cornerstone Image Loader for DICOM WADO-URI and WADO-RS and Local file",
+  "keywords": [
+    "DICOM",
+    "WADO",
+    "cornerstone",
+    "medical",
+    "imaging"
+  ],
+  "author": "@cornerstonejs (previously Chris Hafey)",
+  "homepage": "https://github.com/cornerstonejs/cornerstone3D-beta",
+  "license": "MIT",
+  "main": "./dist/cornerstoneDICOMImageLoader.bundle.min.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cornerstonejs/cornerstone3D-beta.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "echo 'build not implemented yet'",
+    "cm": "npx git-cz",
+    "clean": "npm run clean:dist && npm run clean:coverage",
+    "clean:dist": "shx rm -rf dist",
+    "clean:docs": "shx rm -rf documentation",
+    "clean:coverage": "shx rm -rf coverage",
+    "doc": "npm run doc:generate && opn documentation/index.html",
+    "doc:generate": "npm run clean:docs && jsdoc -c .jsdocrc",
+    "eslint": "eslint -c .eslintrc.js src",
+    "eslint-quiet": "eslint -c .eslintrc.js --quiet src",
+    "eslint-fix": "eslint -c .eslintrc.js --fix src",
+    "eslint-fix-test": "eslint -c .eslintrc.js --fix test",
+    "start": "npm run webpack:dev",
+    "start:dev": "webpack-dev-server --config ./config/webpack/webpack-dev",
+    "test": "npm run test:chrome",
+    "test:ci": "echo 'test:ci not implemented yet'",
+    "test:all": "npm run test && npm run test:chrome && npm run test:firefox",
+    "test:chrome": "karma start config/karma/karma-base.js",
+    "test:firefox": "karma start config/karma/karma-firefox.js",
+    "test:watch": "karma start config/karma/karma-watch.js",
+    "watch": "npm run clean && shx mkdir dist && npm run webpack:watch",
+    "dev": "npm run webpack:dev",
+    "webpack:dev": "webpack serve --progress --config ./config/webpack/webpack-dev.js",
+    "webpack:dynamic-import": "webpack --progress --config ./config/webpack/webpack-dynamic-import",
+    "webpack:bundle": "webpack --progress --config ./config/webpack/webpack-bundle",
+    "webpack:dynamic-import:watch": "webpack --progress --watch --config ./config/webpack/webpack-dynamic-import",
+    "webpack:watch": "webpack --progress --watch  --config ./config/webpack",
+    "prepublishOnly": "echo 'prepublishOnly not implemented yet'"
+  },
+  "devDependencies": {
+    "@babel/plugin-proposal-object-rest-spread": "^7.14.7",
+    "@babel/runtime-corejs3": "^7.15.4",
+    "chai": "^4.3.4",
+    "concat": "^1.0.3",
+    "core-js": "^3.26.1",
+    "coveralls": "^3.1.1",
+    "docdash": "^1.2.0",
+    "exports-loader": "^3.0.0",
+    "fs-extra": "^10.0.0",
+    "jsdoc": "^3.6.7",
+    "karma-mocha": "^2.0.1",
+    "lodash": "^4.17.21",
+    "mocha": "^9.1.1",
+    "open-cli": "^7.0.1",
+    "puppeteer": "^10.2.0",
+    "shx": "^0.3.3"
+  },
+  "dependencies": {
+    "@babel/eslint-parser": "^7.19.1",
+    "@cornerstonejs/codec-charls": "^0.1.1",
+    "@cornerstonejs/codec-libjpeg-turbo-8bit": "^0.0.7",
+    "@cornerstonejs/codec-openjpeg": "^0.1.0",
+    "@cornerstonejs/codec-openjph": "^1.0.3",
+    "coverage-istanbul-loader": "^3.0.5",
+    "date-format": "^4.0.14",
+    "dicom-parser": "^1.8.9",
+    "pako": "^2.0.4",
+    "uuid": "^9.0.0"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.{js,jsx,json,css}": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "gitHead": "b5bdf41c08ee5913263c2dac774de4629cf197ce"
+}