feat: Add mode validity for the base viewer (#2525)
* feat: Add mode validity for the base viewer * feat: Edit documentation and remove unnecessary files * feat: Add probe tool documentation * docs: Improved screenshots annotations * Added new screenshot for measurements
This commit is contained in:
1 parent
4f3f510cac
commit
46c2dc285c
37 files changed
+90
-416
No files matched your search
@@ -7,8 +7,9 @@ sidebar_position: 7
|
||||
To open the hotkey assignment panel, you can click on the Preferences gear on the
|
||||
top right side of the viewer.
|
||||
|
||||

|
||||
|
||||
Below, you can see the default hotkeys key bindings:
|
||||
|
||||

|
||||
|
||||
Hotkeys can be assigned to custom bindings that persist for the duration of the browser session.
|
||||
@@ -21,6 +21,9 @@ Let's break different aspects of the viewer to the main components:
|
||||
- Right Panel (measurements): displays annotations details
|
||||
- Toolbar: displays tools and logo
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
|
||||
|
||||
Now, we explain each component and its sub-elements in detail.
|
||||
@@ -9,29 +9,28 @@ In `Basic Viewer` mode, the right panel is the `Measurement Panel`. The Measurem
|
||||
<!-- We might want to make an entire section about the tracking workflow including SR hydration because it's pretty complicated. Let's review after the deploy branch is ready. Logic is in OHIF-63 OHIF-339 tickets for reference -->
|
||||
Select a measurement tool and mark an image to initiate measurement tracking. A pop up will ask if you want to track measurements for the series on which the annotation was drawn.
|
||||
|
||||

|
||||
|
||||
If you select `Yes`, the series becomes a `tracked series`, and the current drawn measurement and next measurements will get shown up on the measurement panel on the right.
|
||||

|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
If you select `Yes`, the series becomes a `tracked series`, and the current drawn measurement and next measurements are shown on the measurement panel on the right.
|
||||
|
||||

|
||||
|
||||
If you select `No`, the measurement becomes temporary. The next annotation made will repeat the measurement tracking prompt.
|
||||
|
||||
If you select `No, do not ask again`, all annotations made on the study will be temporary.
|
||||
<!-- Temporary measurement screenshot -->
|
||||

|
||||
|
||||
|
||||
## Labeling Measurements
|
||||
You can edit the measurement name by hovering over the measurement and selecting the edit icon. You can also label or relabel a measurement by right-clicking on it in the viewport.
|
||||
<!-- I would make this first screenshot smaller. Remove the other 2 screenshots as they are pretty self explanatory. Add another screenshot that shows the right-click menu option to lable/relabel measurement and justify the two screenshots in line together -->
|
||||
|
||||

|
||||

|
||||
|
||||

|
||||
|
||||
Result:
|
||||
|
||||

|
||||
|
||||
|
||||
## Deleting a Measurement
|
||||
@@ -41,7 +40,8 @@ A measurement can be deleting by dragging it outside the image in the viewport o
|
||||
## Jumping to a Measurement
|
||||
Measurement navigation inside the top viewport can be used to move to previous and next measurement.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
If a series containing a measurement is currently being displayed in a viewport, you can jump to display the measurement in the viewport by clicking on it in the Measurement Panel.
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ Click on the Camera icon to download a high quality image capture using common i
|
||||
|
||||
In the opened modal, the filename, image's width and height, and filetype and can be configured before downloading the image to your local computer.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
|
||||
@@ -66,10 +66,10 @@ Please see the `Viewport` section for details.
|
||||
- Flip Horizontally: Flips the image 180 degrees horizontally
|
||||
- Stack Scroll: Links all viewports containing images to scroll together
|
||||
- Magnify: Click on an image to magnify a particular area of interest
|
||||
- Invert: Inverts the colorscale
|
||||
- Invert: Inverts the color scale
|
||||
- Cine: Toggles the Cine player control in the currently selected viewport. Click the `x` on the Cine player or click the tool again to toggle off.
|
||||
- Angle: Measures an adjustable angle on an image
|
||||
<!-- - Probe: Should probe be enabled in basic viewer? Doesn't look like it works currently -->
|
||||
- Probe: Drag the probe to see pixel values
|
||||
- Rectangle: Measures a rectangular area in mm^2 and HU
|
||||
|
||||
When a tool is selected from the `More Tools` menu, it becomes the active tool until it is replaced by clicking on a different tool in the More Tools menu or main toolbar.
|
||||
|
||||
Reference in new issue
Block a user