-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(configuration_file): add separate page for JSON config
Add segmentGroupSaveFormat section.
- Loading branch information
Showing
5 changed files
with
147 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| # Configuration JSON File | ||
|
|
||
| By loading a JSON file, you can set VolView's: | ||
|
|
||
| - Starting view layout (Axial Only, 3D Primary, etc). | ||
| - Labels for tools | ||
| - Visibility of Sample Data section | ||
| - Keyboard shortcuts | ||
|
|
||
| ## Starting view layout | ||
|
|
||
| The `activeLayout` key has options (Axial Only, 3D Primary, etc.) defined in `config.ts` | ||
|
|
||
| ```json | ||
| { | ||
| "layout": { | ||
| "activeLayout": "Axial Only" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Labels for tools | ||
|
|
||
| Each tool type (Rectangle, Polygon, etc.) can have tool specific labels. To share labels | ||
| across tools, define the `defaultLabels` key and don't provide labels for a tool that | ||
| should use the default labels. | ||
|
|
||
| ```json | ||
| { | ||
| "labels": { | ||
| "defaultLabels": { | ||
| "lesion": { "color": "#ff0000" }, | ||
| "tumor": { "color": "green", "strokeWidth": 3 } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Segment Group File Format | ||
|
|
||
| The `segmentGroupSaveFormat` key specifies the file extension of the segment group images | ||
| VolView will include in the volview.zip file. | ||
|
|
||
| ```json | ||
| { | ||
| "io": { | ||
| "segmentGroupSaveFormat": "nii" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| These are the supported file formats: | ||
|
|
||
| hdf5, iwi.cbor, mha, nii, nii.gz, nrrd, vtk | ||
|
|
||
| ## Keyboard Shortcuts | ||
|
|
||
| Configure the keys to activate tools, change selected labels, and more. | ||
| All [shortcut actions](https://github.com/Kitware/VolView/blob/main/src/constants.ts#L53) are under the `ACTIONS` variable. | ||
|
|
||
| To configure a key for an action, add its action name and the key(s) under the `shortcuts` section. For key combinations, use `+` like `Ctrl+f`. | ||
|
|
||
| ```json | ||
| { | ||
| "shortcuts": { | ||
| "polygon": "Ctrl+p", | ||
| "showKeyboardShortcuts": "t" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Visibility of Sample Data section | ||
|
|
||
| Simplify the data browser by hiding the Sample Data expandable section. | ||
|
|
||
| ```json | ||
| { | ||
| "dataBrowser": { | ||
| "hideSampleData": false | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Example JSON: | ||
|
|
||
| ```json | ||
| { | ||
| "labels": { | ||
| "defaultLabels": { | ||
| "lesion": { "color": "#ff0000" }, | ||
| "tumor": { "color": "green", "strokeWidth": 3 } | ||
| } | ||
| }, | ||
| "layout": { | ||
| "activeLayout": "Axial Only" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## All options: | ||
|
|
||
| ```json | ||
| { | ||
| "labels": { | ||
| "defaultLabels": { | ||
| "lesion": { "color": "#ff0000" }, | ||
| "tumor": { "color": "green", "strokeWidth": 3 }, | ||
| "innocuous": { "color": "white" } | ||
| }, | ||
| "rulerLabels": { | ||
| "big": { "color": "#ff0000" }, | ||
| "small": { "color": "white" } | ||
| }, | ||
| "rectangleLabels": { | ||
| "red": { "color": "#ff0000", "fillColor": "transparent" }, | ||
| "green": { "color": "green", "fillColor": "transparent" }, | ||
| "white-yellow-fill": { | ||
| "color": "white", | ||
| "fillColor": "#00ff0030" | ||
| } | ||
| }, | ||
| "polygonLabels": { | ||
| "poly1": { "color": "#ff0000" }, | ||
| "poly2Label": { "color": "green" } | ||
| } | ||
| }, | ||
| "layout": { | ||
| "activeLayout": "Axial Only" | ||
| }, | ||
| "dataBrowser": { | ||
| "hideSampleData": false | ||
| }, | ||
| "shortcuts": { | ||
| "polygon": "Ctrl+p", | ||
| "showKeyboardShortcuts": "t" | ||
| }, | ||
| "io": { | ||
| "segmentGroupSaveFormat": "nrrd" | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| doc: | ||
| introduction: | ||
| introduction: | ||
| what_is_volview: index.html | ||
| quick_start_guide: quick_start_guide.html | ||
| details: | ||
| details: | ||
| welcome_screen: welcome_screen.html | ||
| loading_data: loading_data.html | ||
| toolbar: toolbar.html | ||
| mouse_controls: mouse_controls.html | ||
| rendering: rendering.html | ||
| state_files: state_files.html | ||
| server: server.html | ||
| configuration_file: configuration_file.html |