https://github.com/ohif/vtkplugin
OHIF Plugin for The Visualization Toolkit (VTK)
https://github.com/ohif/vtkplugin
image-analysis imaging-informatics medical-image-processing nci-itcr nci-qin ohif-plugin quantitative-imaging
Last synced: about 2 months ago
JSON representation
OHIF Plugin for The Visualization Toolkit (VTK)
- Host: GitHub
- URL: https://github.com/ohif/vtkplugin
- Owner: OHIF
- License: mit
- Archived: true
- Created: 2018-07-26T16:44:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T16:46:52.000Z (over 6 years ago)
- Last Synced: 2025-02-28T20:38:15.033Z (3 months ago)
- Topics: image-analysis, imaging-informatics, medical-image-processing, nci-itcr, nci-qin, ohif-plugin, quantitative-imaging
- Language: JavaScript
- Homepage: https://vtk-plugin.ohif.org?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/JSON/PTCTStudy.json
- Size: 73.2 KB
- Stars: 35
- Watchers: 24
- Forks: 17
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OHIF VTK Plugin
## Usage
OHIF Plugin for [The Visualization Toolkit (VTK)](https://github.com/Kitware/vtk-js)
1. Load the OHIF Viewer on a study
2. Paste the following into your JavaScript console to define the plugin and load the scripts.
````javascript
var plugin = {
name: "VolumeRenderingPlugin",
url: "https://cdn.rawgit.com/OHIF/VTKPlugin/master/volumeRendering/main.js",
allowCaching: false,
moduleURLs: [
"https://cdn.rawgit.com/OHIF/VTKPlugin/master/lib/index.js",
],
scriptURLs: [
'https://unpkg.com/vtk.js',
]
};
OHIF.plugins.OHIFPlugin.reloadPlugin(plugin);
````
3. Switch a viewport to use the plugin by specifying its viewport index:
````javascript
OHIF.plugins.VolumeRenderingPlugin.setViewportToPlugin(0)
````
## Development
This will install a local copy of the OHIFViewer and let you run a server that can be used
for plugin development.
You will get:
* a local scratch copy of the OHIF StandaloneViewer running on port 3000
* a web server to serve your plugin code on port 8000
* sample data from the links below will be pulled from public data stored on Amazon S3
### Prerequisites
* Run on a linux/mac environment with bash (windows not supported or tested)
* All the things needed to build [OHIFViewers](http://github.com/OHIF/Viewers)
* [http-server](https://www.npmjs.com/package/http-server)
1. Create a copy of the OHIF Standalone Viewer Meteor app (i.e. not built into a static site yet)
````bash
./setupDevSite.sh
````
2. Install an HTTP server which supports CORS:
````bash
# If you get some EACCESS errors, use sudo.
npm install http-server -g
````
3. Start the HTTP server with CORS enabled
- You will see some logs in your console whenever requests reach your server at http://localhost:8000
- This serves the plugin directory itself, so any changes you make to the plugin are instantly available.
````bash
http-server -p 8000 --cors
````
4. Open another terminal tab and start the Standalone Viewer.
````bash
./startDevSite.sh
````
- This version of the StandaloneViewer has some scripts copied into it which enable the MultiplanarReformatting and VolumeRendering plugins by default.
- **Note**: If you change anything in these scripts, you will need to run `setupDevSite.sh` again.
5. Test the installation by loading one of the following URLs:
- [PTCTStudy](http://localhost:3000/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/JSON/PTCTStudy.json)
- [CTStudy](http://localhost:3000/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/JSON/CTStudy.json)
- [MRStudy](http://localhost:3000/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/JSON/MRStudy.json)