update readme
This commit is contained in:
dannyrb
parent
a5b0e15369
commit
75288d986d
@ -1,54 +1,87 @@
|
|||||||
# @ohif/extension-cornerstone
|
# @ohif/extension-cornerstone
|
||||||
|
|
||||||
## Commands
|
This extension adds support for viewing and manipulating 2D medical images via a
|
||||||
|
viewport. The underlying implementation wraps the
|
||||||
|
`cornerstonejs/react-cornerstone-viewport`, and provides basic commands and
|
||||||
|
toolbar buttons for common actions.
|
||||||
|
|
||||||
This extensions includes the following `Commands` and `Command Definitions`. These can be registered with `@ohif/core`'s `CommandManager`. After registering the commands, they can be bound to `hotkeys` using the `HotkeysManager` and listed in the `UserPreferences` modal.
|
<!-- TODO: Simple image or GIF? -->
|
||||||
|
|
||||||
You can read more about [`Commands`](), [`Hotkeys`](), and the [`UserPreferences` Modal]() in their respective locations in the OHIF Viewer's documentation.
|
#### Index
|
||||||
|
|
||||||
| Command Name | Description | Store Contexts |
|
Extension Id: `cornerstone`
|
||||||
| ---------------------------- | ----------- | -------------- |
|
|
||||||
| `rotateViewportCW` | | viewports |
|
|
||||||
| `rotateViewportCCW` | | viewports |
|
|
||||||
| `invertViewport` | | viewports |
|
|
||||||
| `flipViewportVertical` | | viewports |
|
|
||||||
| `flipViewportHorizontal` | | viewports |
|
|
||||||
| `scaleUpViewport` | | viewports |
|
|
||||||
| `scaleDownViewport` | | viewports |
|
|
||||||
| `fitViewportToWindow` | | viewports |
|
|
||||||
| `resetViewport` | | viewports |
|
|
||||||
| clearAnnotations | TODO | |
|
|
||||||
| next/previous Image | TODO | |
|
|
||||||
| first/last Image | TODO | |
|
|
||||||
| `nextViewportDisplaySet` | | none |
|
|
||||||
| `previousViewportDisplaySet` | | none |
|
|
||||||
|
|
||||||
### TODO:
|
- [Commands Module](#commands-module)
|
||||||
|
- [Toolbar Module](#toolbar-module)
|
||||||
|
- [Viewport Module](#viewport-module)
|
||||||
|
|
||||||
_SET TOOL_
|
## Commands Module
|
||||||
|
|
||||||
- [] Default Tool
|
This extensions includes the following `Commands` and `Command Definitions`.
|
||||||
- [] Set Zoom Tool
|
These can be registered with `@ohif/core`'s `CommandManager`. After registering
|
||||||
- [] Set WWWC Tool
|
the commands, they can be bound to `hotkeys` using the `HotkeysManager` and
|
||||||
- [] Set Pan Tool
|
listed in the `UserPreferences` modal.
|
||||||
- [] Set Angle Measurement Tool
|
|
||||||
- [] Set Stack Scroll Tool
|
|
||||||
- [] Set Magnify Tool
|
|
||||||
- [] Set Length Tool
|
|
||||||
- [] Set Annotate Tool
|
|
||||||
- [] Set Pixel Probe Tool
|
|
||||||
- [] Set Elliptical ROI Tool
|
|
||||||
- [] Set Rectangle ROI Tool
|
|
||||||
|
|
||||||
_OTHER_
|
You can read more about [`Commands`][docs-commands], [`Hotkeys`][docs-hotkeys],
|
||||||
|
and the [`UserPreferences` Modal][docs-userprefs] in their respective locations
|
||||||
|
in the OHIF Viewer's documentation.
|
||||||
|
|
||||||
- Show/Hide CINE
|
| Command Name | Description | Store Contexts |
|
||||||
- W/L Presets
|
| ---------------------------- | --------------------------------------- | -------------- |
|
||||||
- W/L Presets config
|
| `rotateViewportCW` | | viewports |
|
||||||
|
| `rotateViewportCCW` | | viewports |
|
||||||
|
| `invertViewport` | | viewports |
|
||||||
|
| `flipViewportVertical` | | viewports |
|
||||||
|
| `flipViewportHorizontal` | | viewports |
|
||||||
|
| `scaleUpViewport` | | viewports |
|
||||||
|
| `scaleDownViewport` | | viewports |
|
||||||
|
| `fitViewportToWindow` | | viewports |
|
||||||
|
| `resetViewport` | | viewports |
|
||||||
|
| clearAnnotations | TODO | |
|
||||||
|
| next/previous Image | TODO | |
|
||||||
|
| first/last Image | TODO | |
|
||||||
|
| `nextViewportDisplaySet` | | |
|
||||||
|
| `previousViewportDisplaySet` | | |
|
||||||
|
| `setToolActive` | Activates tool for primary button/touch | |
|
||||||
|
|
||||||
|
## Toolbar Module
|
||||||
|
|
||||||
|
Our toolbar module contains definitions for:
|
||||||
|
|
||||||
|
- `StackScroll`
|
||||||
|
- `Zoom`
|
||||||
|
- `Wwwc`
|
||||||
|
- `Pan`
|
||||||
|
- `Length`
|
||||||
|
- `Angle`
|
||||||
|
- `Reset`
|
||||||
|
- `Cine`
|
||||||
|
|
||||||
|
All use the `ACTIVE_VIEWPORT::CORNERSTONE` context.
|
||||||
|
|
||||||
|
## Viewport Module
|
||||||
|
|
||||||
|
Our Viewport wraps [cornerstonejs/react-cornerstone-viewport][react-viewport]
|
||||||
|
and is connected the redux store. This module is the most prone to change as we
|
||||||
|
hammer out our Viewport interface.
|
||||||
|
|
||||||
|
## Resources
|
||||||
|
|
||||||
|
### Repositories
|
||||||
|
|
||||||
|
- [cornerstonejs/react-cornerstone-viewport][react-viewport]
|
||||||
|
- [cornerstonejs/cornerstoneTools][cornerstone-tools]
|
||||||
|
- [cornerstonejs/cornerstone][cornerstone]
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Links
|
Links
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
|
[docs-commands]: https://www.com
|
||||||
|
[docs-hotkeys]: https://www.com
|
||||||
|
[docs-userprefs]: htt
|
||||||
|
[react-viewport]: https://github.com/cornerstonejs/react-cornerstone-viewport
|
||||||
|
[cornerstone-tools]: https://github.com/cornerstonejs/cornerstoneTools
|
||||||
|
[cornerstone]: https://github.com/cornerstonejs/cornerstone
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user