<commit_before>Cornerstone
===========

Cornerstone is a lightweight JavaScript library for displaying medical images in modern web browsers that support
the HTML5 canvas element .  It is not meant to be a complete application itself, but instead a component
that can be used as part of larger more complex applications.  See the
[CornerstoneDemo](https://github.com/chafey/cornerstoneDemo) for an example of using the various Cornerstone
libraries to build a simple study viewer.

Cornerstone is agnostic to the actual container used to store image pixels as well as the transport mechanism
used to get the image data.  In fact, Cornerstone itself has no ability to read/parse or load images and instead
depends on one or more [ImageLoaders](https://github.com/chafey/cornerstone/wiki/ImageLoader) to function.
The goal here is to avoid constraining developers to work within a single container and transport (e.g. DICOM) since
images are stored in a variety of formats (including proprietary).  By providing flexibility with respect to the
container and transport, the highest performance image display may be obtained as no conversion to an alternate
container or transport is required.  It is hoped that developers feel empowered to load images from any type of image
container using any kind of transport.  See the
[CornerstoneWADOImageLoader](https://github.com/chafey/cornerstoneWADOImageLoader) project for an example
of a DICOM WADO based Image Loader.

Cornerstone is agnostic to the exact interaction paradigm being used.  It does not include any mouse, touch or
keyboard bindings to manipulate the various image properties such as scale, translation or ww/wc.  The goal here
is to avoid constraining developers using this library to fit into a given ui paradigm.  It is hoped that developers
are empowered to create new paradigms possibly using new input mechanisms to interact with medical images (e.g.
[Kinect](http://en.wikipedia.org/wiki/Kinect) or [Accelerometer](http://en.wikipedia.org/wiki/Accelerometer).
Cornerstone does provide a set of API's allowing manipulation of the image properoties via javascript.
See the [CornerstoneTools](https://github.com/chafey/cornerstoneTools) library for an example of common tools built on top of
Cornerstone.

Live Examples
---------------
The best way to see the power of this library is to actually see it in use.

[Click here for a list of examples of using the Cornerstone library.](https://rawgithub.com/chafey/cornerstone/master/example/index.html)

Install
-------

Project Status: BETA.  APIs are frozen for 1.0

Get a packaged source file:

* [cornerstone.js](https://raw.githubusercontent.com/chafey/cornerstone/master/dist/cornerstone.js)
* [cornerstone.min.js](https://raw.githubusercontent.com/chafey/cornerstone/master/dist/cornerstone.min.js)

Or install via [Bower](http://bower.io/):

> bower install cornerstone


Key Features
------------

 * HTML5/Javascript based library to easily add interactive medical images to web applications
 * Serves as a foundation to build more complex medical imaging applications from - enterprise viewer, report viewer, etc.
 * Supports all HTML5 based browsers including mobile, tablet and desktop
 * Displays all common medical image formats (e.g. 8 bit grayscale, 16 bit grayscale, RGB color)
 * High performance image display
 * Retrieval of images from different systems with different protocols via Image Loader plugin design
 * API support for changing viewport properties (e.g. ww/wc, zoom, pan, invert)

Build System
============

This project uses grunt to build the software.

Pre-requisites:
---------------

NodeJs - [click to visit web site for installation instructions](http://nodejs.org).

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

Links
=====

[View the wiki for documentation on the concepts and APIs](https://github.com/chafey/cornerstone/wiki)

[View Roadmap](docs/roadmap.md)

[View Backlog](docs/backlog.md)

[comp.protocols.dicom thread](https://groups.google.com/forum/#!topic/comp.protocols.dicom/_2fMh69GdAM)

[Trello](https://trello.com/b/tGTDIyt4/cornerstone)

[CornerstoneTools](https://github.com/chafey/cornerstoneTools) - A library of common tools that can be used with Cornerstone

[CornerstoneWADOImageLoader ](https://github.com/chafey/cornerstoneWADOImageLoader) - A Cornerstone Image Loader that works with WADO

[dicomParser ](https://github.com/chafey/dicomParser) - A JavaScript library designed to parse DICOM for web browsers

Code Contributors
=================
<NAME>
<NAME>

FAQ
===

_Why did you decide to license this library using the open source MIT license?_

The main reason this library is released as [open source](http://en.wikipedia.org/wiki/Open_source) is
that I believe that medical imaging in particular can do a lot more to improve patient outcomes
but the cost of doing so is prohibitive.  Making this library open source removes the cost barrier and will
hopefully usher in a new set of medical imaging based applications.

The old adage [a picture is worth a thousand words](http://en.wikipedia.org/wiki/A_picture_is_worth_a_thousand_words)
is very true in medical imaging.  When a patient is going through a disease process, they often face fear
and confusion.  Medical terminology amplifies these issues as it is hard to understand and therefore
disempowering.  Medical imaging allows a mysterious health issue to be visualized and therefore brings a
level of understanding that just can't be accomplished via textual information found in lab or radiology
reports.  By helping a patient (and its supporting friends/family) connect with the disease visually through
images, it is believed that fear, anxiety and confusion will all be reduced which
will increase optimism and therefore patient outcomes.<commit_msg>fixed link to demo app put contributors in a list<commit_after>Cornerstone
===========

Cornerstone is a lightweight JavaScript library for displaying medical images in modern web browsers that support
the HTML5 canvas element .  It is not meant to be a complete application itself, but instead a component
that can be used as part of larger more complex applications.  See the
[CornerstoneDemo](https://github.com/chafey/cornerstoneDemo) for an example of using the various Cornerstone
libraries to build a simple study viewer.

Cornerstone is agnostic to the actual container used to store image pixels as well as the transport mechanism
used to get the image data.  In fact, Cornerstone itself has no ability to read/parse or load images and instead
depends on one or more [ImageLoaders](https://github.com/chafey/cornerstone/wiki/ImageLoader) to function.
The goal here is to avoid constraining developers to work within a single container and transport (e.g. DICOM) since
images are stored in a variety of formats (including proprietary).  By providing flexibility with respect to the
container and transport, the highest performance image display may be obtained as no conversion to an alternate
container or transport is required.  It is hoped that developers feel empowered to load images from any type of image
container using any kind of transport.  See the
[CornerstoneWADOImageLoader](https://github.com/chafey/cornerstoneWADOImageLoader) project for an example
of a DICOM WADO based Image Loader.

Cornerstone is agnostic to the exact interaction paradigm being used.  It does not include any mouse, touch or
keyboard bindings to manipulate the various image properties such as scale, translation or ww/wc.  The goal here
is to avoid constraining developers using this library to fit into a given ui paradigm.  It is hoped that developers
are empowered to create new paradigms possibly using new input mechanisms to interact with medical images (e.g.
[Kinect](http://en.wikipedia.org/wiki/Kinect) or [Accelerometer](http://en.wikipedia.org/wiki/Accelerometer).
Cornerstone does provide a set of API's allowing manipulation of the image properoties via javascript.
See the [CornerstoneTools](https://github.com/chafey/cornerstoneTools) library for an example of common tools built on top of
Cornerstone.

Live Examples
---------------
The best way to see the power of this library is to actually see it in use.

[Click here for a list of examples of using the Cornerstone library.](https://rawgit.com/chafey/cornerstoneDemo/master/index.html)

Install
-------

Project Status: BETA.  APIs are frozen for 1.0

Get a packaged source file:

* [cornerstone.js](https://raw.githubusercontent.com/chafey/cornerstone/master/dist/cornerstone.js)
* [cornerstone.min.js](https://raw.githubusercontent.com/chafey/cornerstone/master/dist/cornerstone.min.js)

Or install via [Bower](http://bower.io/):

> bower install cornerstone


Key Features
------------

 * HTML5/Javascript based library to easily add interactive medical images to web applications
 * Serves as a foundation to build more complex medical imaging applications from - enterprise viewer, report viewer, etc.
 * Supports all HTML5 based browsers including mobile, tablet and desktop
 * Displays all common medical image formats (e.g. 8 bit grayscale, 16 bit grayscale, RGB color)
 * High performance image display
 * Retrieval of images from different systems with different protocols via Image Loader plugin design
 * API support for changing viewport properties (e.g. ww/wc, zoom, pan, invert)

Build System
============

This project uses grunt to build the software.

Pre-requisites:
---------------

NodeJs - [click to visit web site for installation instructions](http://nodejs.org).

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

Links
=====

[View the wiki for documentation on the concepts and APIs](https://github.com/chafey/cornerstone/wiki)

[View Roadmap](docs/roadmap.md)

[View Backlog](docs/backlog.md)

[comp.protocols.dicom thread](https://groups.google.com/forum/#!topic/comp.protocols.dicom/_2fMh69GdAM)

[Trello](https://trello.com/b/tGTDIyt4/cornerstone)

[CornerstoneTools](https://github.com/chafey/cornerstoneTools) - A library of common tools that can be used with Cornerstone

[CornerstoneWADOImageLoader ](https://github.com/chafey/cornerstoneWADOImageLoader) - A Cornerstone Image Loader that works with WADO

[dicomParser ](https://github.com/chafey/dicomParser) - A JavaScript library designed to parse DICOM for web browsers

Code Contributors
=================

* <NAME>
* <NAME>

FAQ
===

_Why did you decide to license this library using the open source MIT license?_

The main reason this library is released as [open source](http://en.wikipedia.org/wiki/Open_source) is
that I believe that medical imaging in particular can do a lot more to improve patient outcomes
but the cost of doing so is prohibitive.  Making this library open source removes the cost barrier and will
hopefully usher in a new set of medical imaging based applications.

The old adage [a picture is worth a thousand words](http://en.wikipedia.org/wiki/A_picture_is_worth_a_thousand_words)
is very true in medical imaging.  When a patient is going through a disease process, they often face fear
and confusion.  Medical terminology amplifies these issues as it is hard to understand and therefore
disempowering.  Medical imaging allows a mysterious health issue to be visualized and therefore brings a
level of understanding that just can't be accomplished via textual information found in lab or radiology
reports.  By helping a patient (and its supporting friends/family) connect with the disease visually through
images, it is believed that fear, anxiety and confusion will all be reduced which
will increase optimism and therefore patient outcomes.
{'fraction_non_alphanumeric': 0.0756323359232931, 'fraction_numerical': 0.001983798975037196, 'mean_word_length': 4.565317387304508, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 21, 'https://': 26, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6552532', 'n_tokens_mistral': 3296, 'n_tokens_neox': 3118, 'n_words': 1498}