---------- ```diff **AMI Alpha** is now available for developer preview. Please submit pull request, open issues or contact us for any question, feature request, etc. - - Developer preview means that the API might change but you can already build cool apps with AMI. ``` ---------- ### Content 1. [Hello AMI](#hello-ami) 2. [Features](#features) 3. [Usage](#npm) 4. [Developer corner](#developer-corner) 5. [Credits](#credits) 6. [Citations](#citations) ## Hello AMI

	Lesson 00: Load Load DICOM Data and get a nice Series/Stack/Frame structure.		Lesson 01: Visualize 3D Look at the data we loaded in 3D.
	Lesson 02: Mesh Add a mesh to the scene.		Lesson 03: Visualize 2D Look at the data in 2D.
	Lesson 04: Labelmap Overlays on top of you data.		Lesson 05: TRK TRK - coming soon.
	Lesson 06: Volume Rendering Volume Rendering.		Lesson 07: Lookup tables Lookup Tables - coming soon.
	Lesson 08: Custom progress bar Custom progress bars.

### (more) Advanced demos Volume rendering, 2D viewer, arbitrary reslicing and more examples and advanced demos [there](https://fnndsc.github.io/ami)! ## Features > ✅ READY > 🔶 IN PROGRESS OR LIMITED SUPPORT > ❌ ON ROADMAP | Capabilities | Volumes | Meshes | Widgets | |--------------------|--------------|------------------|------------------------| | ✅ 2D Visulization | ✅ Dicom | ✅ VTK (THREEJS) | 🔶 Handle (2D/3D) | | ✅ 3D Visualization | ✅ NRRD | ✅ STL (THREEJS) | 🔶 Probe (2D/3D) | | ✅ Volume Rendering | ✅ Nifti | 🔶 TRK | 🔶 Ruler (2D/3D) | | ✅ Lookup Tables | ✅ MHD/RAW | ❌ FSM | 🔶 Orientation (2D/3D) | | 🔶 Label Maps | ❌ MGH/MGZ | ❌ CURV | 🔶 Angle (2D/3D) | | | ❌ JPEG | | 🔶 Orientation (2D/3D) | ## Usage ### Pre-requisites - ES2015 promises support. (consider using polyfills if needed) - Load THREEJS your index.html **BEFORE** AMI. ```hmtl ``` ### NPM ```bash $> npm install ami.js ``` *Note*: you might need to include [babel](https://github.com/babel/babel) transforms in you build process. ```javascript // app.js const AMI = require('ami.js'); window.console.log('Ready to rock!!'); ``` ### ami.js Check-out the [lessons](#lessons) to get started quickly. Add AMI in your index.html **after** THREEJS. ```html #app.js const AMI = AMI.default; window.console.log('Ready to rock!!'); ``` ## Developer corner Get the source code and related packages. ```bash $> git clone https://github.com/FNNDSC/ami.git $> cd ami $> yarn install --ignore-optional ``` Default task (lint, tests, demo and build) ```bash $> yarn run ``` To run examples (browserify/babelify/serve the example) ```bash $> yarn run example #run the geometries_slice example $> yarn run example geometries_slice ``` To run lessons (browserify/babelify/serve the lesson) ```bash $> yarn run lesson # run lesson 00 $> yarn run lesson 00 ``` Build standalone library to `build/` ```bash $> yarn run build:ami ``` Tests ```bash $> yarn run test ``` Documentation ```bash $> yarn run doc ``` Deploy dist/ to gh-pages ```bash $> yarn run deploy ``` Find out more about the [API](https://fnndsc.github.io/ami/doc). # Credits AMI would not exist without them: ##### [THREEJS](https://github.com/mrdoob/three.js/) - Base components such as Vectors, Matrices and Objects3D. - HTML template for example page. - Author(s): [mrdoob](https://github.com/mrdoob) ##### [DicomParser](https://github.com/chafey/dicomParser) - DICOM parsing relies on it. - Author(s): [chafey](https://github.com/chafey) ##### [CornerstoneWADOImageLoader](https://github.com/chafey/cornerstoneWADOImageLoader) - Was used to figure out how to use the dicom parser properly. - Author(s): [chafey](https://github.com/chafey) ##### [NIFTI-Reader-JS](https://github.com/rii-mango/NIFTI-Reader-JS) - Nifti parsing relies on it. - Author(s): [rii-mango](https://github.com/rii-mango) ##### [NRRD-JS](https://github.com/scijs/nrrd-js) - NRRD parsing relies on it. - Author(s): [jaspervdg](https://github.com/jaspervdg) ##### [JPEGLosslessDecoderJS](https://github.com/rii-mango/JPEGLosslessDecoderJS) - JPEG Lossless Decoder for DICOM images - Author(s): [rii-mango](https://github.com/rii-mango) ##### [Image-JPEG2000](https://github.com/OHIF/image-JPEG2000) - JPEG 2000 Decoder for DICOM images - Author(s): [jpambrun](https://github.com/jpambrun), [mozilla](https://github.com/mozilla/pdf.js/) ##### [Pako](https://github.com/nodeca/pako) - GZ file decompression - Author(s): [nodeca](https://github.com/nodeca) # Citations ### 2017 ### 2016 - [LNICST 2016 - article - Volume Visualization Tools for Medical Applications in Ubiquitous Platforms - Arbelaiz et al.](https://link.springer.com/chapter/10.1007/978-3-319-49655-9_54) - [RSNA 2016 - poster - Interoperable communication of quantitative image analysis results using DICOM standard (DICOM4QI) - Fedorov et al.](https://docs.google.com/presentation/d/16mZbPiXqU7tKTRAcB7bnP1RGybBLqF-O0319raUWYHo/edit#slide=id.p)