Skip to content
This repository has been archived by the owner on Jun 29, 2018. It is now read-only.

Latest commit

 

History

History
executable file
·
138 lines (102 loc) · 3.71 KB

README.md

File metadata and controls

executable file
·
138 lines (102 loc) · 3.71 KB
Raw

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 the live examples to see this library in action!

View the simple image viewer built on cornerstone.

Community

Have questions? Try posting on our google groups forum.

Status

**Project Status: Alpha (Stable) **

NOTE: Project is currently under active development - functionality is not complete, bugs exist, APIs will change and documentation is missing or not correct. The implemented functionality is considered relatively stable.

Make sure to visit the wiki for more information.

Install

Get a packaged source file:

Or install via Bower:

bower install cornerstoneTools

Usage

See the live examples and wiki for documentation on how to use this library

TODO

Features Targeted for V1.0

  • Tools that work with a single image
    • WW/WL
    • Zoom
    • Pan
    • Length
    • Rectangle ROI
    • Elliptical ROI
    • Pixel Probe
    • Angle
  • Tools that work with a stack of images
    • Scroll
    • Cine / Playing Clips
    • Cross reference lines
  • Tools that work with timeseries (4D)
    • Play
    • Scroll
    • Probe
  • Measurement Manager
  • Synchronization tools
    • Stack by image index
    • Stack by image position
    • Image by zoom and pan
    • Sync ww/wc/invert
  • Support for binding each tool to different mouse inputs:
    • Left mouse button
    • Middle mouse button
    • Right mouse button
    • Mouse Wheel
  • Support for touch based gestures
    • Drag
    • Pinch
  • Tool framework that can be used to simplify development of new tools that work in a consistent manner with the included tools
  • Provides API to access measurement data for serialization purposes (e.g. save measurements to database)

Build System

This project uses grunt to build the software.

Pre-requisites:

NodeJs - click to visit web site for installation instructions.

grunt-cli

npm install -g grunt-cli

bower

npm install -g bower

Common Tasks

Update dependencies (after each pull):

npm install

bower install

Running the build:

grunt

Automatically running the build and unit tests after each source change:

grunt watch

Backlog

  • Updating related handles while resizing (e.g. resize top left handle of a rect and update the bottom left and top right as it changes)
  • measurement calibration tool
  • freehand roi tool
  • Config object that allows tool appearance to be customized (e.g. line color, text color, handle size, shape, etc)
  • automatically disabling tools when the enabled element is disabled
  • reconsider the state management api, it is a bit clunky
  • add support for pointer events as an input source
  • Reference line renderer for first/last/active
  • Annotations (e.g. text, arrows, circles)
  • Move all API documentation from wiki into markdown in a doc folder
  • Update to latest hammer.js library
  • key press input source - so user can interact with tools via keyboard (e.g. scroll stack image using arrow keys)

Copyright

Copyright 2015 Chris Hafey [email protected]