Med3Web is a high performance web tool for advanced 2-D and 3-D medical visualizations.
Switch branches/tags
Nothing to show
Clone or download

README.md

Med3Web Dicom 2d/3d web viewer.

Copyright (c) 2015–2018 EPAM Systems, Inc.

Med3Web is a high performance web tool for advanced visualization (both in 2d and 3d modes) medical volumetric data, provided in popular file formats: Dicom, Nifti, Ktx, Hdr. Another popular formats will be planned for future improvements. Med3Web can read local data from files/folders and from predefined web locations. Demonstration project shows both (local data / remote data) usage types. It works as a standalone HTML5 web application. The latest version can be used with WebGL-enabled desktop browsers (Chrome, Firefox, Safari, Opera) and allow limited usage with mobile browsers (Android Chrome).

Background image

Market evaluation

Med3Web can be used in medical center with diagnostic equipment. MRI and CT scanning results can be viewed in any computer (inside medical office and in the client home) and qualified medical personnel can provide diagnosis or conclusion based on provided visualization. Unlike the range of standalone Dicom viewers executables, this app can be used as web application as a part of large web sites and services. Also it can be used by research institutes due to Nifti, Hdr, etc. file standards support (more popular for researchers rather then physicians). Medical centers can create their clients database, based on this viewer.

References

Dicom file format description can be found here and here. Ktx file format details are listed in KTX. Popular Dicom loader framework: GDCM. Some JavaScript libraries to work with Dicom file format:

  1. dicomParser
  2. Daikon
  3. Xtk.

3d volumetric rendering idea in a few words

Three.js is used as some gateway to WebGL renderer. Current Three.js version is not supported 3d textures, so we use tricky way to build 2d texture from initial 3d texture by linking 2d slices all together as a large tile map. This idea (with source codes) can be seen in project WebGL Volume Rendering.

Project documentation

Introduction to the project can be loaded here: Application user interface documentation.

Demo app

Here you can find a demo app.

More datasets

Here you can download more dicom datasets.

Getting started

Load project from git server:

git clone https://github.com/epam/med3web.git

Start operations in order to load all required Node.js packages:

cd med3web
npm install

Prerequisites

Node.js and Tools

Download link: NodeJS.

Version not below than v.6.10.3 is required.

After NodeJS installation please check that everything is installed correctly (for example, PATH ), using command:

node --version

Stdout should be v6.10.3 (or higher).

Then, please install gulp:

npm install -g gulp-cli

Troubleshooting

If you use Node.js v.8.x.x, you may face node-sass installation issue. Please use lower version of Node.js or run command:

npm install node-sass@latest

Project running details

All gulp targets are listed in gulpfile.babel.js.

For the virtual server create process, all source file are "merged" into single file bundle.js which can be found in ./.tmp/scripts.

Browser support

Currently only Chrome, Firefox, Safari, Opera browsers are supported. Other browsers can be used with some performance slowdown and other rendering artefacts. Mobile browsers are not currently supported, but some of them can be used with performance/rendering problems and so on.

Important note concerning project running modes

App can be run in 3 modes:

  1. Run remote web app. Steps: build app locally, performing command "gulp build", then copy ready web app (from dist folder) to your server.
  2. Run local web app under virtual server. Steps: run command "gulp server".
  3. Run local web app. Steps: Build app via command "gulp build" and open file <LocalProjectLocation>/dist/index.html in your browser. Important note: Local run mode (3) is not completely working under Google Chrome browser due to its strong security policy concerning local files opening. Other browsers has no such strong security restrictions and can be used. Local run (mode 3) is not recommended way to use this application.

Build and Run

gulp serve

If browser is not running, please open browser manually and run in command line:

localhost:9000

Build auto documentation

gulp docs

Result will be in folder docs/auto.

Build project ready for server upload

gulp build

Result folder will be in folder dist.

Load data from URL

Application can read Dicom files from specified URL location. There are some important notes to provide correct file naming, access, etc.

How to create your own Dicom files dataset

  1. Prepare folder with Dicom (*.dcm) files in some local folder on your workstation. For example: D:/med3web/data/dicom/lungs It is important to have ONLY *.dcm files inside this folder

  2. Run command

dir *.dcm /b > file_list.txt

This command will add "file_list.txt" file with all *.dcm files listing inside.

  1. Create special file, named ".htaccess" and write following content in it:
Header set Access-Control-Allow-Origin "*"
Header set Access-Control-Allow-Headers "Content-Type"
Header set Access-Control-Allow-Methods "GET"
  1. Copy your local folder (containing *.dcm, .htaccess, file_lists.txt files) into your web server. For example on location: www.mysite.org/med3web/data/lungs

  2. Check correct URL and access possibility for just created folder. Enter in url line:

www.mysite.org/med3web/data/lungs/file_list.txt

You should see *.dcm file listing in browser window.

  1. Run Med3Web application, hosted on your server (dont use virtual server) and select "File -> Open by URL". Enter url
www.mysite.org/med3web/data/lungs

into Input URL text field and press "Load" button. It is important to remove trailing slash from your URL folder name.

If everything fine (your server work correctly) you will see in console window (console window can be open by pressing F12 in Chrome browser) following messages:

Dicom folder os loaded
Loaded file list. NNN files will be loaded. 1st file in list = XXXX.dcm
Loading ratio = 0
Loading ratio = 0.02
Loading ratio = 0.04
...

Contributing

Please read CONTRIBUTING.md for details.

License

Please read LICENSE for details.