lib/doxygen/TemplateHomeLibDoxygen.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3
   4 <head>
   5 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   6 <title>General Description</title>
   7 <style type="text/css">
   8 .titles {
   9         font-family: Geneva, Arial, Helvetica, sans-serif;
  10         color: #000000;
  11         font-size: large;
  12         font-weight: bold;
  13 }
  14 .text {
  15         font-family: Geneva, Arial, Helvetica, sans-serif;
  16         font-size: small;
  17         font-weight: normal;
  18 }
  19 a.el {
  20 font-weight:bold;
  21 text-decoration:none;
  22 }
  23 a {
  24 color:#1A41A8;
  25 }
  26 .subtitles {
  27         font-family: Geneva, Arial, Helvetica, sans-serif;
  28         font-size: 90%;
  29         font-weight: bold;
  30         text-decoration: underline;
  31 }
  32 .listDiagrams {
  33         font-family: Geneva, Arial, Helvetica, sans-serif;
  34         margin-left: 25px;
  35         font-size: small;
  36         font-weight: bold;
  37 }
  38 .paragraph {
  39         margin-left: 40px;
  40         font-family: Geneva, Arial, Helvetica, sans-serif;
  41         font-size: small;
  42 }
  43 .style1 {
  44         text-decoration: underline;
  45         font-weight: bold;
  46 }
  47 .style3 {
  48         font-family: Geneva, Arial, Helvetica, sans-serif;
  49         font-size: 21px;
  50         text-decoration: underline;
  51         text-align: justify;
  52 }
  53 .style4 {
  54         font-family: Geneva, Arial, Helvetica, sans-serif;
  55         color: #000000;
  56         font-size: x-large;
  57         font-weight: bold;
  58         text-align: center;
  59 }
  60 </style>
  61 </head>
  62
  63 <body>
  64
  65 <H2 class="style4">General Description</H2>
  66 <H2><span class="text">First of all, <strong>
  67 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by
  68 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a>
  69 software team and it follows the general architecture of Creatools architecture
  70 (more information in the
  71 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">Creatools Architecture</a> diagram.
  72 <strong>
  73 <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
  74 images and the interaction with them. </span></H2>
  75 <hr />
  76
  77 <H2 class="style4">&nbsp;Architecture Description</H2>
  78 <H2><span class="text">The core of the library is divided into
  79 different modules, and each one provides a list of diferent functionalities that can be
  80 used in specific contexts. The principal components are the following:<br />
  81 <br />
  82 - <a class="el" href="#ViewersInteractors">Viewers and interactors</a><br />
  83 - <a class="el" href="#Contours">Contours</a><br />
  84 - <a class="el" href="#Cutter">Cutter Module</a><br />
  85 - <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
  86
  87 <br />
  88 The relationship among this set of elements is described in the following
  89 diagram :<br />
  90 <br />
  91 &nbsp;&nbsp;&nbsp;&nbsp; -
  92 <a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
  93 <hr />
  94
  95 <H2 class="style4">&nbsp;Modules Description</H2>
  96 <p class="text">In this section are presented the corresponding diagrams for
  97 each model in <span class="text"> <strong>
  98 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
  99 library including classes, components and sequence diagrams, as well as a short
 100 description of the module of interest.</p>
 101
 102
 103
 104 <a name="ViewersInteractors"></a>
 105 <div class="style3">
 106         <br />
 107                 Viewers and interactors</div>
 108 <br />
 109 <span class="text">This module provides a set of classes that manage the
 110 visualization and the interaction with images. For example, the black box
 111 ViewerNV is constructed using these classes and it provides the possibility to
 112 use different viewers depending of the context. For example, to manage an image
 113 3D is useful to use the wxVtk3DBaseBiew and to control a 2D image it is possible
 114 to use wxVtk2DBaseView. It is important to note that these viewers make the
 115 connection between a wxWindow and a vtkRenderWindow, in order to include the
 116 world VTK in any application implemented with wxWidgets.<br />
 117 <br />
 118 Another important point to keep in mind is that all the wxVtkBaseView instances
 119 have a manager of its interactor styles. These interactors describe how the
 120 events are handled and how the actual mechanism respond to the interaction
 121 callbacks. Every new instance of InteractorStyleMaracas class can be added to
 122 the wxBaseView in order to manage all the events made over an object. An example
 123 of this process is presented in the contours section.</span><br />
 124 <br />
 125 <span class="listDiagrams">Class diagrams</span><br />
 126 <br />
 127 <span class="listDiagrams">&nbsp;&nbsp;
 128 <a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
 129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 130 <a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
 131 &nbsp;<br>
 132
 133 <hr /><span class="subtitles"><a name="Contours"></a></span>
 134 <span class="style3">Contours</span><br />
 135 <br />
 136 <span class="text">This module provides a set of tools to draw different types
 137 of contours over the viewers of the first section. In the MVC class diagram and
 138 the sequence diagram to create a new contour are explained the steps necessary
 139 to include this functionnality into a wx-vtk scene. An example of this process
 140 of creation of new contours is presented in the creaContours application. It is
 141 important to note that the contours follow as well the same interaction system
 142 of the wxVtkBaseView. It means that all the contour&#39;s controllers use the
 143 InteractorStyleMaracas system to manage the events of the mouse and the
 144 keyborard in the scene. In addition, every contour controller registered in the
 145 wxVtkBaseView with the method AddInteractorStyleMaracas of
 146 vtkInteractorStyleBaseView class (see the doxygen documentation of these
 147 classes) will react to the mouse and keyboard events, and for this reason is
 148 important to have a managing system of all the interactors in the scene.<br />
 149 <br />
 150 Regarding the different actions that can be made using the contours, they react
 151 in a different way depending of the actual state of each one of them. For
 152 example, when any contour is into an editable state, the control points are
 153 visualized and can be moved, removed, etc. In brief, the actions applied to the
 154 contours (check the <span class="text"> <strong>
 155 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaMaracasVisuUserGuide#Contours">User Guide</a> </strong> </span>
 156  documentation) are described as a state diagram and every contours reacts
 157 depending of its state.</span><br />
 158 <br />
 159 <span class="listDiagrams">Class diagrams<br />
 160 <br />
 161 </strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 162         -
 163 <a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controller)</a> <br>
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controller</a><br />
 167 </div>
 168 <br />
 169 <span class="listDiagrams">Sequence diagrams</span><br />
 170 <br />
 171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 172         -
 173 <a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new
 174         contour MVC</a>
 175 <div class="paragraph">
 176 When a new
 177         contour has to be created it is necessary to instantiate the MVC
 178         model shown in the section before. It is important to note that Contours
 179         module needs a viewer to draw and to manage the contour. For that reason,
 180         after creating the model, view and controller and their relations
 181         (Controller uses View and Model, and View has relation with the model), it
 182         is necessary to say the viewer where it will be managed. The specific
 183         methods to do this task are in the diagram.</div><br />
 184 <hr /><span class="style3"><a name="Cutter"></a>Cutter</span><br>
 185
 186 <br />
 187 <span class="listDiagrams">Component diagrams<br />
 188 <br />
 189 </strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 190         -
 191 <a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module
 192         components </a>
 193 </div>
 194
 195 <br />
 196 <span class="listDiagrams">Class diagrams<br />
 197 <br />
 198 </span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -
 199         <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module
 200         integration </a> <br>
 201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">-
 202         Interface</a> <br>
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">-
 204         Kernel</a></div>
 205 <br />
 206 <hr /><span class="style3"><a name="Plotter"></a>Plotter and data representation</span><br>
 207
 208 <br />
 209
 210 <span class="listDiagrams">Class diagrams</span><br class="style1" />
 211 <br />
 212 <div class="text">
 213 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
 214 </div>
 215
 216 </body>
 217
 218 </html>