2 * \mainpage creaMaracasVisu documentation
6 <!-- ******************************************************************************* -->
7 <!-- Paste here the new code HTML for the main page of creaMaracasVisu documentation -->
8 <!-- It is possible to use the file TemplateHomeLibDoxygen.html to edit easily -->
9 <!-- but don't forget to delete head and body open tags. RaC -->
10 <!-- ******************************************************************************* -->
13 <style type="text/css">
15 font-family: Geneva, Arial, Helvetica, sans-serif;
21 font-family: Geneva, Arial, Helvetica, sans-serif;
33 font-family: Geneva, Arial, Helvetica, sans-serif;
36 text-decoration: underline;
39 font-family: Geneva, Arial, Helvetica, sans-serif;
46 font-family: Geneva, Arial, Helvetica, sans-serif;
50 text-decoration: underline;
54 font-family: Geneva, Arial, Helvetica, sans-serif;
56 text-decoration: underline;
60 font-family: Geneva, Arial, Helvetica, sans-serif;
69 <H2 class="style4">General Description</H2>
70 <H2><span class="text">First of all, <strong>
71 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by
72 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a>
73 software team and it follows the general architecture of Creatools architecture
74 (more information in the
75 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">Creatools Architecture</a> diagram.
77 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> has as principal objective to help the visualization of medical
78 images and the interaction with them. </span></H2>
81 <H2 class="style4"> Architecture Description</H2>
82 <H2><span class="text">The core of the library is divided into
83 different modules, and each one provides a list of diferent functionalities that can be
84 used in specific contexts. The principal components are the following:<br />
86 - <a class="el" href="#ViewersInteractors">Viewers and interactors</a><br />
87 - <a class="el" href="#Contours">Contours</a><br />
88 - <a class="el" href="#Cutter">Cutter Module</a><br />
89 - <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
90 - <a class="el" href="#ManualPaint">Manual Paint</a><br />
91 - <a class="el" href="#ThresholdImageView">Threshold Image View</a><br />
94 The relationship among this set of elements is described in the following
97 -
98 <a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
101 <H2 class="style4"> Modules Description</H2>
102 <p class="text">In this section are presented the corresponding diagrams for
103 each model in <span class="text"> <strong>
104 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
105 library including classes, components and sequence diagrams, as well as a short
106 description of the module of interest.</p>
110 <a name="ViewersInteractors"></a>
113 Viewers and interactors</div>
115 <span class="text">This module provides a set of classes that manage the
116 visualization and the interaction with images. For example, the black box
117 ViewerNV is constructed using these classes and it provides the possibility to
118 use different viewers depending of the context. For example, to manage an image
119 3D is useful to use the wxVtk3DBaseBiew and to control a 2D image it is possible
120 to use wxVtk2DBaseView. It is important to note that these viewers make the
121 connection between a wxWindow and a vtkRenderWindow, in order to include the
122 world VTK in any application implemented with wxWidgets.<br />
124 Another important point to keep in mind is that all the wxVtkBaseView instances
125 have a manager of its interactor styles. These interactors describe how the
126 events are handled and how the actual mechanism respond to the interaction
127 callbacks. Every new instance of InteractorStyleMaracas class can be added to
128 the wxBaseView in order to manage all the events made over an object. An example
129 of this process is presented in the contours section.</span><br />
131 <span class="listDiagrams">Class diagrams</span><br />
133 <span class="listDiagrams">
134 <a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
135
136 <a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
139 <hr /><span class="subtitles"><a name="Contours"></a></span>
140 <span class="style3">Contours</span><br />
142 <span class="text">This module provides a set of tools to draw different types
143 of contours over the viewers of the first section. In the MVC class diagram and
144 the sequence diagram to create a new contour are explained the steps necessary
145 to include this functionnality into a wx-vtk scene. An example of this process
146 of creation of new contours is presented in the creaContours application. It is
147 important to note that the contours follow as well the same interaction system
148 of the wxVtkBaseView. It means that all the contour's controllers use the
149 InteractorStyleMaracas system to manage the events of the mouse and the
150 keyborard in the scene. In addition, every contour controller registered in the
151 wxVtkBaseView with the method AddInteractorStyleMaracas of
152 vtkInteractorStyleBaseView class (see the doxygen documentation of these
153 classes) will react to the mouse and keyboard events, and for this reason is
154 important to have a managing system of all the interactors in the scene.<br />
156 Regarding the different actions that can be made using the contours, they react
157 in a different way depending of the actual state of each one of them. For
158 example, when any contour is into an editable state, the control points are
159 visualized and can be moved, removed, etc. In brief, the actions applied to the
160 contours (check the <span class="text"> <strong>
161 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaMaracasVisuUserGuide#Contours">User Guide</a> </strong> </span>
162 documentation) are described as a state diagram and every contours reacts
163 depending of its state.</span><br />
165 <span class="listDiagrams">Class diagrams<br />
167 </strong></span><div class="text">
169 <a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controller)</a> <br>
170 <a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
171 <a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
172 <a href="../manualContour_Controler_HTML/index.html" class="el">- Controller</a><br />
175 <span class="listDiagrams">Sequence diagrams</span><br />
177
179 <a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new
181 <div class="paragraph">
183 contour has to be created it is necessary to instantiate the MVC
184 model shown in the section before. It is important to note that Contours
185 module needs a viewer to draw and to manage the contour. For that reason,
186 after creating the model, view and controller and their relations
187 (Controller uses View and Model, and View has relation with the model), it
188 is necessary to say the viewer where it will be managed. The specific
189 methods to do this task are in the diagram.</div><br />
190 <hr /><span class="style3"><a name="Cutter"></a>Cutter</span><br>
193 <span class="listDiagrams">Component diagrams<br />
195 </strong></span><div class="text">
197 <a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module
202 <span class="listDiagrams">Class diagrams<br />
204 </span><div class="text"> -
205 <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module
206 integration </a> <br>
207 <a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">-
209 <a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">-
215 <hr /><span class="style3"><a name="Plotter"></a>Plotter and data representation</span><br>
217 <span class="listDiagrams">Class diagrams</span><br class="style1" />
220 <a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
224 <hr /><span class="style3"><a name="ManualPaint"></a>Manual Paint</span><br>
226 <span class="listDiagrams">Class diagrams</span><br class="style1" />
229 <a href="../ManualPaint_html/index.html" class="el">- Manual Paint Class Diagram</a> <br>
232 <hr /><span class="style3"><a name="ThresholdImageView"></a>Threshold Image View</span><br>
234 <span class="listDiagrams">Class diagrams</span><br class="style1" />
237 <a href="../ThresholdImageView_html/index.html" class="el">- Threshold Image View Class Diagram</a> <br>
241 <!-- ******************************************************************************* -->
242 <!-- End HTML Code -->
243 <!-- ******************************************************************************* -->