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:
Alireza authored and GitHub committed 2021-08-30 09:36:05 -04:00
1 parent 4f3f510cac
commit 46c2dc285c
37 files changed
+90 -416

No files matched your search

@@ -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.
![user-measurement-panel-modal](../../assets/img/user-measurement-panel-modal.png)
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.
![user-measurement-panel-modal](../../assets/img/measurement-panel-prompt.png)
![user-measurement-panel-tracked](../../assets/img/user-measurement-panel-tracked.png)
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.
![user-measurement-panel-tracked](../../assets/img/measurement-panel-tracked.png)
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 -->
![measurement-temporary](../../assets/img/measurement-temporary.png)
## 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 -->
![user-measurement-edit](../../assets/img/user-measurement-edit.png)
![user-measurement-edit](../../assets/img/measurement-panel-1.png)
![user-measurement-edit-name](../../assets/img/user-measurement-edit-name.png)
Result:
![user-measurement-name](../../assets/img/user-measurement-name.png)
## 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.
![user-measurement-prevnext](../../assets/img/user-measurement-prevnext.png)
![measurements-prevNext](../../assets/img/measurements-prevNext.png)
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.