ami-cjs.js v0.0.37-dev

**AMI Alpha** is now available for developer preview.
Please submit pull request, open issues or contact us for any question, feature request, etc.

- <Important Note>
-  Developer preview means that the API might change but you can already build cool apps with AMI.

Content

1. Hello AMI
2. Features
3. Usage
4. Developer corner
5. Credits
6. Citations

Hello AMI

(more) Advanced demos

Volume rendering, 2D viewer, arbitrary reslicing and more examples and advanced demos there!

Features

✅ READY 🔶 IN PROGRESS OR LIMITED SUPPORT ❌ ON ROADMAP

Usage

Pre-requisites

• ES2015 promises support. (consider using polyfills if needed)
• Load THREEJS your index.html BEFORE AMI.

<script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r81/three.js"></script>

NPM

$> npm install ami.js

Note: you might need to include babel transforms in you build process.

// app.js
const AMI = require('ami.js');
window.console.log('Ready to rock!!');

ami.js

Check-out the lessons to get started quickly.

Add AMI in your index.html after THREEJS.

<!-- index.html -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r81/three.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/ami.js/0.0.12/ami.min.js"></script>
<script src="app.js"></script>

#app.js
const AMI = AMI.default;
window.console.log('Ready to rock!!');

Developer corner

Get the source code and related packages.

$> git clone https://github.com/FNNDSC/ami.git
$> cd ami
$> yarn install --ignore-optional

Default task (lint, tests, demo and build)

$> yarn run

To run examples (browserify/babelify/serve the example)

$> yarn run example <examples name>

#run the geometries_slice example
$> yarn run example geometries_slice

To run lessons (browserify/babelify/serve the lesson)

$> yarn run lesson <lesson number>

# run lesson 00
$> yarn run lesson 00

Build standalone library to build/

$> yarn run build:ami

Tests

$> yarn run test

Documentation

$> yarn run doc

Deploy dist/ to gh-pages

$> yarn run deploy

Find out more about the API.

Credits

AMI would not exist without them:

THREEJS

• Base components such as Vectors, Matrices and Objects3D.
• HTML template for example page.
• Author(s): mrdoob

DicomParser

• DICOM parsing relies on it.
• Author(s): chafey

CornerstoneWADOImageLoader

• Was used to figure out how to use the dicom parser properly.
• Author(s): chafey

NIFTI-Reader-JS

• Nifti parsing relies on it.
• Author(s): rii-mango

NRRD-JS

• NRRD parsing relies on it.
• Author(s): jaspervdg

JPEGLosslessDecoderJS

• JPEG Lossless Decoder for DICOM images
• Author(s): rii-mango

Image-JPEG2000

• JPEG 2000 Decoder for DICOM images
• Author(s): jpambrun, mozilla

Pako

• GZ file decompression
• Author(s): nodeca

Citations

2017

2016

• LNICST 2016 - article - Volume Visualization Tools for Medical Applications in Ubiquitous Platforms - Arbelaiz et al.
• RSNA 2016 - poster - Interoperable communication of quantitative image analysis results using DICOM standard (DICOM4QI) - Fedorov et al.