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 tags. RaC -->
10 <!-- ******************************************************************************* -->
12 <style type="text/css">
14 font-family: Geneva, Arial, Helvetica, sans-serif;
20 font-family: Geneva, Arial, Helvetica, sans-serif;
32 font-family: Geneva, Arial, Helvetica, sans-serif;
35 text-decoration: underline;
38 font-family: Geneva, Arial, Helvetica, sans-serif;
45 font-family: Geneva, Arial, Helvetica, sans-serif;
49 text-decoration: underline;
53 font-family: Geneva, Arial, Helvetica, sans-serif;
55 text-decoration: underline;
59 font-family: Geneva, Arial, Helvetica, sans-serif;
70 <H2 class="style4">General Description</H2>
71 <H2><span class="text">First of all, <strong>
72 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by
73 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a>
74 software team and it follows the general architecture of Creatools architecture
75 (more information in the
76 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">Creatools Architecture</a> diagram.
78 <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
79 images and the interaction with them. </span></H2>
82 <H2 class="style4"> Architecture Description</H2>
83 <H2><span class="text">The core of the library is divided into
84 different modules, and each one provides a list of diferent functionalities that can be
85 used in specific contexts. The principal components are the following:<br />
87 - <a class="el" href="#ViewersInteractors">Viewers and interactors</a><br />
88 - <a class="el" href="#Contours">Contours</a><br />
89 - <a class="el" href="#Cutter">Cutter Module</a><br />
90 - <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
93 The relationship among this set of elements is described in the following
96 -
97 <a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
100 <H2 class="style4"> Modules Description</H2>
101 <p class="text">In this section are presented the corresponding diagrams for
102 each model in <span class="text"> <strong>
103 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
104 library including classes, components and sequence diagrams, as well as a short
105 description of the module of interest.</p>
109 <a name="ViewersInteractors"></a>
112 Viewers and interactors</div>
114 <span class="text">This module provides a set of classes that manage the
115 visualization and the interaction with images. For example, the black box
116 ViewerNV is constructed using these classes and it provides the possibility to
117 use different viewers depending of the context. For example, to manage an image
118 3D is useful to use the wxVtk3DBaseBiew and to control a 2D image it is possible
119 to use wxVtk2DBaseView. It is important to note that these viewers make the
120 connection between a wxWindow and a vtkRenderWindow, in order to include the
121 world VTK in any application implemented with wxWidgets.<br />
123 Another important point to keep in mind is that all the wxVtkBaseView instances
124 have a manager of its interactor styles. These interactors describe how the
125 events are handled and how the actual mechanism respond to the interaction
126 callbacks. Every new instance of InteractorStyleMaracas class can be added to
127 the wxBaseView in order to manage all the events made over an object. An example
128 of this process is presented in the contours section.</span><br />
130 <span class="listDiagrams">Class diagrams</span><br />
132 <span class="listDiagrams">
133 <a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
134
135 <a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
138 <hr /><span class="subtitles"><a name="Contours"></a></span>
139 <span class="style3">Contours</span><br />
142 <span class="listDiagrams">Class diagrams<br />
144 </strong></span><div class="text">
146 <a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controler)</a> <br>
147 <a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
148 <a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
149 <a href="../manualContour_Controler_HTML/index.html" class="el">- Controler</a><br />
153 <span class="listDiagrams">Sequence diagrams</span><br />
155
157 <a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new
159 <div class="paragraph">
161 contour has to be created it is necessary to instantiate the MVC
162 model shown in the section before. It is important to note that Contours
163 module needs a viewer to draw and to manage the contour. For that reason,
164 after creating the model, view and controller and their relations
165 (Controller uses View and Model, and View has relation with the model), it
166 is necessary to say the viewer where it will be managed. The specific
167 methods to do this task are in the diagram.</div><br />
168 <hr /><span class="style3"><a name="Cutter"></a>Cutter</span><br>
171 <span class="listDiagrams">Component diagrams<br />
173 </strong></span><div class="text">
175 <a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module
180 <span class="listDiagrams">Class diagrams<br />
182 </span><div class="text"> -
183 <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module
184 integration </a> <br>
185 <a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">-
187 <a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">-
190 <hr /><span class="style3"><a name="Plotter"></a>Plotter and data representation</span><br>
194 <span class="listDiagrams">Class diagrams</span><br class="style1" />
197 <a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
201 <!-- ******************************************************************************* -->
202 <!-- End HTML Code -->
203 <!-- ******************************************************************************* -->