Skip to content

Commit 3c58032

Browse files
committed
Merge branch 'dev'
2 parents 20c5034 + 739cfe3 commit 3c58032

File tree

12 files changed

+83
-402
lines changed

12 files changed

+83
-402
lines changed

README.md

Lines changed: 56 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,49 @@
1-
----------
1+
<p align="center">
2+
<img src="https://cloud.githubusercontent.com/assets/214063/19763517/a83873fc-9c3e-11e6-8390-229d7749246e.png" width="60%">
3+
</p>
4+
5+
<p align="center">
6+
<a href="https://travis-ci.org/FNNDSC/ami">
7+
<img src="https://travis-ci.org/FNNDSC/ami.svg"
8+
alt="Build Status">
9+
</a>
10+
<a href="https://codeclimate.com/github/FNNDSC/ami">
11+
<img src="https://codeclimate.com/github/FNNDSC/ami/badges/gpa.svg"
12+
alt="Code Climate">
13+
</a>
14+
<a href="https://www.npmjs.com/package/ami.js">
15+
<img src="https://img.shields.io/npm/v/ami.js.svg"
16+
alt="NPM Version">
17+
</a>
18+
<a href="https://www.npmjs.com/package/ami.js">
19+
<img src="https://img.shields.io/npm/dm/ami.js.svg"
20+
alt="NPM Downloads per Month">
21+
</a>
22+
<a href="http://slack.babymri.org">
23+
<img src="https://img.shields.io/badge/slack-join-blue.svg"
24+
alt="Slack">
25+
</a>
26+
</p>
227

3-
**AMI Alpha** is now available for developer preview.</br>
4-
Developper preview means that the API might change but we are confident you can already build cool apps with AMI.</br>
28+
----------
29+
```diff
30+
**AMI Alpha** is now available for developer preview.
531
Please submit pull request, open issues or contact us for any question, feature request, etc.
632

33+
- <Important Note>
34+
- Developer preview means that the API might change but you can already build cool apps with AMI.
35+
```
736
----------
837

9-
[![Build Status](https://travis-ci.org/FNNDSC/ami.svg)](https://travis-ci.org/FNNDSC/ami)
10-
[![Code Climate](https://codeclimate.com/github/FNNDSC/ami/badges/gpa.svg)](https://codeclimate.com/github/FNNDSC/ami)
11-
[![Slack](https://img.shields.io/badge/slack-join-blue.svg)](http://slack.babymri.org)
12-
[![NPM Version](https://img.shields.io/npm/v/ami.js.svg)](https://www.npmjs.com/package/ami.js)
13-
[![NPM Downloads per Month](https://img.shields.io/npm/dm/ami.js.svg)](https://www.npmjs.com/package/ami.js)
14-
15-
16-
# <img align="left" src="https://cloud.githubusercontent.com/assets/214063/14279153/f74bc160-fb2b-11e5-9722-94501b191bc1.png" width="15%"> AMI JS ToolKit (Alpha - 0.0.*)
17-
> A* Medical Imaging (AMI) JS ToolKit for THREEJS
18-
1938
### Content
2039

21-
1. [Lessons](#lessons)
22-
2. [Sandbox](#sandbox)
40+
1. [Hello AMI](#hello-ami)
2341
2. [Features](#features)
24-
3. [Usage](#usage)
25-
4. [Pre-requisites](#pre-requisites)
26-
5. [Use with NPM](#npm)
27-
6. [Use compiled version](#compiled)
28-
7. [API Documentation](https://fnndsc.github.io/ami/doc)
29-
8. [Developer corner](https://fnndsc.github.io/ami/doc)
30-
9. [Credits](#credits)
31-
32-
## Lessons
42+
3. [Usage](#npm)
43+
4. [Developer corner](#developer-corner)
44+
5. [Credits](#credits)
45+
46+
## Hello AMI
3347
<table>
3448
<tr>
3549
<!-- Lesson 00 -->
@@ -166,72 +180,31 @@ Please submit pull request, open issues or contact us for any question, feature
166180
</tr>
167181
</table>
168182

169-
## Sandbox
183+
### (more) Advanced demos
170184

171185
Volume rendering, 2D viewer, arbitrary reslicing and more examples and advanced demos [there](https://fnndsc.github.io/ami)!
172186

173187
## Features
174-
:white_check_mark: READY - :large_orange_diamond: IN PROGRESS OR LIMITED SUPPORT - :x: ON ROADMAP
175-
#### Capabilities
176-
:white_check_mark: 2D Visulization
177-
178-
:white_check_mark: 3D Visualization
179-
180-
:white_check_mark: Volume Rendering
181-
182-
:white_check_mark: Lookup Tables
183-
184-
:large_orange_diamond: Label Maps
185-
186-
#### Widgets
187-
188-
:white_check_mark: Handle (2D/3D)
189-
190-
:white_check_mark: Probe (2D/3D)
191-
192-
:white_check_mark: Ruler (2D/3D)
193-
194-
:large_orange_diamond: Angle (2D/3D)
195-
196-
:large_orange_diamond: Orientation (2D/3D)
197-
198-
#### Volumes
199-
200-
:white_check_mark: Dicom
201-
202-
:white_check_mark: NRRD
188+
> :white_check_mark: READY - :large_orange_diamond: IN PROGRESS OR LIMITED SUPPORT - :x: ON ROADMAP
203189
204-
:white_check_mark: Nifti
205-
206-
:large_orange_diamond: MGH/MGZ
207-
208-
:x: JPEG
209-
210-
#### Meshes
190+
| Capabilities | Volumes | Meshes | Widgets |
191+
|-------------------- |----------- |----------------- |------------------------ |
192+
| ✅ 2D Visulization | ✅ Dicom | ✅ VTK (THREEJS) | 🔶 Handle (2D/3D) |
193+
| ✅ 3D Visualization | ✅ NRRD | ✅ STL (THREEJS) | 🔶 Probe (2D/3D) |
194+
| ✅ Volume Rendering | 🔶 Nifti | 🔶 TRK | 🔶 Ruler (2D/3D) |
195+
| ✅ Lookup Tables | ❌ MGH/MGZ | ❌ CURV | 🔶 Angle (2D/3D) |
196+
| 🔶 Label Maps | ❌ JPEG | ❌ FSM | 🔶 Orientation (2D/3D) |
211197

212-
:white_check_mark: VTK (THREEJS)
213-
214-
:white_check_mark: STL (THREEJS)
215-
216-
:large_orange_diamond: TRK
217-
218-
:large_orange_diamond: FSM
219-
220-
:x: CURV
221-
222-
## Pre-requisites
198+
## Usage
223199

224-
### Modern web browser
225-
AMI relies on ES2015 promises to perform many task so consider using a polyfill if needed.
200+
### Pre-requisites
226201

227-
### THREEJS
228-
Make sure that you are loading THREEJS your index.html **BEFORE** AMI.
202+
* ES2015 promises support. (consider using polyfills if needed)
203+
* Load THREEJS your index.html **BEFORE** AMI.
229204
```
230205
<script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r81/three.js"></script>
231206
```
232207

233-
## Usage
234-
235208
### NPM
236209
```
237210
$> npm install ami.js
@@ -310,6 +283,8 @@ Deploy dist/ to gh-pages
310283
$> npm run deploy
311284
```
312285

286+
Find out more about the [API](https://fnndsc.github.io/ami/doc).
287+
313288
# Credits
314289

315290
AMI would not exist without them:
@@ -346,3 +321,6 @@ AMI would not exist without them:
346321
##### [Pako](https://github.com/nodeca/pako)
347322
* GZ file decompression
348323
* Author(s): [nodeca](https://github.com/nodeca)
324+
325+
##### [Clipart Panda](http://www.clipartpanda.com/)
326+
* [Baby blue dinosaur](http://www.clipartpanda.com/clipart_images/baby-blue-dinosaur-clip-art-37313455)

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"name": "ami.js",
3-
"version": "v0.0.9",
3+
"version": "v0.0.10",
44
"dependencies": {}
55
}

build/ami.js

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

build/ami.min.js

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)