Medical imaging tools for the Cornerstone library
npm install mv-cornerstone-tools[![NPM version][npm-version-image]][npm-url] [![NPM downloads][npm-downloads-image]][npm-url] [![MIT License][license-image]][license-url] [![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]
cornerstoneTools
================
cornerstoneTools is a library built on top of cornerstone that provides
a set of common tools needed in medical imaging to work with images and stacks of images.
* View live examples of individual tools
* Take a peek at a simple image viewer built on cornerstone
* Check out a more fully featured solution maintained by OHIF
Features
--------
|
|
|
|
| WW/WC | Zoom | Pan | Length |
|
Example / Source |
Example / Source |
Example / Source |
Example / Source |
|
|
|
|
| Rectangle ROI | Elliptical ROI | Pixel Probe | Angle |
|
Example / Source |
Example / Source |
Example / Source |
Example / Source |
|
|
||
| Scroll | Reference Lines | Many More! | |
|
Example / Source |
Example / Source |
Click Here to See a Full List | |
npm install --save cornerstone-tools
npm install --save cornerstone-tools@next
https://unpkg.com/@/path/to/desired-file.js
javascript
// Load NPM packages
import Hammer from 'hammerjs'; // npm install --save hammerjs
import * as cornerstone from 'cornerstone-core'; // npm install --save cornerstone-core
import * as cornerstoneTools from 'cornerstone-tools';
// Specify external dependencies
cornerstoneTools.external.cornerstone = cornerstone;
cornerstoneTools.external.Hammer = Hammer;
``
*Note: cornerstoneTools.external's only need to be specified in cornerstone-tools versions 1.0.0+
A common setup when using package source files:
``javascript
// Load Packaged Sources
// Specify external dependencies
cornerstoneTools.external.cornerstone = cornerstone;
cornerstoneTools.external.Hammer = Hammer;
``
*Note: cornerstoneTools.external's only need to be specified in cornerstone-tools versions 1.0.0+
Contributing
------------
We love contributions, and we have plenty of work queued up for all skill levels. If you have an idea, feel free to create a new topic on our community discussion board, or comment on an existing enhancement, up-for-grabs, bug, documentation issue. A quick "here is how I intend to approach this problem", with sign-off from someone like @swederik, will go a long way toward increasing the chances your hard work will be merged :+1:
How To Contribute:
1. Fork this repository
2. Clone the forked repository
3. Before committing code, create a branch-per-feature, or branch-per-bug
4. Create pull requests against cornerstonejs/cornerstoneTools/master
What To Contribute:
If you're looking to get your feet wet, start by:
- Read existing wiki documentation as you implement your solution. Notice any holes? Fill them in.
- Soon to be replaced by tools.cornerstonejs.org
- Can't find an example of a tool? Or think an example can be improved? Improve it.
- Creating your first tool and learned some lessons along the way? Add documentation to help others.
Can't think of anything? Weigh in on and claim an outstanding issue in the backlog.
Versioning
----------
cornerstoneTools will be maintained under the Semantic Versioning Guidelines as much as possible. Releases will be numbered with the following format: