Package Health Score

63 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
6.0.10	\|	07/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.3.0	\|	08/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.22.1	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.19.3	\|	08/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.18.3	\|	08/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (5,534)

GitHub Stars: 579
Forks: 456
Contributors: 80

Direct Usage Popularity

The npm package cornerstone-tools receives a total of 5,534 downloads a week. As such, we scored cornerstone-tools popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package cornerstone-tools, we found that it has been starred 579 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 80
Funding: No

With more than 10 contributors for the cornerstone-tools repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like cornerstone-tools is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 225
Open PR: 50
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of cornerstone-tools based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for cornerstone-tools is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8.16.0

Age: 8 years
Dependencies: 2 Direct
Versions: 414
Install Size: 5.22 MB
Dist-tags: 5
# of Files: 8
Maintainers: 11
TS Typings: No

cornerstone-tools has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use cornerstone-tools?

To help you get started, we've collected the most common ways that cornerstone-tools is being used within popular public projects.

cornerstonejs / react-cornerstone-viewport / examples / initCornerstone.js View on Github

export default function initCornerstone() {
  // Cornertone Tools
  cornerstoneTools.external.cornerstone = cornerstone;
  cornerstoneTools.external.Hammer = Hammer;
  cornerstoneTools.external.cornerstoneMath = cornerstoneMath;

  //
  cornerstoneTools.init();

  // Preferences
  const fontFamily =
    'Work Sans, Roboto, OpenSans, HelveticaNeue-Light, Helvetica Neue Light, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif';
  cornerstoneTools.textStyle.setFont(`16px ${fontFamily}`);
  cornerstoneTools.toolStyle.setToolWidth(2);
  cornerstoneTools.toolColors.setToolColor('rgb(255, 255, 0)');
  cornerstoneTools.toolColors.setActiveColor('rgb(0, 255, 0)');

  cornerstoneTools.store.state.touchProximity = 40;

  // IMAGE LOADER
  cornerstoneWADOImageLoader.external.cornerstone = cornerstone;

View more ways to use cornerstone-tools

🔔🔔🔔🔔 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 | Edit the docs

Index

The Fun Stuff

TOOL EXAMPLES
- Create or Update an Example

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.

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:

// 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 support
cornerstone-core
cornerstone-math - Simplifies and provides shared complex tool math logic
Any Cornerstone "Image Loader"
- cornerstone-web-image-loader - JPEG/PNG images
- cornerstone-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:

  "browserslist": [
    "&gt; 1%",
    "IE 11",
    "not dead",
    "not IE &lt; 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.

> Docs

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

Image Statistics: Source | Demo
Rotated Elliptical ROI Tool: Source | Demo

A huge thanks to tool authors, like @sisobus, for sharing their work with the community!

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} 💻 📖 🚧 👀 📓

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.

See Bugs

💡 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.

Google Group

LICENSE

MIT

cornerstone-tools dependencies

@babel/runtime cornerstone-math

FAQs

What is cornerstone-tools?

Medical imaging tools for the Cornerstone library. Visit Snyk Advisor to see a full health score report for cornerstone-tools, including popularity, security, maintenance & community analysis.

Is cornerstone-tools popular?

The npm package cornerstone-tools receives a total of 5,534 weekly downloads. As such, cornerstone-tools popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cornerstone-tools well maintained?

We found indications that cornerstone-tools is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is cornerstone-tools safe to use?

The npm package cornerstone-tools was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 06:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP