Commit fd99fcd8a98df2662f37330da48ef6d1b2192a6a
1 parent
5f5952bc
Exists in
master
Finalized manual review suggested by Steve Harvey and Callum Harvey of Health Ph…
…ysics Pty Ltd from Australia
Showing
12 changed files
with
121 additions
and
189 deletions
Show diff stats
docs/user_guide_en_source/autores.tex
... | ... | @@ -50,10 +50,25 @@ Jorge Vicente Lopes da Silva |
50 | 50 | |
51 | 51 | \newpage |
52 | 52 | |
53 | -\scalebox{2.0}{\sffamily User Guide Contributor} | |
53 | +\scalebox{2.0}{\sffamily User Guide Contributors} | |
54 | 54 | \\ |
55 | 55 | |
56 | 56 | Haris Haq |
57 | 57 | |
58 | 58 | \href{mailto:haris.haq98@gmail.com}{haris.haq98@gmail.com} |
59 | +\\ | |
60 | + | |
61 | +Steve Harvey | |
62 | + | |
63 | +\href{mailto:steve@healthphysics.com.au}{steve@healthphysics.com.au} | |
64 | +\\ | |
65 | + | |
66 | +Callum Harvey | |
67 | + | |
68 | +\href{mailto:cjharvey113@gmail.com}{cjharvey113@gmail.com} | |
69 | +\\ | |
70 | + | |
71 | +Health Physics | |
72 | + | |
73 | +\href{http://www.healthphysics.com.au}{www.healthphysics.com.au} | |
59 | 74 | \\ |
60 | 75 | \ No newline at end of file | ... | ... |
docs/user_guide_en_source/cap_cust.tex
1 | 1 | \chapter{Customization} |
2 | 2 | |
3 | -Some customization options are available for InVesalius users. They are shown as follow. | |
3 | +Some customization options are available for InVesalius users. They are shown as follows. | |
4 | 4 | |
5 | 5 | \section{Tools menu} |
6 | 6 | |
7 | -To hide/show the side tools menu, click the button shown in figure | |
8 | -\ref{fig:layout_full_original}. | |
7 | +To hide/show the side tools menu, click the button shown in Figure~\ref{fig:layout_full_original}. | |
9 | 8 | |
10 | 9 | \begin{figure}[!htb] |
11 | 10 | \centering |
... | ... | @@ -14,7 +13,7 @@ To hide/show the side tools menu, click the button shown in figure |
14 | 13 | \label{fig:layout_full_original} |
15 | 14 | \end{figure} |
16 | 15 | |
17 | -With the menu hidden, the image visualization area in InVeslaius is expanded, as illustrated in figure \ref{fig:closed_tool_menu}. | |
16 | +With the menu hidden, the image visualization area in InVesalius is expanded, as shown in Figure~\ref{fig:closed_tool_menu}. | |
18 | 17 | |
19 | 18 | \begin{figure}[!htb] |
20 | 19 | \centering |
... | ... | @@ -27,9 +26,7 @@ With the menu hidden, the image visualization area in InVeslaius is expanded, as |
27 | 26 | |
28 | 27 | \section{Automatic positioning of volume/surface} |
29 | 28 | |
30 | -To automatic set the visualization position of a volume or surface, | |
31 | -click on the icon shown in figure \ref{fig:3d_automatic_position} | |
32 | -(located in the inferior right corner of InVesalius screen) and choose one of the available options for visualization. | |
29 | +To automatically set the visualization position of a volume or surface, click on the icon shown in Figure~\ref{fig:3d_automatic_position} (located in the inferior right corner of InVesalius screen) and choose one of the available options for visualization. | |
33 | 30 | |
34 | 31 | \begin{figure}[!htb] |
35 | 32 | \centering |
... | ... | @@ -40,8 +37,7 @@ click on the icon shown in figure \ref{fig:3d_automatic_position} |
40 | 37 | |
41 | 38 | \section{Background color of volume/surface window} |
42 | 39 | |
43 | -To change the background color of volume/surface window, click on the shortcut shown in figure | |
44 | -\ref{fig:button_select_color_2}. The shortcut is also located in the inferior right cornen of InVesalius screen. | |
40 | +To change the background color of the volume/surface window, click on the shortcut shown in Figure~\ref{fig:button_select_color_2}. The shortcut is also located in the lower right corner of the InVesalius screen. | |
45 | 41 | |
46 | 42 | \begin{figure}[!htb] |
47 | 43 | \centering |
... | ... | @@ -50,8 +46,7 @@ To change the background color of volume/surface window, click on the shortcut s |
50 | 46 | \label{fig:button_select_color_2} |
51 | 47 | \end{figure} |
52 | 48 | |
53 | -A window for color selection opens, as in figure \ref{fig:color_window_background}. | |
54 | -Next, just click over the desired color and then click \textbf{OK}. | |
49 | +A window for color selection opens (Figure~\ref{fig:color_window_background}). Next, simply click over the desired color and then click \textbf{OK}. | |
55 | 50 | |
56 | 51 | \begin{figure}[!htb] |
57 | 52 | \centering |
... | ... | @@ -60,7 +55,7 @@ Next, just click over the desired color and then click \textbf{OK}. |
60 | 55 | \label{fig:color_window_background} |
61 | 56 | \end{figure} |
62 | 57 | |
63 | -The figure \ref{fig:background_color} illustrates the correspondent window with modified background color. | |
58 | +Figure~\ref{fig:background_color} illustrates an InVesalius window with the background color changed. | |
64 | 59 | |
65 | 60 | \begin{figure}[!htb] |
66 | 61 | \centering |
... | ... | @@ -73,8 +68,7 @@ The figure \ref{fig:background_color} illustrates the correspondent window with |
73 | 68 | |
74 | 69 | \section{Show/hide text in 2D windows} |
75 | 70 | |
76 | -To show or hide the texts in 2D image windows, click in the shortcut illustrated | |
77 | -in figure \ref{fig:text}, located in tools bar. | |
71 | +To show or hide text in 2D image windows, click on the shortcut illustrated in Figure~\ref{fig:text} on the toolbar. | |
78 | 72 | |
79 | 73 | \begin{figure}[!htb] |
80 | 74 | \centering |
... | ... | @@ -83,7 +77,7 @@ in figure \ref{fig:text}, located in tools bar. |
83 | 77 | \label{fig:text} |
84 | 78 | \end{figure} |
85 | 79 | |
86 | -Figures \ref{fig:text_on} and \ref{fig:text_off} exhibit texts enabled and disabled, respectively. | |
80 | +Figures~\ref{fig:text_on} and~\ref{fig:text_off} show text enabled and disabled, respectively. | |
87 | 81 | |
88 | 82 | \begin{figure}[!htb] |
89 | 83 | \centering | ... | ... |
docs/user_guide_en_source/cap_export.tex
1 | 1 | \chapter{Data export} |
2 | 2 | |
3 | -InVesalius allows to export data in different formats, such as OBJ, STL and others, to be used in other software. | |
3 | +InVesalius can export data in different formats, such as OBJ, STL and others, to be used in other software. | |
4 | 4 | |
5 | -Menu to export data is located in the left panel of InVesalius, | |
6 | -inside item \textbf{4. Export data}. If the menu is not visible, double-click with \textbf{left} mouse button | |
7 | -to expand the item. Figure \ref{fig:data_export} exhibit this menu. | |
5 | +The menu to export data is located in the left panel of InVesalius, inside item \textbf{4. Export data} (displayed below in Figure~\ref{fig:data_export}). If the menu is not visible, double-click with the \textbf{left} mouse button to expand the item. | |
8 | 6 | |
9 | 7 | \begin{figure}[!htb] |
10 | 8 | \centering |
... | ... | @@ -15,8 +13,7 @@ to expand the item. Figure \ref{fig:data_export} exhibit this menu. |
15 | 13 | |
16 | 14 | \section{Surface} |
17 | 15 | |
18 | -To export a surface, select it from the data menu as shown in | |
19 | -figure \ref{fig:data_export_selection}. | |
16 | +To export a surface, select it from the data menu as shown in Figure~\ref{fig:data_export_selection}. | |
20 | 17 | |
21 | 18 | \newpage |
22 | 19 | |
... | ... | @@ -27,7 +24,7 @@ figure \ref{fig:data_export_selection}. |
27 | 24 | \label{fig:data_export_selection} |
28 | 25 | \end{figure} |
29 | 26 | |
30 | -Next, click on the icon shown in figure \ref{fig:surface_export_original}. | |
27 | +Next, click on the icon shown in Figure~\ref{fig:surface_export_original}. | |
31 | 28 | |
32 | 29 | \begin{figure}[!htb] |
33 | 30 | \centering |
... | ... | @@ -36,9 +33,7 @@ Next, click on the icon shown in figure \ref{fig:surface_export_original}. |
36 | 33 | \label{fig:surface_export_original} |
37 | 34 | \end{figure} |
38 | 35 | |
39 | -In the correspondent window (figure \ref{fig:export_data_window}), tyoe the file name and | |
40 | -select the desired exported format. Finally, click \textbf{Save}. | |
41 | - | |
36 | +When the file window displays (as shown in Figure~\ref{fig:export_data_window}), type the file name and select the desired exported format. Finally, click \textbf{Save}. | |
42 | 37 | |
43 | 38 | \begin{figure}[!htb] |
44 | 39 | \centering |
... | ... | @@ -47,8 +42,7 @@ select the desired exported format. Finally, click \textbf{Save}. |
47 | 42 | \label{fig:export_data_window} |
48 | 43 | \end{figure} |
49 | 44 | |
50 | -Files formats avaiable for exportation are listed in table | |
51 | -\ref{tab:files_export_list}: | |
45 | +Files formats avaiable for exportation are listed in table~\ref{tab:files_export_list}: | |
52 | 46 | |
53 | 47 | \begin{table}[h] |
54 | 48 | \centering |
... | ... | @@ -74,10 +68,7 @@ Wavefront & .obj\\ |
74 | 68 | |
75 | 69 | \section{Image} |
76 | 70 | |
77 | -Images exhibited in any orientation (axial, coronal, | |
78 | -sagittal and 3D) can be exported. To do so, click with mouse \textbf{left} button on the shortcut | |
79 | -shown in figure \ref{fig:menu_save_image_window} and select the sub-window related to the target | |
80 | -image to be exported. | |
71 | +Images exhibited in any orientation (axial, coronal, sagittal and 3D) can be exported. To do so, \textbf{left-click} on the shortcut shown in Figure~\ref{fig:menu_save_image_window} and select the sub-window related to the target image to be exported. | |
81 | 72 | |
82 | 73 | \begin{figure}[!htb] |
83 | 74 | \centering |
... | ... | @@ -86,8 +77,7 @@ image to be exported. |
86 | 77 | \label{fig:menu_save_image_window} |
87 | 78 | \end{figure} |
88 | 79 | |
89 | -On the windown shown (figure \ref{fig:save_image_window}), select the desired file cormat and click | |
90 | -on the button \textbf{Save}. | |
80 | +On the window shown (Figure~\ref{fig:save_image_window}), select the desired file format, then click \textbf{Save}. | |
91 | 81 | |
92 | 82 | \begin{figure}[!htb] |
93 | 83 | \centering | ... | ... |
docs/user_guide_en_source/cap_geren_dados.tex
1 | 1 | \chapter{Data management} |
2 | 2 | |
3 | -Previously, it was shown how to manipulate surfaces, masks for segmentation and measurements. It is possible to show or | |
4 | -hide, and create or remove these elements at the \textbf{Data} management panel, located in the left inferior corner of | |
5 | -Invesalius. The panel is divided in 3 tabs: \textbf{Masks}, \textbf{3D Surfaces} and \textbf{Measurements}, shown in | |
6 | -figure \ref{fig:volumetric_data}. Each tab contains features corresponding to the elements it referes to. | |
3 | +We have previously shown how to manipulate surfaces, masks for segmentation and measurements. We can also show or hide, and create or remove these elements in the \textbf{Data} management panel, located in the lower left corner of InVesalius. The panel is divided into 3 tabs: \textbf{Masks}, \textbf{3D Surfaces} and \textbf{Measurements}, as shown in Figure~\ref{fig:volumetric_data}. Each tab contains features corresponding to the elements it refers to. | |
7 | 4 | |
8 | 5 | \begin{figure}[!htb] |
9 | 6 | \centering |
... | ... | @@ -12,10 +9,7 @@ figure \ref{fig:volumetric_data}. Each tab contains features corresponding to th |
12 | 9 | \label{fig:volumetric_data} |
13 | 10 | \end{figure} |
14 | 11 | |
15 | -In each tab, there is a panel divided in rows and columns. First column of each line determines the visualization status | |
16 | -of the listed element. It means that the "eye" icon activates or deactivates the masks, surface or measurement exibition. | |
17 | -In case one of these elements is being exhibited, its corresponding icon shown in figure \ref{fig:disable_mask}, will | |
18 | -also be visible. | |
12 | +In each tab, there is a panel divided into rows and columns. The first column of each line determines the visualization status of the listed element. The "eye" icon activates or deactivates the masks, surface or measurement displayed. When one of these elements is being displayed, its corresponding icon (as shown in Figure~\ref{fig:disable_mask}) will also be visible. | |
19 | 13 | |
20 | 14 | \newpage |
21 | 15 | |
... | ... | @@ -26,9 +20,7 @@ also be visible. |
26 | 20 | \label{fig:disable_mask} |
27 | 21 | \end{figure} |
28 | 22 | |
29 | -Some operations may be porformed with the data. For instance, to remove one element, it is necessary to first select | |
30 | -its name, show in figure \ref{fig:selected_mask} and next click in the shortcut illustrated in | |
31 | -figure \ref{fig:delete_data}. | |
23 | +Some operations may be performed with the data. For instance, to remove one element, first select its name, as shown in Figure~\ref{fig:selected_mask}. Next, click in the shortcut shown in Figure~\ref{fig:delete_data}. | |
32 | 24 | |
33 | 25 | \begin{figure}[!htb] |
34 | 26 | \centering |
... | ... | @@ -45,8 +37,7 @@ figure \ref{fig:delete_data}. |
45 | 37 | \label{fig:delete_data} |
46 | 38 | \end{figure} |
47 | 39 | |
48 | -To create a new mask, surface or measurement, click in the shortcut show in figure \ref{fig:new_data}, considering that | |
49 | -the corresponding tab must be open. | |
40 | +To create a new mask, surface or measurement, click on the shortcut shown in Figure~\ref{fig:new_data}, provided that the corresponding tab is open. | |
50 | 41 | |
51 | 42 | \begin{figure}[!htb] |
52 | 43 | \centering |
... | ... | @@ -55,7 +46,7 @@ the corresponding tab must be open. |
55 | 46 | \label{fig:new_data} |
56 | 47 | \end{figure} |
57 | 48 | |
58 | -To duplicate a data, select it and click in the shortcut shown in figure \ref{fig:duplicate_data}. | |
49 | +To duplicate data, select data to be duplicated and click in the shortcut shown in Figure~\ref{fig:duplicate_data}. | |
59 | 50 | |
60 | 51 | \begin{figure}[!htb] |
61 | 52 | \centering |
... | ... | @@ -64,20 +55,15 @@ To duplicate a data, select it and click in the shortcut shown in figure \ref{fi |
64 | 55 | \label{fig:duplicate_data} |
65 | 56 | \end{figure} |
66 | 57 | |
67 | - | |
68 | 58 | \newpage |
69 | 59 | |
70 | - | |
71 | 60 | \section{Masks} |
72 | 61 | |
73 | -At column \textbf{Name}, the mask's color and name are show. In turn, column \textbf{Threshold} show the value range | |
74 | -used to create the mask. Figure \ref{fig:volumetric_data} exhibits an example. | |
62 | +In the Name column, the mask’s color and name are shown. The \textbf{Threshold} column shows the value range used to create the mask. Figure~\ref{fig:volumetric_data} shows an example. | |
75 | 63 | |
76 | 64 | \section{3D Surface} |
77 | 65 | |
78 | -At column \textbf{Name}, the surface's color and name are show. Column \textbf{Volume} show the total surface volume. | |
79 | -Finally, column \textbf{Transparency} indicates the level of transparency in use for surface visualization. | |
80 | -Figure \ref{fig:surface_manager} shows an example. | |
66 | +In the \textbf{Name} column, the surface’s color and name are shown. The \textbf{Volume} column shows the total surface volume. Finally, the \textbf{Transparency} column indicates the level of transparency for use for surface visualization. Figure~\ref{fig:surface_manager} shows an example. | |
81 | 67 | |
82 | 68 | \begin{figure}[!htb] |
83 | 69 | \centering |
... | ... | @@ -88,9 +74,7 @@ Figure \ref{fig:surface_manager} shows an example. |
88 | 74 | |
89 | 75 | \subsection{Import surface} |
90 | 76 | |
91 | -It is possible to import a file of type STL, OBJ, PLY or VTP (VTK Polydata File Format) with an active InVesalius | |
92 | -project. To do so, click in the icon shown in figure~\ref{fig:import_stl}, select the | |
93 | -format of the corresponding file, figure~\ref{fig:import_surface}, and click Open. | |
77 | +We can also import STL, OBJ, PLY or VTP (VTK Polydata File Format) files into an active InVesalius project. To do so, click in the icon shown in Figure~\ref{fig:import_stl}, select the format of the corresponding file, (Figure~\ref{fig:import_surface}) and click Open. | |
94 | 78 | |
95 | 79 | \begin{figure}[!htb] |
96 | 80 | \centering |
... | ... | @@ -111,10 +95,7 @@ format of the corresponding file, figure~\ref{fig:import_surface}, and click Ope |
111 | 95 | |
112 | 96 | \section{Measurements} |
113 | 97 | |
114 | -The tab \textbf{Measurements} shows the following information. Column \textbf{Name} indicates the color and measurement | |
115 | -name. Column \textbf{Local} indicates where the measurement was taken (image axial, coronal, sagital or 3D), and | |
116 | -\textbf{Type} indicates the type of measurement (linear or angular). Finally, column \textbf{Value} shows the | |
117 | -measurement value. Figure \ref{fig:manager_mensuares} illustrates the \textbf{Measurements} tab. | |
98 | +The tab Measurements shows the following information. \textbf{Name} indicates the color and measurement name. \textbf{Local} indicates where the measurement was taken (image axial, coronal, sagital or 3D), and \textbf{Type} indicates the type of measurement (linear or angular). Finally, \textbf{Value} shows the measurement value. Figure~\ref{fig:manager_mensuares} illustrates the \textbf{Measurements} tab. | |
118 | 99 | |
119 | 100 | \begin{figure}[!htb] |
120 | 101 | \centering | ... | ... |
docs/user_guide_en_source/cap_masc.tex
... | ... | @@ -3,12 +3,12 @@ |
3 | 3 | |
4 | 4 | \section{Boolean operations} |
5 | 5 | |
6 | -After segmenting, some boolean operations can be performed between masks. The boolean operations supported by InVesalius are:\\ | |
6 | +After segmenting, some boolean operations can be performed between masks. The boolean operations supported by InVesalius are: | |
7 | 7 | |
8 | 8 | \begin{itemize} |
9 | 9 | \item \textbf{Union}, perform union between two masks; |
10 | - \item \textbf{Difference}, perform difference from the first mask to the second one;\\ | |
11 | - \item \textbf{Intersection}, keeps what is common in both masks.\\ | |
10 | + \item \textbf{Difference}, perform difference from the first mask to the second one; | |
11 | + \item \textbf{Intersection}, keeps what is common in both masks. | |
12 | 12 | \item \textbf{Exclusive disjunction (XOR)}: keeps the regions of the first mask which are not in the second mask and regions from the second mask which are no in the first mask. |
13 | 13 | \end{itemize} |
14 | 14 | ... | ... |
docs/user_guide_en_source/cap_med.tex
1 | 1 | \chapter{Measures} |
2 | 2 | |
3 | -InVesalius has linear and angular measurements in 2D (axial, coronal and sagittal planes) and 3D (surfaces). It is also possible to take measurements volume and area on surfaces. | |
3 | +InVesalius has linear and angular measurements in 2D (axial, coronal and sagittal planes) and 3D (surfaces). It is thus possible to take measurements of volume and area on surfaces. | |
4 | 4 | |
5 | 5 | \section{Linear Measurement} |
6 | 6 | |
7 | -To perform linear measurements, it is necessary to activate the feature by clicking on the shortcut corresponding toolbar located (figure\ref{fig:measure_line_original}). | |
7 | +To perform linear measurements, activate the feature by clicking on the shortcut shown below, located on the toolbar (Figure\ref{fig:measure_line_original}). | |
8 | 8 | |
9 | 9 | \begin{figure}[!htb] |
10 | 10 | \centering |
... | ... | @@ -13,11 +13,11 @@ To perform linear measurements, it is necessary to activate the feature by click |
13 | 13 | \label{fig:measure_line_original} |
14 | 14 | \end{figure} |
15 | 15 | |
16 | -A linear measurement is defined between two points. With the feature enabled, click \textbf{once} on the image to set the starting point. Then position the mouse pointer on the end point and click \textbf{one} again. The measurement is performed and the result is automatically displayed on the image or surface. | |
16 | +A linear measurement is taken between two points. With the feature enabled, click \textbf{once} on the image to set the starting point. Then position the mouse pointer on the end point and click once again. The measurement is performed and the result is automatically displayed on the image or surface | |
17 | 17 | |
18 | -The figure \ref{fig:axial_linear} shows a 2D linear measure in the axial orientation, and the figure \ref{fig:3d_linear} shows another linear measure in 3D (surface). | |
18 | +Figure~\ref{fig:axial_linear} shows a 2D linear measure in the axial orientation, and Figure~\ref{fig:3d_linear} shows another linear measure in 3D (surface). | |
19 | 19 | |
20 | -Once you have made the 2D linear measurement, you can edit it by placing the mouse on one end, holding down the \textbf{right mouse button} and dragging it to the desired position. | |
20 | +Once you have made a 2D linear measurement, it can be edited by placing the mouse on one end, holding down the \textbf{right mouse button} and dragging it to the desired position. | |
21 | 21 | |
22 | 22 | \begin{figure}[!htb] |
23 | 23 | \centering |
... | ... | @@ -37,7 +37,7 @@ Once you have made the 2D linear measurement, you can edit it by placing the mou |
37 | 37 | |
38 | 38 | \section{Angular Measurement} |
39 | 39 | |
40 | -An angular measurement in 2D on a surface (3D) can be done by clicking on the shortcut shown in figure~\ref{fig:atalho_angular}. | |
40 | +An angular measurement in 2D on a surface (3D) can be done by clicking on the shortcut shown in Figure~\ref{fig:atalho_angular}. | |
41 | 41 | |
42 | 42 | \begin{figure}[!htb] |
43 | 43 | \centering |
... | ... | @@ -46,11 +46,11 @@ An angular measurement in 2D on a surface (3D) can be done by clicking on the sh |
46 | 46 | \label{fig:atalho_angular} |
47 | 47 | \end{figure} |
48 | 48 | |
49 | -To perform the angular measurement, is necessary to provide the three points that will describe the angle to be measured, A\^{B}C. Click \textbf{one} instead with the left button to determine the first point, A. To insert the second point, B (the vertex of the angle or the "center"), position the mouse pointer and click \textbf{one} again. Repeat the same actions to determine the third point, C. The resulting measurement is displayed on the image or surface. | |
49 | +To perform the angular measurement, it is necessary to provide the three points that will describe the angle to be measured, A\^{B}C. Insert the first point by clicking once to select point A. Insert point B (the vertex or "point" of the angle) by positioning the cursor and clicking once again. Repeat the same actions to determine the endpoint of the angle, C. The resulting measurement is displayed on the image or surface. | |
50 | 50 | |
51 | -The figure \ref{fig:axial_angular} illustrates an angular measurement on a flat image, and the figure \ref{fig:axial_superficie} illustrates an angular measurement on a surface. | |
51 | +Figure~\ref{fig:axial_angular} illustrates an angular measurement on a flat image; Figure~\ref{fig:axial_superficie} illustrates an angular measurement on a surface. | |
52 | 52 | |
53 | -As 2D linear measurement, you can also edit the 2D angular measurement, so you need to position the mouse on one end, hold down the \textbf{right mouse button} and drag it to the desired position. | |
53 | +In regards to 2D linear measurement, you can also edit the 2D angular measurement. Just position the mouse on one end, hold down the right mouse button and drag it to the desired position. | |
54 | 54 | |
55 | 55 | \begin{figure}[!htb] |
56 | 56 | \centering |
... | ... | @@ -71,8 +71,7 @@ As 2D linear measurement, you can also edit the 2D angular measurement, so you n |
71 | 71 | |
72 | 72 | \section{Volumetric Measurement} |
73 | 73 | |
74 | -Volume and area measurements are made automatically when you create a new surface. they are displayed in the \textbf{Surfaces 3D} tab in the \textbf{Data} management panel, located in the corner | |
75 | -Bottom left of the screen, as illustrated in figure~\ref{fig:volumetric_mensure}. | |
74 | +Volume and area measurements are made automatically when you create a new surface. These are displayed in the \textbf{Surfaces 3D} tab in the \textbf{Data} management panel, located in the bottom left corner of the screen, as illustrated in Figure~\ref{fig:volumetric_mensure}. | |
76 | 75 | |
77 | 76 | \begin{figure}[!htb] |
78 | 77 | \centering | ... | ... |
docs/user_guide_en_source/cap_nav.tex
1 | 1 | \chapter{Neuronavegation} |
2 | 2 | \label{sec:neuronavegador} |
3 | 3 | |
4 | -An introduction to neuronavigation theory was presented in section~\ref{sec:neuronavegador_intro}. Reading is recommended before its use. | |
4 | +An introduction to neuronavigation theory was presented in section~\ref{sec:neuronavegador_intro}. Please read that section before using the features detailed below. | |
5 | 5 | |
6 | -Enable the InVesalius neuronavigation mode by selecting the \textbf{Mode} tab in the main menu and | |
7 | -then \textbf{Navigation}, figure ~\ref{fig:nav_menu_en}. A \textbf{Navigation System} tab will be visible in the | |
8 | -panel in the left of the main window, as shown in figure~\ref{fig:nav_painel_en}. | |
6 | +To enable the InVesalius neuronavigation mode, select the \textbf{Mode} tab in the main menu and then Navigation (Figure~\ref{fig:nav_menu_en}). A \textbf{Navigation System} tab will then display in the panel to the left of the main window, as shown in Figure~\ref{fig:nav_painel_en}. | |
9 | 7 | |
10 | 8 | \begin{figure}[!htb] |
11 | 9 | \centering |
... | ... | @@ -23,13 +21,9 @@ panel in the left of the main window, as shown in figure~\ref{fig:nav_painel_en} |
23 | 21 | |
24 | 22 | \section{Spatial trackers and reference mode} |
25 | 23 | |
26 | -Currently, InVesalius Navigator supports three spatial tracking devices from two manufacturers, the MicronTracker | |
27 | -from ClaroNav (Toronto, Canada; figure~\ref{fig:tracker_claron}) and Fastrak, Isotrak and Patriot | |
28 | -from Polhemus (Colchester, United States; figure~\ref{fig:tracker_polhemus}). | |
24 | +Currently, InVesalius Navigator supports four spatial tracking devices from two manufacturers: the MicronTracker from ClaroNav (Toronto, Canada; Figure~\ref{fig:tracker_claron}) and Fastrak, Isotrak and Patriot from Polhemus (Colchester, United States; Figure~\ref{fig:tracker_polhemus}). | |
29 | 25 | |
30 | -After this, the first step is to choose the tracker in the menu \textbf{Select tracker:}, figure~\ref{fig:nav_select_tracker}. | |
31 | -The option \textbf{Debug tracker} allows the user to test the system even if none spatial tracker is connected. | |
32 | -This option simulates a spatial tracker by generating random coordinates. | |
26 | +First, choose the tracker in the menu \textbf{Select tracker} (Figure~\ref{fig:nav_select_tracker}). The option \textbf{Debug tracker} allows the user to test the system even if there is no spatial tracker connected, instead simulating a spatial tracker by generating random coordinates. | |
33 | 27 | |
34 | 28 | \begin{figure}[!htb] |
35 | 29 | \centering |
... | ... | @@ -52,12 +46,7 @@ This option simulates a spatial tracker by generating random coordinates. |
52 | 46 | \label{fig:nav_select_tracker} |
53 | 47 | \end{figure} |
54 | 48 | |
55 | -There are two references types to perform the navigation, static and dynamic (figure~\ref{fig:nav_menu_ref}). | |
56 | -Static mode uses just one spatial tracker probe. In this mode, the subject head must stay motionless after | |
57 | -registration (for more info about coregistration see section~\ref{sec:corregistro}). To avoid head movements artifacts, | |
58 | -a reference probe attached to some static part of the head is required, e.g. forehead. During neuronavigation | |
59 | -procedures, the reference probe will detect and correct the translation and rotation from the head. | |
60 | -This mode is known as dynamic reference. | |
49 | +There are two methods to perform the navigation: static and dynamic (Figure~\ref{fig:nav_menu_ref}). Static mode uses just one spatial tracker probe. In this mode, the subject's head must stay motionless after registration (for more info about coregistration see Section~\ref{sec:corregistro} probes: a reference probe must head (e.g. forehead). during the probe will detect and correct any 16.2). Dynamic mode uses multiple be attached to a static part of the neuronavigation process; the reference movements from the head. | |
61 | 50 | |
62 | 51 | \begin{figure}[!htb] |
63 | 52 | \centering |
... | ... | @@ -69,12 +58,7 @@ This mode is known as dynamic reference. |
69 | 58 | \section{Coregistration} |
70 | 59 | \label{sec:corregistro} |
71 | 60 | |
72 | -The aim of coregistration procedure is to find a relation that transforms a coordinate given in the tracking device space | |
73 | -to a coordinate in the virtual space (image). To perform the coregistration, the user must | |
74 | -use the function of \textbf{Correspondence between orientations axial, sagittal and coronal} (see section~\ref{sec:corresp_all_orient}) | |
75 | -and select three anatomical fiducials in the image and then collect the same three fiducials with the spatial tracker. | |
76 | -The most common anatomical fiducials are the nasion and both tragus (ears). Figure~\ref{fig:nav_selec_coord} shows the fiducials panel. | |
77 | -When some image fiducial is selected, a marker (green sphere) is created in the volume, figure~\ref{fig:nav_balls_in_head}. | |
61 | +The aim of coregistration is to transform a coordinate given in the tracking device space to a coordinate in the virtual space (image). To perform coregistration, the user must use the function \textbf{Correspondence between orientations axial, sagittal and coronal} (see section~\ref{sec:corresp_all_orient}) and select three anatomical fiducials in the image. Then, collect the same three fiducials with the spatial tracker. The most common anatomical fiducials are the nasion and both tragus (ears). Figure~\ref{fig:nav_selec_coord} shows the fiducials panel. When an image fiducial is selected, a marker (green sphere) is created (shown in Figure~\ref{fig:nav_balls_in_head}). | |
78 | 62 | |
79 | 63 | \begin{figure}[!htb] |
80 | 64 | \centering |
... | ... | @@ -104,15 +88,10 @@ The buttons acronyms represent: |
104 | 88 | |
105 | 89 | \section{Fiducial registration error and navigation} |
106 | 90 | |
107 | -After all fiducials are selected in both spaces (tracker and image) the next step is to press button \textbf{Navegate} | |
108 | -button to start the neuronavigation. To stop navigation just press the button \textbf{Navigate} again. | |
109 | -Immediately after the navigation starts, the \textit{Fiducial Registration Error} (FRE) is calculated. The FRE is the | |
110 | -root mean square distance between the image fiducials used for and after registration. | |
91 | +After all fiducials are selected in both spaces (tracker and image), press the \textbf{Navigate} button to start the neuronavigation process. To stop navigation, simply press \textbf{Navigate} again. Immediately after the navigation starts, the \textbf{Fiducial Registration Error} (FRE) is calculated. The FRE is the root mean square distance between the image fiducials used before and after registration. | |
111 | 92 | |
112 | -In the left side of navigate button there is a FRE text box. If FRE is high (greater than 3 mm) the navigation will not | |
113 | -be precise and the text box will become red, figure~\ref{fig:nav_fre_error}, it is recommended that the coregistration | |
114 | -is redone. Otherwise, if FRE is lower than 3 mm, the text box becomes green, showing that the navigation has an | |
115 | -acceptable precision, figure~\ref{fig:nav_fre_ok}. | |
93 | + | |
94 | +To the left of the Navigate button there is a FRE text box. If FRE is high (greater than 3 mm) the navigation will not be precise and the text box will become red (Figure~\ref{fig:nav_fre_error}). If this occurs, the coregistration should be redone. If FRE is lower than 3 mm, the text box will turn green, showing that the navigation has an acceptable precision (Figure~\ref{fig:nav_fre_ok}). | |
116 | 95 | |
117 | 96 | \begin{figure}[!htb] |
118 | 97 | \centering |
... | ... | @@ -130,25 +109,18 @@ acceptable precision, figure~\ref{fig:nav_fre_ok}. |
130 | 109 | |
131 | 110 | \section{Markers} |
132 | 111 | |
133 | -During navigation, it is possible to create sphere markers in the 3D volume. To do that, the user needs to select | |
134 | -\textbf{Extra tools} tab, figure~\ref{fig:nav_extra_tools}. | |
112 | +During navigation, it is possible to create sphere markers in the 3D space. To do so, select the \textbf{Extra tools} tools tab (Figure~\ref{fig:nav_extra_tools}). | |
135 | 113 | |
136 | 114 | \begin{figure}[!htb] |
137 | 115 | \centering |
138 | 116 | \includegraphics[scale=0.6]{nav_extra_tools_en.png} |
139 | -\caption{Aba para manipulação de marcadores.} | |
117 | +\caption{Markers manipulation tab.} | |
140 | 118 | \label{fig:nav_extra_tools} |
141 | 119 | \end{figure} |
142 | 120 | |
143 | -The marker creation will be positioned in the current red cross position. The size and color can be | |
144 | -changed, figure~\ref{fig:nav_vol_with_markers}. | |
121 | +The marker will be positioned in the current red cross position. The size and color can be changed as needed (Figure~\ref{fig:nav_vol_with_markers}). | |
145 | 122 | |
146 | -When a marker is created, its coordinates appear in the list control. To identify one marker of the list control in the | |
147 | -volume, \textbf{double-click with left mouse button} the target item and the corresponding marker will blink. | |
148 | -To stop blinking the markers, the user just needs to select another marker, i.e. press once in another item. | |
149 | -It is also possible to create an ID to the marker, and to do that right click and select \textbf{Edit ID}, like | |
150 | -in figure ~\ref{fig:nav_id_list_markers}. Finally, a window will open allowing the user to create | |
151 | -the ID, figure~\ref{fig:nav_edit_id_markers}. | |
123 | +When a marker is created, its coordinates will appear in the list control. To identify one marker in the volume, \textbf{double-click with the left} mouse button on the target item and the corresponding marker will blink. To stop blinking, select another marker. It is also possible to create an ID for the marker; simply right click and select \textbf{Edit ID} (Figure~\ref{fig:nav_id_list_markers}). Finally, a window will open allowing the user to define the ID (Figure~\ref{fig:nav_edit_id_markers}). | |
152 | 124 | |
153 | 125 | \begin{figure}[!htb] |
154 | 126 | \centering |
... | ... | @@ -171,25 +143,14 @@ the ID, figure~\ref{fig:nav_edit_id_markers}. |
171 | 143 | \label{fig:nav_edit_id_markers} |
172 | 144 | \end{figure} |
173 | 145 | |
174 | -The marker coordinates may be exported using the button \textbf{Save}. File extension is \textit{.mks}. This extension can be | |
175 | -opened in any word processor, e.g. Notepad or WordPad software. The file has the X, Y and Z coordinates followed by the RGB code, | |
176 | -marker size and ID. Posteriorly, the markers can be importated to the navigation system using button \textbf{Load}. | |
177 | - | |
178 | -To remove markers, \textbf{select} one or as much markers needed to be deleted and press button \textbf{Remove}. | |
179 | -It is also possible to remove all markers, with the button \textbf{Remove all markers}. Another functionality | |
180 | -is to hide/show the markers in the volume using the \textbf{button show/hide}. | |
146 | +The marker coordinates may be exported using the \textbf{Save} button (the file extension will be \textit{.mks}). This extension can be opened in any word processor, e.g. Notepad or WordPad software. The file will contain the $X$, $Y$ and $Z$ coordinates followed by the RGB code, marker size and ID. Afterwards, the markers can be imported into the navigation system using the \textbf{Load} button. | |
181 | 147 | |
148 | +To remove markers, \textbf{select} one or more markers needing deletion and press \textbf{Remove}. It is also possible to remove all markers, with the button \textbf{Remove all markers}. All markers can be hidden or shown in the volume using the \textbf{show/hide button}. | |
182 | 149 | |
183 | 150 | \section{External trigger checkbox} |
184 | 151 | |
185 | -Another way to create markers is using an external trigger. To activate this feature, just press the | |
186 | -checkbox \textbf{External trigger} before the navigation starts. This function was developed to communicate with | |
187 | -TMS devices, to create a marker whereas the pulses are applied. Besides, it is possible to adapt this function as | |
188 | -the user needs. The communication with the external device requires a serial port COM1. If this port receives | |
189 | -any RS-232 signal in 9600 \textit{baud rate} it will create a marker in the current red cross position. | |
152 | +Markers can also be created by using an external trigger. To activate this feature, press the checkbox \textbf{External trigger} before starting navigation. This function was developed to communicate with TMS devices by creating a marker where the pulses are applied, and can be adapted as the user requires. Communication with an external device requires serial port COM1. If this port receives any RS-232 signal at a 9600 \textit{baud rate} it will create a marker in the current red cross position. | |
190 | 153 | |
191 | 154 | \section{Camera volume checkbox} |
192 | 155 | |
193 | -The volume camera positioning is updated automatically, both by the red cross and the spatial tracker probe positioning. | |
194 | -The user can disable this function by unchecking the \textbf{Camera volume} checkbox. | |
195 | -Therefore, the camera has to be manually changed. | |
156 | +The volume camera positioning is updated automatically, both by the red cross and the spatial tracker probe position. The user can disable this function by unchecking the \textbf{Camera volume} checkbox. However, the camera has to be manually changed. | ... | ... |
docs/user_guide_en_source/cap_stereoscop.tex
1 | 1 | \chapter{Stereoscopic Visualization} |
2 | 2 | |
3 | -InVesalius supports stereoscopic visualization of 3D models, so it is necessary to create a surface (see chapter~\ref{cap_surface}) or an active volumetric visualization (see chapter~\ref{cap:vis_vol}), then click the icon That the figure~\ref{fig:ster} shows on the right side the bottom part of InVesalius and choose the desired projection type (figure~\ref{fig:st_menu}). | |
3 | +InVesalius supports stereoscopic visualization of 3D models. First a surface (see chapter~\ref{cap_surface}) or an active volumetric visualization (see chapter~\ref{cap:vis_vol}) must be created. Then, click the icon (shown in Figure~\ref{fig:ster}) on the bottom right part of the interface and choose the desired projection type (Figure~\ref{fig:st_menu}). | |
4 | 4 | |
5 | 5 | |
6 | 6 | \begin{figure}[!htb] | ... | ... |
docs/user_guide_en_source/cap_superf.tex
1 | 1 | \chapter{Surface (Triangle mesh)} |
2 | 2 | \label{cap_surface} |
3 | 3 | |
4 | -At InVesalius, a 3D surface is generated based on a image segmentation. A surface is generated using the \textit{marching cubes} algorithm. In a nutshell, this algorithm transforms \textit{voxels} from the stacked and segmented images to polygons (triangles in this case). | |
4 | +InVesalius, generates 3D surfaces based on image segmentation. A surface is generated using the marching cubes algorithm by transforming voxels from the stacked and segmented images to polygons (triangles in this case). | |
5 | 5 | |
6 | -On the left panel, inside \textbf{3. Configure 3D surface}, \textbf{Surface properties} you have the controls to configure a 3D surface. | |
6 | +The controls to configure a 3D surface are accessible on the left panel, under \textbf{3. Configure 3D surface}, \textbf{Surface properties} you have the controls to configure a 3D surface (Figure~\ref{fig:3d_surface_managment}). | |
7 | 7 | |
8 | 8 | \begin{figure}[!htb] |
9 | 9 | \centering |
... | ... | @@ -15,7 +15,7 @@ On the left panel, inside \textbf{3. Configure 3D surface}, \textbf{Surface prop |
15 | 15 | |
16 | 16 | \section{Creating 3D surfaces} |
17 | 17 | |
18 | -It's possible create a new surface based on a already segmented mask. To do that, on the left panel, \textbf{3. Configure 3D surface}, click on the button shown at the figure~\ref{fig:shortcut_new_surface}. | |
18 | +News surfaces can be created using an already segmented mask. To do so, on the left panel under \textbf{3. Configure 3D surface}, click on the button shown in Figure~\ref{fig:shortcut_new_surface}. | |
19 | 19 | |
20 | 20 | \begin{figure}[!htb] |
21 | 21 | \centering |
... | ... | @@ -24,7 +24,7 @@ It's possible create a new surface based on a already segmented mask. To do that |
24 | 24 | \label{fig:shortcut_new_surface} |
25 | 25 | \end{figure} |
26 | 26 | |
27 | -After clicking this button a dialog will be shown (figure \ref{fig:create_surface_1}). This dialog allows to configure the 3D surface creation. It allows to set the quality of the surface, to fill the surface holes and to keep only the largest connected region of the surface. | |
27 | +After clicking this button a dialog will be shown (Figure~\ref{fig:create_surface_1}). This dialog allows for the configuration of the 3D surface created, including setting the quality of the surface, filling surface holes whilst keeping the largest connected region of the surface intact. | |
28 | 28 | |
29 | 29 | \begin{figure}[!htb] |
30 | 30 | \centering |
... | ... | @@ -33,10 +33,7 @@ After clicking this button a dialog will be shown (figure \ref{fig:create_surfac |
33 | 33 | \label{fig:create_surface_1} |
34 | 34 | \end{figure} |
35 | 35 | |
36 | -%Existe 2 opções para fechar os buracos existentes e para selecionar a maior região da superfície aonde em muitos | |
37 | -%casos é útil para remover o suporte ou a mesa do tomografo. | |
38 | - | |
39 | -The keep largest region option may be used, for instance, to remove the tomograph support. Figure~\ref{fig:surface_ex1} displays a surface created with \textbf{Keep largest region} and \textbf{Fill holes} activated. | |
36 | +The keep largest region option may be used, for instance, to remove the tomograph supports. Figure~\ref{fig:surface_ex1} displays a surface created with \textbf{Keep largest region} and \textbf{Fill holes} activated, whereas Figure~\ref{fig:surface_ex2} displays the surface create without activating that options. Note the tomograph support and the holes. | |
40 | 37 | |
41 | 38 | \begin{figure}[!htb] |
42 | 39 | \centering |
... | ... | @@ -46,8 +43,6 @@ The keep largest region option may be used, for instance, to remove the tomograp |
46 | 43 | \label{fig:surface_ex1} |
47 | 44 | \end{figure} |
48 | 45 | |
49 | -Whereas the figure~\ref{fig:surface_ex2} displays the surface create without activating that options. Note the tomograph support and the holes. | |
50 | - | |
51 | 46 | \begin{figure} |
52 | 47 | \centering |
53 | 48 | \subfloat[Frente]{\label{fig:__2}\includegraphics[width=0.371\textwidth]{surface_model_front_all_parts.jpg}} |
... | ... | @@ -56,15 +51,15 @@ Whereas the figure~\ref{fig:surface_ex2} displays the surface create without act |
56 | 51 | \label{fig:surface_ex2} |
57 | 52 | \end{figure} |
58 | 53 | |
59 | -The item \textbf{Surface creation method} has the following options:\textbf{Binary}, \textbf{Context aware smoothing} and \textbf{Default}. Figure~\ref{fig:surf_method} shows an example of surface created using each of these 3 methods. | |
54 | +The \textbf{Surface creation method} item has the following options: \textbf{Binary}, \textbf{Context aware smoothing} and \textbf{Default}. Figure~\ref{fig:surf_method} shows an example of surface created using each of these 3 methods. | |
60 | 55 | |
61 | 56 | The \textbf{Binary} method takes as input the segmentation mask which is binary, where selected regions have value 1 and non-selected have value 0. As it is binary, the surface generated has a blocky aspect, mainly in high curvature areas, appearing staircases. |
62 | 57 | |
63 | -\textbf{Context aware smoothing} starts generating the surface using binary method. After that it uses the algorithm \textbf{Context aware smoothing} to smooth the surface to avoid the staircase artifacts. This method has 4 parameters presented bellow. | |
58 | +\textbf{Context aware smoothing} starts generating the surface using Binary, then uses another algorithm in order to smooth the surface to avoid staircase details. This method has 4 parameters presented below. | |
64 | 59 | |
65 | -The \textbf{angle} parameter is the angle between 2 adjacent triangles. If the calculated angle is \textbf{greater than} the angle parameter the triangle will be considered a staircase triangle and will be smoothed. The angle parameter ranges from $0$ to $1$. Where $0$ is $0^\circ$ and $1$ is $90^\circ$. The \textbf{Max distance} is the maximum distance that a non-staircase triangle has to be from a staircase triangle to be considered to be smoothed. Non-staircase triangles with distance greater than \textbf{Max distance} also will be smoothed but the smoothing will be weighted by the \textbf{Min. weight} parameter. This parameter ranges from $0$ (without smoothing) to $1$ (total smoothing). The last parameter, \textbf{N. steps}, is the number of times the smoothing algorithm will be run. The greater this parameter the smoother the surface will be. | |
60 | +The \textbf{angle} parameter is the angle between 2 adjacent triangles. If the calculated angle is greater than the angle parameter the triangle will be considered a staircase triangle and will be smoothed. The angle parameter ranges from $0$ to $1$, where $0$ is $0^\circ$ and $1$ is $90^\circ$. The \textbf{Max distance} is the maximum distance that a non-staircase triangle may be from a staircase triangle to be considered to be smoothed. Non-staircase triangles with distance greater than Max distance also will be smoothed but the smoothing will be determined by the \textbf{Min. weight} parameter. This parameter ranges from $0$ (without smoothing) to $1$ (total smoothing). The last parameter, \textbf{N.steps}, is the number of times the smoothing algorithm will be run. The greater this parameter the smoother the surface will be. | |
66 | 61 | |
67 | -The \textbf{Default} method is enable only when \textbf{it was used thresholding segmentation and there is not a manual edition in the mask}. This method doesn't use the mask image, but the exam image, and generates a smoother surface. | |
62 | +The \textbf{Default} method is enabled only when thresholding segmentation was used without any manual modification to the mask. This method does not use the mask image, but the raw image, and generates a smoother surface. | |
68 | 63 | |
69 | 64 | \begin{figure}[!htb] |
70 | 65 | \centering |
... | ... | @@ -79,7 +74,7 @@ The \textbf{Default} method is enable only when \textbf{it was used thresholding |
79 | 74 | |
80 | 75 | \section{Transparency} |
81 | 76 | |
82 | -It's also possible to display a surface with some level of Transparency. To do that, first select the desired surface from the list of surfaces, in the item \textbf{3. Configure 3D surface}, \textbf{Surface properties} (figure \ref{fig:select_surface}). | |
77 | +The Transparency function allows for the displaying of a surface transparently. To do so, select the desired surface from the list of surfaces, in the item \textbf{3. Configure 3D surface}, \textbf{Surface properties} (Figure~\ref{fig:select_surface}). | |
83 | 78 | |
84 | 79 | \begin{figure}[!htb] |
85 | 80 | \centering |
... | ... | @@ -88,7 +83,7 @@ It's also possible to display a surface with some level of Transparency. To do t |
88 | 83 | \label{fig:select_surface} |
89 | 84 | \end{figure} |
90 | 85 | |
91 | -Then, to set the level of surface transparency, use de sliding control shown in the figure~\ref{fig:select_transparency}. The more to right the more transparent the surface will be shown. | |
86 | +Then, to set the level of surface transparency, use the sliding control shown in Figure~\ref{fig:select_transparency}; the more to the right, the more transparent the surface will be. | |
92 | 87 | |
93 | 88 | \begin{figure}[!htb] |
94 | 89 | \centering |
... | ... | @@ -97,7 +92,7 @@ Then, to set the level of surface transparency, use de sliding control shown in |
97 | 92 | \label{fig:select_transparency} |
98 | 93 | \end{figure} |
99 | 94 | |
100 | -Figure~\ref{fig:model_transparency} shows 2 surfaces: the extern surface (green color) has some level of transparency which permits to see the intern surface (yellow color). | |
95 | +Figure~\ref{fig:model_transparency} shows 2 surfaces: the external surface in green has some level of transparency which permits to see the internal surface in yellow. | |
101 | 96 | |
102 | 97 | \begin{figure}[!htb] |
103 | 98 | \centering |
... | ... | @@ -110,7 +105,7 @@ Figure~\ref{fig:model_transparency} shows 2 surfaces: the extern surface (green |
110 | 105 | |
111 | 106 | \section{Color} |
112 | 107 | |
113 | -It's possible to change a surface color. Select the surface (see figure~\ref{fig:select_surface}). Click on the colored button on the right to the surface selection list. Figure~\ref{fig:change_surface_color} displays this button, inside the item \textbf{3. Configure 3D surface}, \textbf{Surface properties}. | |
108 | +Surface colors can be altered by selecting the surface (Figure~\ref{fig:select_surface}), and clicking on the colored button on the right of the surface selection list. Figure~\ref{fig:change_surface_color} displays this button, inside item \textbf{3. Configure 3D surface}, \textbf{Surface properties}. | |
114 | 109 | |
115 | 110 | \begin{figure}[!htb] |
116 | 111 | \centering |
... | ... | @@ -119,7 +114,7 @@ It's possible to change a surface color. Select the surface (see figure~\ref{fig |
119 | 114 | \label{fig:change_surface_color} |
120 | 115 | \end{figure} |
121 | 116 | |
122 | -A dialog will be shown (figure~\ref{fig:button_select_color}). Select the desired color and click on \textbf{Ok}. | |
117 | +A dialog will be shown (Figure~\ref{fig:button_select_color}). Select the desired color and click on \textbf{OK}. | |
123 | 118 | |
124 | 119 | \begin{figure}[!htb] |
125 | 120 | \centering |
... | ... | @@ -130,7 +125,7 @@ A dialog will be shown (figure~\ref{fig:button_select_color}). Select the desire |
130 | 125 | |
131 | 126 | \section{Splitting disconnected surfaces} |
132 | 127 | |
133 | -To split disconnected surfaces it's necessary to go to \textbf{3. Configure 3D surface}, \textbf{Advanced options} (figure~\ref{fig:advanced_tools}). | |
128 | +To split disconnected surfaces, select \textbf{3. Configure 3D surface}, \textbf{Advanced options} (Figure~\ref{fig:advanced_tools}). | |
134 | 129 | |
135 | 130 | \begin{figure}[!htb] |
136 | 131 | \centering |
... | ... | @@ -141,7 +136,7 @@ To split disconnected surfaces it's necessary to go to \textbf{3. Configure 3D s |
141 | 136 | |
142 | 137 | \newpage |
143 | 138 | |
144 | -The advanced options panel will be displayed (figure~\ref{fig:advanced_tools_expanded}). | |
139 | +The advanced options panel will be displayed (Figure~\ref{fig:advanced_tools_expanded}). | |
145 | 140 | |
146 | 141 | \begin{figure}[!htb] |
147 | 142 | \centering |
... | ... | @@ -152,7 +147,8 @@ The advanced options panel will be displayed (figure~\ref{fig:advanced_tools_exp |
152 | 147 | |
153 | 148 | \subsection{Select largest surface} |
154 | 149 | |
155 | -The option \textbf{Select largest surface} selects, automatically, only surface with the greater volume. To do this operation click on the button illustrated in the figure~\ref{fig:short_connectivity_largest}. This operation creates new surface with only the largest surface. | |
150 | +The option \textbf{Select largest surface} selects, automatically, only surface with the greater volume. Click on the button illustrated in Figure~\ref{fig:short_connectivity_largest}. This operation creates new a surface with only the largest surface. | |
151 | + | |
156 | 152 | |
157 | 153 | \begin{figure}[!htb] |
158 | 154 | \centering |
... | ... | @@ -161,7 +157,7 @@ The option \textbf{Select largest surface} selects, automatically, only surface |
161 | 157 | \label{fig:short_connectivity_largest} |
162 | 158 | \end{figure} |
163 | 159 | |
164 | -As an example, the figure~\ref{fig:extract_most_region_1} shows a surface before \textbf{Select largest surface}. | |
160 | +As an example, the Figure~\ref{fig:extract_most_region_1} shows a surface before \textbf{Select largest surface}. | |
165 | 161 | |
166 | 162 | \begin{figure}[!htb] |
167 | 163 | \centering |
... | ... | @@ -170,7 +166,7 @@ As an example, the figure~\ref{fig:extract_most_region_1} shows a surface before |
170 | 166 | \label{fig:extract_most_region_1} |
171 | 167 | \end{figure} |
172 | 168 | |
173 | -Whereas the figure~\ref{fig:extract_most_region2} shows the surface with largest disconnected region separated. | |
169 | +Whereas the Figure~\ref{fig:extract_most_region2} shows the surface with largest disconnected region separated. | |
174 | 170 | |
175 | 171 | \begin{figure}[!htb] |
176 | 172 | \centering |
... | ... | @@ -183,7 +179,7 @@ Whereas the figure~\ref{fig:extract_most_region2} shows the surface with largest |
183 | 179 | |
184 | 180 | \subsection{Select regions of interest} |
185 | 181 | |
186 | -Other selection option is \textbf{Select regions of interest ...}. To do this operation click on the button illustrated on the figure~\ref{fig:short_connectivity_manual}. Then click on desired disconnected surface regions you want to select. Next click on \textbf{Select regions of interest ...}. This operation will create new surface with only the selected disconnected regions. | |
182 | +Another selection option is Select regions of interest. To do this operation click on the button illustrated in Figure~\ref{fig:short_connectivity_manual}, then click on the desired disconnected surface regions you want to select. Next click on \textbf{Select regions of interest}. This operation will create a new surface with only the selected disconnected regions. | |
187 | 183 | |
188 | 184 | \begin{figure}[!htb] |
189 | 185 | \centering |
... | ... | @@ -192,7 +188,7 @@ Other selection option is \textbf{Select regions of interest ...}. To do this op |
192 | 188 | \label{fig:short_connectivity_manual} |
193 | 189 | \end{figure} |
194 | 190 | |
195 | -As an example, the figure~\ref{fig:extract_most_region3} shows the surface created after the user selects the cranium and the right part of the tomograph support. | |
191 | +As an example, the Figure~\ref{fig:extract_most_region3} shows the surface created after the user selects the cranium and the right part of the tomograph support. | |
196 | 192 | |
197 | 193 | \begin{figure}[!htb] |
198 | 194 | \centering |
... | ... | @@ -204,7 +200,7 @@ As an example, the figure~\ref{fig:extract_most_region3} shows the surface creat |
204 | 200 | |
205 | 201 | \subsection{Split all disconnected surfaces} |
206 | 202 | |
207 | -It's also possible to split all the disconnected surface regions automatically. To do this, click on the button illustrated in the figure~\ref{fig:connectivity_split_all}. | |
203 | +Disconnected surface regions can also be split automatically. To do this, click on the button illustrated in Figure\ref{fig:connectivity_split_all}. | |
208 | 204 | |
209 | 205 | \begin{figure}[!htb] |
210 | 206 | \centering | ... | ... |
docs/user_guide_en_source/cap_visual_simult.tex
1 | 1 | \chapter{Simultaneous viewing of images and surfaces} |
2 | 2 | |
3 | -The simultaneous viewing of images and surfaces can be activated clicking the \textbf{left} mouse button on the shortcut located in the lower right corner of the InVesalius screen. See figure~ \ref{fig:slice_plane_original}. | |
3 | +Images and surfaces can be viewed simultaneously by \textbf{left-clicking} on the shortcut (Figure~\ref{fig:slice_plane_original}) located in the lower right corner of the InVesalius interface. | |
4 | 4 | |
5 | 5 | \begin{figure}[!htb] |
6 | 6 | \centering |
... | ... | @@ -9,7 +9,7 @@ The simultaneous viewing of images and surfaces can be activated clicking the \t |
9 | 9 | \label{fig:slice_plane_original} |
10 | 10 | \end{figure} |
11 | 11 | |
12 | -This feature allows enable or disable the display of images in different orientations (or plans) within the same display window of the 3D surface. To do this, simply check or uncheck the corresponding option in the menu shown in figure~\ref{fig:view_2d_3d_1}. | |
12 | +This feature allows users to enable or disable the displaying of images in different orientations (or plans) within the same display window of the 3D surface. Simply check or uncheck the corresponding option in the menu shown in Figure~\ref{fig:view_2d_3d_1}. | |
13 | 13 | |
14 | 14 | \begin{figure}[!htb] |
15 | 15 | \centering |
... | ... | @@ -18,7 +18,7 @@ This feature allows enable or disable the display of images in different orienta |
18 | 18 | \label{fig:view_2d_3d_1} |
19 | 19 | \end{figure} |
20 | 20 | |
21 | -It is worth noting when the particular orientation is selected, a check is presented in the corresponding option. This is illustrated in figure~\ref{fig:view_2d_3d_2}. | |
21 | +It is worth noting that when a particular orientation is selected, a check is presented in the corresponding option. This is illustrated in Figure~\ref{fig:view_2d_3d_2}. | |
22 | 22 | |
23 | 23 | \begin{figure}[!htb] |
24 | 24 | \centering |
... | ... | @@ -29,7 +29,7 @@ It is worth noting when the particular orientation is selected, a check is prese |
29 | 29 | |
30 | 30 | \newpage |
31 | 31 | |
32 | -If the surface is already displayed, the plans of the guidelines will be presented as shown in figure~\ref{fig:only_2d_planes}. Otherwise, only the plans will be displayed | |
32 | +If the surface is already displayed, the plans of the guidelines will be presented as shown in Figure~\ref{fig:only_2d_planes}. Otherwise, only the plans will be displayed. | |
33 | 33 | |
34 | 34 | \begin{figure}[!htb] |
35 | 35 | \centering |
... | ... | @@ -47,4 +47,4 @@ If the surface is already displayed, the plans of the guidelines will be present |
47 | 47 | |
48 | 48 | \newpage |
49 | 49 | |
50 | -To view the display of a plan, just uncheck the corresponding option in the menu (figure~\ref{fig:view_2d_3d_2}) | |
51 | 50 | \ No newline at end of file |
51 | +To view the display of a plan, just uncheck the corresponding option in the menu (Figure~\ref{fig:view_2d_3d_2}). | |
52 | 52 | \ No newline at end of file | ... | ... |
docs/user_guide_en_source/cap_visual_vol.tex
1 | 1 | \chapter{Volume Rendering} |
2 | 2 | \label{cap:vis_vol} |
3 | 3 | |
4 | -For volume rendering models, InVesalius employs a technique known as raycasting. In summary, raycasting is it a technique to simulate the trace a beam of light toward the object for each screen pixel. The pixel color is based on the color and transparence of each voxel intercepted by the light beam. | |
4 | +For volume rendering models, InVesalius employs a technique known as raycasting. Raycasting is a technique that simulates the trace of a beam of light toward the object through each screen pixel. The pixel color is based on the color and transparency of each voxel intercepted by the light beam. | |
5 | 5 | |
6 | -InVesalius there are several pre-defined patterns (presets) to display specific tissue types or different types of exam (tomographic contrast, for example). | |
6 | +InVesalius contains several pre-defined patterns (presets) to display specific tissue types or different types of exam (tomographic contrast, for example). | |
7 | 7 | |
8 | -To access this feature, simply click the shortcut shown in figure~\ref{fig:volume_raycasting_origina} in the lower right corner of the screen (next to the display window surfaces) and select one of the available standards. | |
8 | +To access this feature, simply click the shortcut shown in Figure~\ref{fig:volume_raycasting_origina} in the lower right corner of the screen (next to the surfaces display window) and select one of the available presets. | |
9 | 9 | |
10 | -To turn off the volume rendering, click again on the path indicated by the figure~\ref{fig:volume_raycasting_origina} and select the \textbf{Disabled} option. | |
10 | +To turn off volume rendering, click again on the path indicated by Figure~\ref{fig:volume_raycasting_origina} and select the \textbf{Disable} option. | |
11 | 11 | |
12 | 12 | \begin{figure}[!htb] |
13 | 13 | \centering |
... | ... | @@ -18,7 +18,7 @@ To turn off the volume rendering, click again on the path indicated by the figur |
18 | 18 | |
19 | 19 | \section{Viewing Standards} |
20 | 20 | |
21 | -There are several predefined viewing patterns. Some examples are illustrated in the following figures. | |
21 | +There are several predefined viewing patterns. Some examples are illustrated in the following figures. | |
22 | 22 | |
23 | 23 | \begin{figure}[!htb] |
24 | 24 | \centering |
... | ... | @@ -52,7 +52,7 @@ There are several predefined viewing patterns. Some examples are illustrated in |
52 | 52 | |
53 | 53 | \section{Standard Customization} |
54 | 54 | |
55 | -Some patterns can be personalized (and customized). See figure~\ref{fig:customize_1}, which is exhibiting a pattern and some graphical controls adjustment. With these features, It is possible to change the color of a given structure and its opacity, determining if and how it will be displayed. | |
55 | +Some patterns can be personalized (and customized). Figure~\ref{fig:customize_1} is exhibiting a pattern and some graphical controls adjustment. With these features, the color of a given structure and its opacity can be altered, determining if and how it will be displayed. | |
56 | 56 | |
57 | 57 | \begin{figure}[!htb] |
58 | 58 | \centering |
... | ... | @@ -64,9 +64,9 @@ Some patterns can be personalized (and customized). See figure~\ref{fig:customiz |
64 | 64 | |
65 | 65 | \newpage |
66 | 66 | |
67 | -To hide a structure, you must use the control setting chart keeping low the opacity of the corresponding region. In the example in figure~\ref{fig:customize_1} for example, suppose you want to hide the muscular part, which appears in red. To do this, one can simply position the pointer over the point in red and using the left mouse button, drag the point down in order to reduce the opacity (which is equivalent to increasing transparency). Figure~\ref{fig:customize_2} illustrates the result. | |
67 | +To hide a structure, use the control setting chart to decrease the opacity of the corresponding region. In the example in Figure~\ref{fig:customize_1} suppose we want to hide the muscular part (appearing in red). To do this, simply position the pointer over the muscular part in red and, using the left mouse button, drag the point down to reduce opacity and make the part transparent. Figure~\ref{fig:customize_2} illustrates the result. | |
68 | 68 | |
69 | -Note: The Alpha value indicates the opacity of the color and the value Value, the color intensity of the pixel. | |
69 | +Note: The Alpha value indicates the opacity of the color and the \textbf{value}, the color intensity of the pixel. | |
70 | 70 | |
71 | 71 | \begin{figure}[!htb] |
72 | 72 | \centering |
... | ... | @@ -78,9 +78,7 @@ Note: The Alpha value indicates the opacity of the color and the value Value, th |
78 | 78 | |
79 | 79 | \newpage |
80 | 80 | |
81 | - | |
82 | -It can remove or add points on the graph control setting. For removing, simply click with the right mouse button on the point. For adding a new point, click the left button on the line | |
83 | -graph. One can also save the resulting pattern by clicking the shortcut. Figure~\ref{fig:save_preset} illustrates. | |
81 | +We can also remove or add points on the graph control setting. To remove, simply click with the right mouse button on the point. To add a new point, click the left button on the line graph. One can also save the resulting pattern by clicking the shortcut shown in Figure~\ref{fig:save_preset}. | |
84 | 82 | |
85 | 83 | \begin{figure}[!htb] |
86 | 84 | \centering |
... | ... | @@ -89,8 +87,7 @@ graph. One can also save the resulting pattern by clicking the shortcut. Figure |
89 | 87 | \label{fig:save_preset} |
90 | 88 | \end{figure} |
91 | 89 | |
92 | -To save the pattern, InVesalius displays a window like the one in figure~\ref{fig:save_window_preset}. | |
93 | -Enter a name for the custom pattern and \textbf{click OK} button. The saved pattern will be available with the other the next time the software is opened. | |
90 | +To save the pattern, InVesalius displays a window like the one shown in Figure~\ref{fig:save_window_preset}. Enter a name for the custom pattern and \textbf{click OK}. The saved pattern will be available for the next time the software is opened. | |
94 | 91 | |
95 | 92 | \begin{figure}[!htb] |
96 | 93 | \centering |
... | ... | @@ -101,7 +98,7 @@ Enter a name for the custom pattern and \textbf{click OK} button. The saved patt |
101 | 98 | |
102 | 99 | \section{Standard Customization with Brightness and Contrast} |
103 | 100 | |
104 | -You can customize a pattern without using the graphical control setting, which is presented in the previous section. This is done through the control \textbf{brightness and contrast} which is present in the toolbar. To activate the control, click the shortcut shown in figure~\ref{fig:tool_contrast_original_vol}. | |
101 | +You can customize a pattern without using the graphical control settings presented in the previous section. This is done through the \textbf{brightness and contrast} controls on the toolbar. Activate these by clicking the icon shown in Figure~\ref{fig:tool_contrast_original_vol}. | |
105 | 102 | |
106 | 103 | \begin{figure}[!htb] |
107 | 104 | \centering |
... | ... | @@ -110,9 +107,9 @@ You can customize a pattern without using the graphical control setting, which i |
110 | 107 | \label{fig:tool_contrast_original_vol} |
111 | 108 | \end{figure} |
112 | 109 | |
113 | -Enable the control by dragging the mouse, with the left button pressed on the volume window, this can change the values of the window width and window level. The procedure is the same as the slices applied to 2D, which can be seen in section~\ref{sec:ww_wl}. Dragging the mouse in the horizontal direction changes the window level value. To the left, it decreases its window value, and for the right, it increases its window value. Dragging the mouse in the vertical direction changes the value of window width. If dragged down, the value is diminished and, dragging upwards increases its value. | |
110 | +Enable the control by dragging the mouse, with the left button pressed on the volume window. This will change the values of the window width and window level. The procedure is the same as with slices applied to 2D images, which can be seen in section~\ref{sec:ww_wl}. Dragging the mouse in a horizontal direction changes the window level value; drag left to decrease and right to increase. Dragging the mouse vertically changes the value of window width; drag down to decrease and up to increase. | |
114 | 111 | |
115 | -Manipulating these values can be useful for different viewing results. For example, to add tissue to the display, \textbf{drag} the mouse diagonally with \textbf{left button} pressed from the lower right to the upper left corner of the preview window. To remove tissue visualization, do the opposite, (i.e \textbf{drag} the mouse diagonally from top left to bottom right with \textbf{left button} presseds.). See figure~\ref{fig:raycasting_add}. | |
112 | +Manipulating these values can be useful for different viewing results. For example, to add tissue to the display, \textbf{drag} the mouse diagonally with \textbf{left button} pressed from the lower right to the upper left corner of the preview window. To remove tissue visualization, do the opposite, (i.e drag the mouse diagonally from top left to bottom right with the left button pressed.). See Figure~\ref{fig:raycasting_add}. | |
116 | 113 | |
117 | 114 | \begin{figure}[!htb] |
118 | 115 | \centering |
... | ... | @@ -127,10 +124,9 @@ Manipulating these values can be useful for different viewing results. For examp |
127 | 124 | |
128 | 125 | \newpage |
129 | 126 | |
130 | - | |
131 | 127 | \section{Cut} |
132 | 128 | |
133 | -In volume rendering, the cut is used to view a region of the internal volume. InVesalius has a cut for tool for this based on a reference plane. With a volume pattern selected, click \textbf{Tools}, and then click \textbf{Cut plane} (figure~\ref{fig:activate_cut_plane}). | |
129 | +In volume rendering, the cut function is used to view a cross-section of a region. With a volume pattern selected, click \textbf{Tools}, and then click \textbf{Cut plane} (Figure~\ref{fig:activate_cut_plane}). | |
134 | 130 | |
135 | 131 | \begin{figure}[!htb] |
136 | 132 | \centering |
... | ... | @@ -139,7 +135,7 @@ In volume rendering, the cut is used to view a region of the internal volume. In |
139 | 135 | \label{fig:activate_cut_plane} |
140 | 136 | \end{figure} |
141 | 137 | |
142 | -A plan of representation for cutting appears next to the volume. To make the cut, hold the \textbf{left} mouse button on the plane and \textbf{drag} the mouse. To rotate the plan, hold the \textbf{left} mouse button pressed on its edge and move the mouse in the desired direction. See an example in figure~\ref{fig:cutted_image}. | |
138 | +An outline for cutting appears next to the volume. To make the cut, hold the left mouse button on the plane and drag the mouse. To rotate the plane, hold the left mouse button pressed on its edge and move the mouse in the desired direction as shown in Figure~\ref{fig:cutted_image}. | |
143 | 139 | |
144 | 140 | \begin{figure}[!htb] |
145 | 141 | \centering |
... | ... | @@ -148,4 +144,4 @@ A plan of representation for cutting appears next to the volume. To make the cut |
148 | 144 | \label{fig:cutted_image} |
149 | 145 | \end{figure} |
150 | 146 | |
151 | -To disable the cut feature, click \textbf{Tools} and then again \textbf{Cut plan} (figure~\ref{fig:cutted_image}). | |
152 | 147 | \ No newline at end of file |
148 | +When finished using the function, click \textbf{Tools} and again click \textbf{Cut plane} (Figure~\ref{fig:cutted_image}). | |
153 | 149 | \ No newline at end of file | ... | ... |
docs/user_guide_en_source/intro.tex
... | ... | @@ -61,7 +61,7 @@ The dental CT commonly works with less radiation emission compared to medical CT |
61 | 61 | \begin{figure}[!htb] |
62 | 62 | \centering |
63 | 63 | \includegraphics[scale=0.4]{feixe_conico.jpg} |
64 | -\caption{Detal tomography - www.kavo.com.br} | |
64 | +\caption{Dental tomography - www.kavo.com.br} | |
65 | 65 | \end{figure} |
66 | 66 | |
67 | 67 | Image acquisition is performed with the patient positioned vertically (as opposed to medical tomography in which the patient is horizontal). A transmitter X-ray surround the patient's skull, forming an arc of $180^\circ$ or $360^\circ$. The images generated are compiled as a volume of the patient's skull. This volume is then "sliced" by the software into individual layers, being able to generate images with different spacing or fields of view, such as a panoramic view of the region of interest. |
... | ... | @@ -114,7 +114,7 @@ It is important to note that, as a general rule, the greater the amount of RAM a |
114 | 114 | \begin{itemize} |
115 | 115 | \item 32-bit Operating System |
116 | 116 | \item Intel Pentium 4 or equivalent 1.5 GHz |
117 | - \item 1 GB RAM | |
117 | + \item 1 GB of RAM | |
118 | 118 | \item 10 GB available hard disk space |
119 | 119 | \item Graphics card with 64 MB memory |
120 | 120 | \item Video resolution of 1024x768 pixels |
... | ... | @@ -125,10 +125,10 @@ It is important to note that, as a general rule, the greater the amount of RAM a |
125 | 125 | \begin{itemize} |
126 | 126 | \item 64-bit Operating System |
127 | 127 | \item Intel Core 2 Duo processor or equivalent 2.5 GHz |
128 | - \item 4GB of RAM | |
128 | + \item 8 GB of RAM | |
129 | 129 | \item 20 GB available hard disk space |
130 | 130 | \item NVidia or ATI graphics card with 128 MB of memory |
131 | - \item Video resolution of 1024x768 pixels | |
131 | + \item Video resolution of 1920x1080 pixels | |
132 | 132 | \end{itemize} |
133 | 133 | |
134 | 134 | ... | ... |