@cleerly/cornerstone-tools
[Deprecated] Use Cornerstone3D Instead https://cornerstonejs.org/
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
3 of 94 committers (3.2%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
[Deprecated] Use Cornerstone3D Instead https://cornerstonejs.org/
Basic Info
Statistics
- Stars: 588
- Watchers: 54
- Forks: 453
- Open Issues: 278
- Releases: 139
Topics
Metadata Files
README.md
🔔🔔🔔🔔 Attention: Cornerstone.js has evolved! We're excited to introduce Cornerstone3D 🚀. Expect advanced rendering, stellar performance, and a modern toolset. 🌐 Navigate to the new repository for the latest updates and improvements.
cornerstone-tools
Provides a simple, extensible framework for creating tools on top of Cornerstone.js. Includes common tool implementations, and leverages DICOM metadata (when available) for advanced functionality.
[**Read The Docs**](https://tools.cornerstonejs.org/) | [Edit the docs](https://github.com/cornerstonejs/cornerstoneTools/edit/master/docs/)
<!-- prettier-ignore-end -->
Index
The Fun Stuff
Everything Else
The problem
Building one or two tools on top of Cornerstone.js is not that difficult. However, as the number of tools grow, you begin to encounter difficult problems:
- Tools should behave and be configurable in a consistant way
- Managing tools across multiple cornerstone
enabled elements - Tools that need knowledge of a fellow tool's state
- The ability to "drop-in" others' tools, and they "just work"
- and many others
This library solves these problems in a highly pluggable and extensible way.
This solution
cornerstone-tools is a light-weight solution for building Tools on top of Cornerstone.js. It's only dependencies are libraries within the Cornerstone family. Instead of trying to "do everything" it aims to be extensible and pluggable to aid in the rapid development of new tools. Ideally, tools created using cornerstone-tools can be easily shared, allowing for the creation of a broader ecosystem.
Example
Below is a simplified example of creating a tool by extending cornerstone-tool's BaseTool class.
```javascript import cornerstone from 'cornerstone-core'; import { BaseTool } from 'cornerstone-tools'; import basicLevelingStrategy from '...';
export default class WwwcTool extends BaseTool { constructor(configuration = {}) { const defaultConfig = { name: 'Wwwc', strategies: { basicLevelingStrategy }, supportedInteractionTypes: ['Mouse', 'Touch'], configuration: { orientation: 0, }, }; const initialConfiguration = Object.assign(defaultConfig, configuration);
super(initialConfiguration);
}
mouseDragCallback(evt) { this.applyActiveStrategy(evt);
cornerstone.setViewport(evt.detail.element, evt.detail.viewport);
}
touchDragCallback(evt) { evt.stopImmediatePropagation(); this.applyActiveStrategy(evt);
cornerstone.setViewport(evt.detail.element, evt.detail.viewport);
} } ```
Installation
This module is distributed via npm which is bundled with node and
should be installed as one of your project's dependencies:
```js // To install the newest version npm install --save cornerstone-tools
// To install the legacy version (2.4.x branch) npm install --save cornerstone-tools@2 ```
This library has peerDependencies listings for:
hammerjs- Better touch supportcornerstone-corecornerstone-math- Simplifies and provides shared complex tool math logic- Any Cornerstone "Image Loader"
cornerstone-web-image-loader- JPEG/PNG imagescornerstone-wado-image-loader- DICOM images; also parses tags for tool use
If you need to support the IE11 Browser, you will need to provide polyfills as needed. Our BrowserList target:
json
"browserslist": [
"> 1%",
"IE 11",
"not dead",
"not IE < 11",
"not op_mini all"
]
Setting up and configuring cornerstone-tools's depency can be the biggest hurdle to getting started. Be sure to check out our docs for assistance.
Examples & Docs
The latest major version has just been published. We are still flushing out our examples. If you have anything you would like to see documented, or you want a specific example from version 2 ported, either create an issue or make a pull request ^_^
Tools
Annotation Tools
3rd Party Tool Plugins
A huge thanks to tool authors, like @sisobus, for sharing their work with the community!
Other Solutions
Contributors
Thanks goes to these people (emoji key):
|
Chris Hafey
📖 💻 📝 📢 |
Erik Ziegler
💻 📖 👀 🚧 🚇 💬 |
Danny Brown
💻 📖 👀 🚧 🚇 🔌 💬 |
James Petts
💻 👀 🔌 📖 💬 |
Steve Pieper
💬 🔧 |
Rodrigo Antinarelli
💻 |
Zaid Safadi
💬 💻 |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
Gustavo André Lelis
💻 |
Kofifus
💻 🔧 🐛 |
Aloïs Dreyfus
💻 |
Tim Leslie
💻 |
diego0020
💻 |
Evren Ozkan
💻 |
Salvador Daniel Pelayo
💻 |
|
Juan Narvaez
💻 |
Mike
📖 💻 ⚠️ |
Sangkeun Kim
💻 💬 |
Victor Saase
🤔 |
Michael Wasser
📖 |
Amandeep Singh
🖋 |
Madison Dickson
📖 |
|
Kevin Lee Drum
💻 |
Makarand Bauskar
💻 |
Biharck Araujo
💡 📖 |
Devon Bernard
📖 |
Karl-Heinrich
🐛 💻 ⚠️ |
counterxing
🐛 💻 |
Jorge Lopes
💬 |
|
Gabriel Garrido
💻 |
ASVBPREAUBV
📖 |
frolic06
💻 |
codepage949
💻 |
Asherah Connor
💻 |
Ikko Ashimine
🐛 |
Bill Wallace
💻 📖 |
|
Bruno Alves de Faria
🐛 💻 🖋 📖 🔌 👀 ⚠️ 🔧 📓 |
Igor Octaviano
💻 📖 🚧 👀 📓 |
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the all-contributors specification. Contributions of any kind welcome!
Issues
Looking to contribute? Look for the Good First Issue label.
🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
❓ Questions
For questions related to using the library, please visit our support community, or file an issue on GitHub.
LICENSE
MIT
Owner
- Name: cornerstone.js
- Login: cornerstonejs
- Kind: organization
- Email: contact@ohif.org
- Website: https://cornerstonejs.org/
- Twitter: OHIFViewer
- Repositories: 19
- Profile: https://github.com/cornerstonejs
JavaScript library to display interactive medical images including but not limited to DICOM
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Ziegler" given-names: "Erik" orcid: "https://orcid.org/0000-0003-1857-8129" - family-names: "Urban" given-names: "Trinity" - family-names: "Brown" given-names: "Danny" - family-names: "Petts" given-names: "James" - family-names: "Pieper" given-names: "Steve D" - family-names: "Lewis" given-names: "Rob" - family-names: "Hafey" given-names: "Chris" - family-names: "Harris" given-names: "Gordon J" title: "Open Health Imaging Foundation Viewer: An Extensible Open-Source Framework for Building Web-Based Imaging Applications to Support Cancer Research" doi: 10.1200/CCI.19.00131 version: 1.0.0 url: "https://github.com/cornerstonejs/cornerstoneTools"
GitHub Events
Total
- Issues event: 5
- Watch event: 14
- Issue comment event: 2
- Pull request event: 1
- Fork event: 5
Last Year
- Issues event: 5
- Watch event: 14
- Issue comment event: 2
- Pull request event: 1
- Fork event: 5
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| dannyrb | d****n@g****m | 948 |
| Erik Ziegler | e****r@u****e | 309 |
| James Petts | j****s@1****k | 225 |
| Erik Ziegler | e****d@g****m | 116 |
| Gustavo Lelis | g****s@g****m | 113 |
| Chris Hafey | c****y@g****m | 75 |
| Mike Hazell | m****l@g****m | 62 |
| allcontributors[bot] | a****] | 49 |
| James Petts | j****s@g****m | 38 |
| Kofifus | m****c@g****m | 28 |
| DREYFUS ALOIS | a****s@i****m | 27 |
| Tim Leslie | t****e@g****m | 25 |
| Evren Ozkan | e****7@g****m | 25 |
| igoroctaviano | i****o@g****m | 21 |
| dependabot[bot] | 4****] | 20 |
| biharck | b****k@g****m | 19 |
| Bruno Alves de Faria | b****a@r****m | 18 |
| Kevin Lee Drum | k****m@g****m | 14 |
| prasath | p****a@r****n | 14 |
| diego0020 | d****0 | 14 |
| Leonardo M. Ramé | m****e@y****m | 11 |
| Bill Wallace | w****0@g****m | 10 |
| ra00l | r****u@g****m | 9 |
| Leonardo Campos | l****s@g****m | 8 |
| Jean-Francois Pambrun | j****n@g****m | 8 |
| David Wire | d****e@g****m | 8 |
| sisobus | s****1@g****m | 8 |
| chafey | c****y@l****t | 7 |
| André Botelho Almeida | a****a@h****m | 7 |
| xingbofeng | 5****1@q****m | 7 |
| and 64 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 105
- Total pull requests: 57
- Average time to close issues: 3 months
- Average time to close pull requests: 9 months
- Total issue authors: 93
- Total pull request authors: 34
- Average comments per issue: 2.44
- Average comments per pull request: 1.39
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 16
Past Year
- Issues: 5
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 9 minutes
- Issue authors: 5
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 1.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Benjamin-JZ (3)
- mkramers (2)
- DMIAOCHEN (2)
- aizela (2)
- kofifus (2)
- ArturRod (2)
- HamzaPooki (2)
- newPeter7 (2)
- acegank (2)
- jackzsj (2)
- ychengrong (1)
- dcox1776 (1)
- kxcy001123 (1)
- bgomes90 (1)
- 1009058470 (1)
Pull Request Authors
- dependabot[bot] (16)
- jlopes90 (6)
- ViniciusResende (6)
- aminahasimbegovic (3)
- sharithg1 (2)
- ata94 (2)
- slak44 (1)
- lecion (1)
- David2k13 (1)
- kevinshen1101 (1)
- horner (1)
- danicaj (1)
- galelis (1)
- dougyau (1)
- ladeirarodolfo (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 35
-
Total downloads:
- npm 28,937 last-month
- Total docker downloads: 426
-
Total dependent packages: 107
(may contain duplicates) -
Total dependent repositories: 187
(may contain duplicates) - Total versions: 910
- Total maintainers: 42
npmjs.org: cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 6.0.10
published over 2 years ago
Rankings
Maintainers (11)
proxy.golang.org: github.com/cornerstonejs/cornerstoneTools
- Documentation: https://pkg.go.dev/github.com/cornerstonejs/cornerstoneTools#section-documentation
- License: mit
-
Latest release: v6.0.10+incompatible
published over 2 years ago
Rankings
proxy.golang.org: github.com/cornerstonejs/cornerstonetools
- Documentation: https://pkg.go.dev/github.com/cornerstonejs/cornerstonetools#section-documentation
- License: mit
-
Latest release: v6.0.10+incompatible
published over 2 years ago
Rankings
npmjs.org: @scollect/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.0.0
published over 6 years ago
Rankings
Maintainers (1)
npmjs.org: @robertklein.sk/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.0.14
published 10 months ago
Rankings
Maintainers (1)
npmjs.org: annotator-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.0.10
published about 4 years ago
Rankings
Maintainers (1)
npmjs.org: @florist/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 2.3.0
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools2-drbrain
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 5.1.32
published over 2 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools-ugs
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.0.10
published over 2 years ago
Rankings
Maintainers (2)
npmjs.org: vindr-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.8
published almost 5 years ago
Rankings
Maintainers (1)
npmjs.org: ichieve-cornerstone-tools2
forked from cornerstone tools v3.2.1, add a new tool for labeling
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.3
published over 6 years ago
Rankings
Maintainers (1)
npmjs.org: vindoc-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.1.6
published about 5 years ago
Rankings
Maintainers (1)
npmjs.org: @vindr/vindr-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.8
published almost 4 years ago
Rankings
Maintainers (1)
npmjs.org: ichieve-cornerstone-tools
forked from cornerstone tools v3.2.1, add a new tool for labeling
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.5
published almost 7 years ago
Rankings
Maintainers (1)
npmjs.org: cs-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 5.1.6
published over 4 years ago
Rankings
Maintainers (1)
npmjs.org: doaction-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.6
published about 5 years ago
Rankings
Maintainers (1)
npmjs.org: vindoc-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.0.8
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: infer-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 2.5.1
published almost 7 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools-dicomsys
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 2.5.1
published over 6 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools-sync
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 5.1.6
published over 4 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools-wys
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 1.0.1
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: opera-cornerstone-tools
Medical imaging tools for the Cornerstone library 4.0.1
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.0.3
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: p-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.0.6
published almost 3 years ago
Rankings
Maintainers (1)
npmjs.org: cornerstone-tools-custom
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.15.1-alpha.1
published about 5 years ago
Rankings
Maintainers (1)
npmjs.org: @docports/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 5.1.6
published over 3 years ago
Rankings
Maintainers (1)
npmjs.org: custom-cornerstone-tools-px
Modified version of cornerstone-tool
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 4.0.1
published over 3 years ago
Rankings
Maintainers (1)
npmjs.org: wx-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 2.4.4
published over 5 years ago
Rankings
Maintainers (1)
npmjs.org: @luminancerealm/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 2023.9.16
published over 2 years ago
Rankings
Maintainers (2)
npmjs.org: @cleerly/cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
- Status: removed
-
Latest release: 2.2.1-rc
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: @unumedai/annotator-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.0.10
published about 2 years ago
Rankings
Maintainers (3)
repo1.maven.org: org.webjars.npm:cornerstone-tools
WebJar for cornerstone-tools
- Homepage: https://www.webjars.org
- Documentation: https://appdoc.app/artifact/org.webjars.npm/cornerstone-tools/
- License: MIT
-
Latest release: 4.21.1
published over 5 years ago
Rankings
npmjs.org: vquest-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 6.0.8
published over 2 years ago
Rankings
Maintainers (1)
npmjs.org: riki-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 3.0.1
published almost 7 years ago
Rankings
Maintainers (1)
npmjs.org: liverlab-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
- Status: unpublished
-
Latest release: 0.0.0-semantically-released
published over 2 years ago
Rankings
Maintainers (1)
npmjs.org: enphy-cornerstone-tools
Medical imaging tools for the Cornerstone library
- Homepage: https://github.com/cornerstonejs/cornerstoneTools
- License: MIT
-
Latest release: 0.0.3
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- gitbook-plugin-edit-link 2.0.2
- gitbook-plugin-ga 1.0.1
- gitbook-plugin-github 2.0.0
- gitbook-plugin-sitemap 1.2.0
- gitbook-plugin-theme-cornerstone 1.1.1
- gitbook-plugin-versions 2.1.4
- sitemap 1.5.0
- underscore 1.9.1
- url-join 0.0.1
- gitbook-plugin-edit-link 2.0.2
- gitbook-plugin-ga 1.0.1
- gitbook-plugin-github 2.0.0
- gitbook-plugin-sitemap 1.2.0
- gitbook-plugin-theme-cornerstone 1.1.1
- gitbook-plugin-versions 2.1.4
- sitemap 1.5.0
- underscore 1.9.1
- url-join 0.0.1
- 1689 dependencies
- @babel/core ^7.5.0 development
- @babel/plugin-transform-runtime ^7.5.0 development
- @babel/preset-env ^7.5.0 development
- all-contributors-cli 5.11.0 development
- babel-jest ^25.1.0 development
- babel-loader ^8.0.4 development
- canvas ^2.9.1 development
- commitizen ^4.0.3 development
- coveralls 3.0.2 development
- cz-conventional-changelog 2.1.0 development
- docma 3.2.2 development
- eslint 4.19.1 development
- eslint-config-prettier 3.3.0 development
- eslint-loader 2.0.0 development
- eslint-plugin-import 2.12.0 development
- eslint-plugin-prettier 3.0.0 development
- gitbook-plugin-edit-link 2.0.2 development
- gitbook-plugin-ga 2.0.0 development
- gitbook-plugin-github 3.0.0 development
- gitbook-plugin-sitemap 1.2.0 development
- husky 3.0.x development
- jest ^25.1.0 development
- jest-junit 5.1.0 development
- lint-staged ^9.2.5 development
- lodash ^4.17.15 development
- nodemon ^2.0.2 development
- prettier 1.18.x development
- semantic-release ^15.13.24 development
- shx ^0.3.2 development
- terser-webpack-plugin ^1.4.1 development
- webpack ^4.35.2 development
- webpack-cli ^3.3.5 development
- webpack-dev-server ^3.7.2 development
- @babel/runtime 7.1.2
- cornerstone-math 0.1.10
- jekyll-feed ~> 0.6 development
- jekyll ~> 3.8.5
- minima ~> 2.0
- tzinfo-data >= 0
- addressable 2.8.0
- colorator 1.1.0
- concurrent-ruby 1.1.4
- em-websocket 0.5.1
- eventmachine 1.2.7
- ffi 1.10.0
- forwardable-extended 2.6.0
- http_parser.rb 0.6.0
- i18n 0.9.5
- jekyll 3.8.5
- jekyll-feed 0.11.0
- jekyll-sass-converter 1.5.2
- jekyll-seo-tag 2.5.0
- jekyll-watch 2.1.2
- kramdown 1.17.0
- liquid 4.0.1
- listen 3.1.5
- mercenary 0.3.6
- minima 2.5.0
- pathutil 0.16.2
- public_suffix 4.0.6
- rb-fsevent 0.10.3
- rb-inotify 0.10.0
- rouge 3.3.0
- ruby_dep 1.5.0
- safe_yaml 1.0.4
- sass 3.7.3
- sass-listen 4.0.0
- tzinfo 2.0.0
- tzinfo-data 1.2018.9