Giter VIP home page Giter VIP logo

ami's Introduction

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. Credits

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 โŒ MGH/MGZ โŒ CURV ๐Ÿ”ถ Angle (2D/3D)
๐Ÿ”ถ Label Maps โŒ JPEG โŒ FSM ๐Ÿ”ถ Orientation (2D/3D)

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
$> npm install

Default task (lint, tests, demo and build)

$> npm run

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

$> npm run example <examples name>

#run the geometries_slice example
$> npm run example geometries_slice

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

$> npm run lesson <lesson number>

# run lesson 00
$> npm run lesson 00

Build standalone library to build/

$> npm run build:ami

Tests

$> npm run test

Documentation

$> npm run doc

Deploy dist/ to gh-pages

$> npm run 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

ami's People

Contributors

nicolasrannou avatar rudolphpienaar avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.