MLAB-6184: fixes after review

Author: okonrad

mevislab.github.io/content/tutorials/dataobjects/contours/contourexample6.md

@@ -46,8 +46,8 @@ We now want to customize the details to be shown for each distance line. Open th
 Enter the following to the panel of the `CSOLabelRenderer` module:
 {{< highlight filename="CSOLabelRenderer" >}}
 ```Python
-labelString = f'Length: {cso.getLength()} mm'
-labelName = f'ID: {cso.getId()}'
+labelString = f"Length: {cso.getLength()} mm"
+labelName = f"ID: {cso.getId()}"
 deviceOffsetX = 0
 deviceOffsetY = 0
 ```
@@ -60,15 +60,15 @@ We are setting the *labelName* to a static text showing the type of the CSO and
 You can also round the length by using:
 {{< highlight filename="CSOLabelRenderer" >}}
 ```Python
-labelString = f'Length: {cso.getLength():.2f} mm'
+labelString = f"Length: {cso.getLength():.2f} mm"
 ```
 {{</highlight>}}
 
 In order to see all possible parameters of a CSO, add a `CSOInfo` module to your network and connect it to the `CSOManager`. The geometric information of the selected CSO from `CSOManager` can be seen there.
 
 ![CSOInfo](images/tutorials/dataobjects/contours/Ex6_CSOInfo.png "CSOInfo")
 
-For labels shown on gray value images, it makes sense to add a shadow. Open the panel of the `SoCSOVisualizationSettings` module and on tab *Misc* check the option *Should render shadow*. This increases the readability of your labels.
+For labels shown on grayscale images, it makes sense to add a shadow. Open the panel of the `SoCSOVisualizationSettings` module and on tab *Misc* check the option *Should render shadow*. This increases the readability of your labels.
 
 {{< imagegallery 2 "images/tutorials/dataobjects/contours/" "Ex6_NoShadow" "Ex6_Shadow" >}}
 
@@ -84,13 +84,13 @@ We currently defined the *labelName* and *labelString* for the distance line. If
 
 {{< highlight filename="CSOLabelRenderer" >}}
 ```Python
-if cso.getSubType() == 'distanceLine':
-  labelString =  f'{userData0} {cso.getLength():.2f} mm'
+if cso.getSubType() == "distanceLine":
+  labelString =  f"{userData0} {cso.getLength():.2f} mm"
   labelName = userData1
   labelName += str(cso.getId())
-elif cso.getSubType() == 'rectangle':
-  labelString = f'{userData0} {cso.getLength():.2f} mm\n'
-  labelString += f'{userData2} {cso.getArea():.2f} mm^2'
+elif cso.getSubType() == "rectangle":
+  labelString = f"{userData0} {cso.getLength():.2f} mm\n"
+  labelString += f"{userData2} {cso.getArea():.2f} mm^2"
   labelName = userData3
   labelName += str(cso.getId())
 deviceOffsetX = 0

mevislab.github.io/content/tutorials/dataobjects/surfaces/surfaceexample2.md

@@ -54,7 +54,11 @@ Next, open the tab *Input* and draw parameter connections from the results of th
 
 ![Define annotation parameters](images/tutorials/dataobjects/surfaces/DO7_07.png "Define annotation parameters")
 
-You can design the annotation overlay as you like in the tab *User*. We decided to only display the minimal (the minimum minimum) and maximal (the maximum minimum) distance between both WEMs.
+You can design the annotation overlay as you like in the tab *User*. We decided to only display the minimal and maximal distance between both WEMs.
+
+{{<alert class="info" caption="Extra Infos">}}
+The `WEMSurfaceDistance` module measures minimal distances only; when talking about the maximal distance, we mean the maximal minimal distance: this is the maximum of all minimum distances.
+{{</alert>}}
 
 ![Annotation design](images/tutorials/dataobjects/surfaces/DO7_04.png "Annotation design")
 

mevislab.github.io/content/tutorials/openinventor/posteffectsinopeninventor.md

@@ -18,7 +18,7 @@ menu:
 ## Introduction
 Up to this point, we practiced constructing Open Inventor scenes and placed three-dimensional Open Inventor objects of different colors and shapes within them.
 
-In this tutorial, we will go over the steps to add shadows to our 3D objects, make them glow, and vary their opacity to make them transparent. We will also incorporate WEMs from multiframe DICOMs and render them as scene objects to see how different post effects can be used on them.
+In this tutorial, we will go over the steps to add shadows to our 3D objects, make them glow, and vary their opacity to make them transparent. We will also incorporate WEMs from multi-frame DICOMs and render them as scene objects to see how different post effects can be used on them.
 
 ## Steps to Follow
 
@@ -30,7 +30,7 @@ To incorporate DICOMs into your Open Inventor Scene, they have to be rendered as
 We don't recommend using single-frame DICOMs for this example as a certain depth is required to interact with the scene objects as intended. Also make sure that the pixel data of the DICOM file you choose contains all slices of the study, as it might be difficult to arrange scene objects of individual slices to resemble the originally captured study. 
 {{</alert>}}
 
-![From DICOM to SO](images/tutorials/openinventor/multiframetoso.PNG "How to create a scene object out of a multiframe DICOM")
+![From DICOM to SO](images/tutorials/openinventor/multiframetoso.PNG "How to create a scene object out of a multi-frame DICOM")
 
 {{<alert class="info" caption="Info">}}
 Consider adding a `View2D` and an `Info` module to your `LocalImage` module's output connector to be able to compare the rendered object with the original image and adapt the isovalues to minimize noise.
@@ -79,7 +79,7 @@ To put a soft glow on the geometrical scene objects, the module `SoPostEffectGlo
 ![Glow](images/tutorials/openinventor/WorkspaceWithGlow.PNG "Applied SoPostEffectGlow")
 
 ## Summary
-* Multiframe DICOM images can be rendered to be scene objects by converting them into WEMs first.
+* Multi-frame DICOM images can be rendered to be scene objects by converting them into WEMs first.
 * Open Inventor scenes can be augmented by adding PostEffects to scene objects.
 
 {{< networkfile "examples/open_inventor/PostEffectTutorial.mlab" >}}

mevislab.github.io/content/tutorials/summary/summary3.md

@@ -170,9 +170,9 @@ The following shall be accessible as *Field* for our macro module:
 * Filename to be opened
 * Color of the 2D overlay and 3D segmentation
 * Transparency of the 3D image
-* Threshold to be used for RegionGrowing
+* Threshold to be used for `RegionGrowing`
 * Isovalue of the 3D surface to use for rendering
-* Position of the marker to use for RegionGrowing
+* Position of the marker to use for `RegionGrowing`
 * Selection for 3D visualization (image, segmentation, or both)
 * Trigger to reset the application to its initial state
 

mevislab.github.io/content/tutorials/summary/summary4.md

@@ -141,7 +141,7 @@ def reset():
 
 For a reset, we just touch the *resetApplication* field of our macro module `TutorialSummary`.
 
-#### Requirement 1: The Application Shall be Able to Load DICOM Data
+#### Requirement 1: The application shall be able to load DICOM data
 The first requirement we want to test is the possibility to load DICOM data. After setting the file to be loaded, the output provides a valid image. Resetting the application shall unload the image.
 
 {{< highlight filename="<TEST_CASE_NAME>.py" >}}
@@ -159,8 +159,9 @@ def TEST_LoadDICOMData():
 ```
 {{</highlight>}}
 
-#### Requirement 4: The 2D Viewer Shall Provide the Possibility to Segment Parts of the Image Based on a RegionGrowing Algorithm
-##### Requirement 4.1: It Shall be Possible to Click Into the Image for Defining a Marker Position for Starting the RegionGrowing
+#### Requirement 4: The 2D viewer shall provide the possibility to segment parts of the image based on a region growing algorithm
+
+##### Requirement 4.1: It shall be possible to click into the image for defining a marker position for starting the region growing algorithm
 This test case shall make sure the `RegionGrowing` module calculates the total volume and number of voxels to be larger than 0 in the case a marker has been set. Without loading an image or after resetting the application, the values shall be 0.
 
 {{< highlight filename="<TEST_CASE_NAME>.py" >}}
@@ -192,7 +193,7 @@ def TEST_RegionGrowing():
 ```
 {{</highlight>}}
 
-##### Requirement 4.2: It Shall be Possible to Define a Threshold for the RegionGrowing Algorithm
+##### Requirement 4.2: It shall be possible to define a threshold for the region growing algorithm
 For the threshold of the region growing it makes sense to extend the previous test case instead of writing a new one. We already have a segmentation based on the default threshold value and can just change the threshold and compare the resulting volumes.
 
 Increasing the threshold shall result in larger volumes, decreasing shall result in smaller values.
@@ -240,8 +241,9 @@ def TEST_RegionGrowing():
 ```
 {{</highlight>}}
 
-#### Requirement 5: The 2D Viewer Shall Display the Segmentation Results as a Semitransparent Overlay
-##### Requirement 5.1: It Shall be Possible to Define the Color of the Overlay
+#### Requirement 5: The 2D viewer shall display the segmentation results as a semitransparent overlay
+
+##### Requirement 5.1: It shall be possible to define the color of the overlay
 The requirement 5 cannot be tested automatically. Transparencies should be tested by a human being.
 
 Nevertheless, we can write an automated test checking the possibility to define the color of the overlay and the 3D segmentation.
@@ -279,13 +281,13 @@ Finally, an image comparison is done for the 3D rendering using the old and the
 
 The call *MLAB.processInventorQueue()* is sometimes necessary if an Open Inventor scene changed via Python scripting, because the viewers might not update immediately after changing the field. MeVisLab is now forced to process the queue in Open Inventor and to update the renderings.
 
-#### Requirement 8: The Total Volume of the Segmented Area Shall be Calculated and Shown (in ml)
+#### Requirement 8: The total volume of the segmented volume shall be calculated and shown (in ml)
 For the correctness of the volume calculation, we added the `CalculateVolume` module to our test network. The volume given by our macro is compared to the volume of the segmentation from output *outSegmentationMask* calculated by the `CalculateVolume` module.
 
 {{< highlight filename="<TEST_CASE_NAME>.py" >}}
 ```Python
 ...
-# Requirement 8: The total volume of the segmented area shall be calculated and shown (in ml)
+# Requirement 8: The total volume of the segmented volume shall be calculated and shown (in ml)
 def TEST_VolumeCalculation():
   # Reset and expect all volumes and number of voxels to be 0
   reset()
@@ -312,11 +314,11 @@ def TEST_VolumeCalculation():
 ```
 {{</highlight>}}
 
-#### Requirement 9: It Shall be Possible to Toggle the Visible 3D Objects
+#### Requirement 9: It shall be possible to toggle the visible 3D objects
 
-##### Requirement 9.1: Original Data
+##### Requirement 9.1: Original data
 
-##### Requirement 9.2: Segmentation Results
+##### Requirement 9.2: Segmentation results
 
 ##### Requirement 9.3: All
 In the end, we want to develop a testcase for the 3D toggling of the view. We cannot exactly test if the rendering is correct; therefore, we will check if the 3D rendering image changes when toggling the 3D view. We will use the modules `OffscreenRenderer`, `ImageCompare`, and `SoCameraInteraction`, which we added to our test network.

mevislab.github.io/content/tutorials/visualization/visualizationexample1.md

@@ -20,7 +20,7 @@ In this example we like to use the module `SynchroView2D` to be able to inspect
 
 The module `SynchroView2D` provides two 2D viewers that are synchronized.
 
-As in tutorial [Chapter 1 - Basic Mechanics of MeVisLab](tutorials/basicmechanisms/#TutorialParameterConnection), the processed and the unprocessed image can be displayed simultaneously. Scrolling through one image automatically changes the slices of both viewers, so slices with the same slice number are shown in both images.
+As in the tutorial [Chapter 1 - Basic Mechanics of MeVisLab](tutorials/basicmechanisms/#TutorialParameterConnection), the processed and the unprocessed image can be displayed simultaneously. Scrolling through one image automatically changes the slices of both viewers, so slices with the same slice number are shown in both images.
 
 The difference is that we are now using an already existing module named `SynchroView2D`.