Skip to content

JenifferWuUCLA/ami

This branch is 208 commits behind FNNDSC/ami:dev.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a3bbdf7 Β· Dec 4, 2017
Nov 15, 2017
Mar 2, 2017
Dec 1, 2017
Mar 16, 2017
Dec 4, 2017
Oct 20, 2016
Nov 16, 2016
Nov 6, 2017
Nov 27, 2017
Sep 1, 2017
Dec 4, 2017
Oct 26, 2017
Nov 2, 2017
Apr 14, 2016
Sep 1, 2017
Sep 1, 2017
Oct 27, 2017
Mar 7, 2017
Nov 23, 2017
Dec 1, 2017
Apr 14, 2016
Nov 23, 2017
Oct 26, 2017
Apr 14, 2016
Apr 26, 2017
Jul 7, 2017
Nov 23, 2017
Nov 23, 2017
Nov 27, 2017
Nov 23, 2017

Repository files navigation

Build Status Code Climate CDNJS Version NPM Version NPM Downloads per Month Slack


**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. Change log
  6. Credits
  7. Citations

Hello AMI

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

(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

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

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>

Yarn

$> yarn add 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;
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

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

$> yarn example <examples name>

#run the geometries_slice example
$> yarn example geometries_slice

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

$> yarn lesson <lesson number>

# run lesson 00
$> yarn lesson 00

Build standalone library to lib/

$> yarn build:ami

Build minified standalone version run

$> yarn build:ami:prod

Tests

$> yarn test

Documentation

$> yarn doc

Build and deploy dist/ to gh-pages

$> yarn deploy

Find out more about the API.

Credits

AMI would not exist without them:

  • Base components such as Vectors, Matrices and Objects3D.
  • HTML template for example page.
  • Author(s): mrdoob
  • DICOM parsing relies on it.
  • Author(s): chafey
  • Was used to figure out how to use the dicom parser properly.
  • Author(s): chafey
  • Nifti parsing relies on it.
  • Author(s): rii-mango
  • NRRD parsing relies on it.
  • Author(s): jaspervdg
  • JPEG Lossless Decoder for DICOM images
  • Author(s): rii-mango
  • GZ file decompression
  • Author(s): nodeca

Citations

2017

2016

About

AMI Medical Imaging (AMI) JS ToolKit for THREEJS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.0%
  • Other 1.0%