diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/Manual.dox b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/Manual.dox index f2e003fa4c..2e852eeafa 100644 --- a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/Manual.dox +++ b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/Manual.dox @@ -1,56 +1,56 @@ /** \page org_mitk_views_matchpoint_evaluator The MatchPoint Registration Evaluation View \imageMacro{map_evaluator_doc.svg, "Icon of the MatchPoint Registration Evaluator", 3} \tableofcontents \section MAP_REGEVAL_Introduction Introduction This view offers the possibility to evaluate the quality of the registration/mapping of two given images by visual inspection. This can either by used to assess the visual quality of a registration or to assess how well the image contents are already aligned -by default. To achieve the later, one may select no registration. Then the images will be displayed in evaluation mode assuming an identity transform (so no mapping). +by default. To achieve the latter, one may select no registration. Then the images will be displayed in evaluation mode assuming an identity transform (so no mapping). It is one of several MatchPoint registration plug-ins.\n \section MAP_REGEVAL_Usage Usage -\imageMacro{map_view_example.png, "Example screenshot showing the main elements of the view.", 14} +\imageMacro{map_view_evaluator_example.png, "Example screenshot showing the main elements of the view.", 14} (1) The currently selected registration that should be used to map the moving image for evaluation. Click to change. If no registration is selected, a direct evaluation will be performed.\n (2) Reset button will remove the currently selected registration.\n -(3) Auto select option. If active the view will try to deduce and automatically select (if loaded in the application) the moving and target image when the registration changes. The view assumes that the moving and target images used to determin the registration should be used.\n +(3) Auto select option. If active the view will try to deduce and automatically select (if loaded in the application) the moving and target image when the registration changes. The view assumes that the moving and target images used to determine the registration should be used.\n (4) The currently selected moving data. Click to change.\n (5) The currently selected target data. Click to change.\n (6) Start/Stop button used to activate/deactivate the evaluation. This button become active when at least the moving and the target image are selected.\n (7) Selection of the visualization style. (only visible if evaluation is active)\n (8) Style specific settings. (only visible if evaluation is active)\n If the evaluation view is active you can choose between different modes of visualization. For more details see \ref MAP_REGEVAL_Styles.\n To stop the evaluation mode, you may use the "Stop evaluation" button or just close the evaluation view. -\remark The evaluation view will use the level window settings of the used images. So to changes the level windowing of the evaluation view, you must change the +\remark The evaluation view will use the level window settings of the used images. So to change the level windowing of the evaluation view, you must change the level windowing of the respective input images (moving image and target image). \section MAP_REGEVAL_Accuracy Evaluating accuracy -Important note: Please be aware, that a visual inspection of registration quality is only a weak surrogate for a thorough accuracy analysis based on representative and suitable ground truth data. From a visually good mapping you can not deduce a correct registration. This is especially true if the degrees of freedom of the registration increases. For a rigid registration it might by feasible to discern correct and incorrect registration. But for none rigid registrations you definitely you should use this view only for things like first visual inspection (to check if it SEEMS to do the right thing and is worth further exploration) or illustrating the registration effect for registration you have assessed in a sound way. +Important note: Please be aware, that a visual inspection of registration quality is only a weak surrogate for a thorough accuracy analysis based on representative and suitable ground truth data. From a visually good mapping you can not deduce a correct registration. This is especially true if the degrees of freedom of the registration increases. For a rigid registration it might by feasible to discern correct and incorrect registration. But for none rigid registrations you definitely you should use this view only for first visual inspection (to check if it SEEMS to do the right thing and is worth further exploration) or illustrating the registration effect for registration you have assessed in a sound way. \section MAP_REGEVAL_Styles Visualization styles You can choose from the following visualization styles to evaluate the registration/mapping quality:\n \li "Blend": Blends the images with a user defined weight. Default is 50:50. \imageMacro{map_view_blend_settings.png, "Settings of the Blend style", 8} (1) Click to set the weights to 100% target image.\n (2) Click to set the weights to 50:50 (equal blend).\n (3) Slider to adjust the weights between target image and the mapped input image. The spin box shows the weight of the mapped input image.\n (4) Click to set the weights to 100% mapped input image.\n (5) Click to toggle the weight between both images.\n \imageMacro{map_style_blend.png, "Example for mode: Blend (50:50)", 5} -\li "Checkerboard": Checkerboard style that composes both images. You may define the resolution of the checkerboard. +\li "Checkerboard": Checkerboard style that composes both images by showing image 1 in all light squares and image 2 in all dark squares. You can define the resolution/number of squares of the checkerboard. \imageMacro{map_style_checkerboard.png, "Example for mode: Checkerboard", 5} \li "Color blend": Color blend of the images (blue: target image; yellow: moving). Areas where you see no color implies good intensity matchings. \imageMacro{map_style_color_blend.png, "Example for mode: Color blend", 5} -\li "Contour": Blend mode that display one image as blue "background" and the other image in yellow contours. You may choose the role of the images. +\li "Contour": Blend mode that displays one image as blue "background" and the other image in yellow contours. You can choose the role of the images. \imageMacro{map_style_contour.png, "Example for mode: Contour", 5} \li "Difference": Displays the absolute difference of both images. \li "Wipe": Blend mode that makes a rectilinear combination of the images. You can choose the mode how the images are splitted. The split is synchronized with the current selection. So you may interact with the split border to position it on interesting areas. \imageMacro{map_style_wipe_cross.png, "Example for mode: Wipe cross", 5} \imageMacro{map_style_wipe_horizontal.png, "Example for mode: Wipe horizontal", 5} */ diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_blend_settings.svg b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_blend_settings.svg index 002060caab..91573fb6d3 100644 --- a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_blend_settings.svg +++ b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_blend_settings.svg @@ -1,398 +1,398 @@ image/svg+xml - + + preserveAspectRatio="none" + id="image4493" + x="0" + y="1" + clip-path="url(#clipPath5294)" + transform="translate(0,-297.78046)" /> (3) Slider to adjust weighting (4) Set to 100% mapped visibility (5) Toggle weighting (2) Set to 50:50 visibility (1) Set to 100% target visibility + id="flowPara8277" /> diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.png b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.png new file mode 100644 index 0000000000..e29f63b0d9 Binary files /dev/null and b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.png differ diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.svg b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.svg similarity index 97% rename from Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.svg rename to Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.svg index dd5a4ee8e2..ae70bf0a5b 100644 --- a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.svg +++ b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example.svg @@ -1,409 +1,409 @@ image/svg+xml - + + preserveAspectRatio="none" + id="image4493" + x="0" + y="1" /> (1) Registration slot (7) Evaluation styles (2) Registration reset (4) Moving image slot (5) Target image slot (6) Start/Stop button (8) Style specific settings (3) Auto select option diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example_raw.png b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example_raw.png similarity index 100% rename from Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example_raw.png rename to Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_evaluator_example_raw.png diff --git a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.png b/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.png deleted file mode 100644 index cdcfabe79d..0000000000 Binary files a/Plugins/org.mitk.gui.qt.matchpoint.evaluator/documentation/UserManual/map_view_example.png and /dev/null differ