@ohif/core
Advanced tools
@ohif/core is a collection of useful functions and classes for building web-based medical imaging applications. This library helps power OHIF's zero-footprint DICOM viewer.
This library offers pre-packaged solutions for features common to Web-based medical imaging viewers. For example:
It does this while remaining decoupled from any particular view library or rendering logic. While we use it to power our React Viewer, it can be used with Vue, React, Vanilla JS, or any number of other frameworks.
The documentation for this library is sparse. The best way to get started is to look at its top level exports, and explore the source code of features that interest you. If you want to see how we use this library, you can check out our viewer implementation.
This library is pre- v1.0. All releases until a v1.0 have the possibility of introducing breaking changes. Please depend on an "exact" version in your projects to prevent issues caused by loose versioning.
// with npm
npm i @ohif/core --save-exact
// with yarn
yarn add @ohif/core --exact
Usage is dependent on the feature(s) you want to leverage. The bulk of
@ohif/core's features are "pure" and can be imported and used in place.
Example: retrieving study metadata from a server
import { studies } from '@ohif/core';
const studiesMetadata = await studies.retrieveStudiesMetadata(
server, // Object
studyInstanceUIDs, // Array
seriesInstanceUIDs // Array (optional)
);
It is notoriously difficult to setup multiple dependent repositories for end-to-end testing and development. That's why we recommend writing and running unit tests when adding and modifying features for this library. This allows us to program in isolation without a complex setup, and has the added benefit of producing well-tested business logic.
yarn installyarn run devyarn run cmWhen creating tests, place the test file "next to" the file you're testing. For example:
// File
index.js;
// Test for file
index.test.js;
As you add and modify code, jest will watch for uncommitted changes and run
your tests, reporting the results to your terminal. Make a pull request with
your changes to master, and a core team member will review your work. If you
have any questions, please don't hesitate to reach out via a GitHub issue.
Thanks goes to these wonderful people (emoji key):
 Erik Ziegler 💻 |  Evren Ozkan 💻 |  Gustavo André Lelis 💻 |  Danny Brown 💻 | ![allcontributors[bot]](https://avatars3.githubusercontent.com/u/46843839?v=4) allcontributors[bot] 📖 |  Ivan Aksamentov 💻 ⚠️ |
This project follows the all-contributors specification. Contributions of any kind welcome!
MIT © OHIF
3.9.0-beta.25 (2024-05-29)
FAQs
Generic business logic for web-based medical imaging applications
The npm package @ohif/core receives a total of 975 weekly downloads. As such, @ohif/core popularity was classified as not popular.
We found that @ohif/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.