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 }
  37 .paragraph {
  38         margin-left: 40px;
  39         font-family: Geneva, Arial, Helvetica, sans-serif;
  40         font-size: small;
  41 }
  42 .style1 {
  43         text-decoration: underline;
  44 }
  45 </style>
  46 </head>
  47
  48 <body>
  49
  50 <H2 class="titles">General Description</H2>
  51 <H2><span class="text">First of all, <strong>
  52 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by
  53 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a>
  54 software team and it follows the general architecture of Creatools architecture
  55 (more information in the
  56 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">Creatools Architecture</a> diagram.
  57 <strong>
  58 <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
  59 images and the interaction with them. </span></H2>
  60 <hr />
  61
  62 <H2 class="titles">&nbsp;Architecture Description</H2>
  63 <H2><span class="text">The core of the library is divided into
  64 different modules, and each one provides a list of diferent functionalities that can be
  65 used in specific contexts. The principal components are the following:<br />
  66 <br />
  67 - <a class="el" href="#ViewersInteractors">Viewers and interactors</a><br />
  68 - <a class="el" href="#Contours">Contours</a><br />
  69 - <a class="el" href="#Cutter">Cutter Module</a><br />
  70 - <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
  71
  72 <br />
  73 The relationship among this set of elements is described in the following
  74 diagram :<br />
  75 <br />
  76 &nbsp;&nbsp;&nbsp;&nbsp; -
  77 <a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
  78 <hr />
  79
  80 <H2 class="titles">&nbsp;Modules Description</H2>
  81 <p class="text">In this section are presented the corresponding diagrams for
  82 each model in <span class="text"> <strong>
  83 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
  84 library including classes, components and sequence diagrams, as well as a short
  85 description of the module of interest.</p>
  86 <span class="subtitles"><a name="ViewersInteractors"></a>Viewers and interactors</span><br />
  87 <br />
  88 &nbsp;<span class="listDiagrams"><strong><span class="style1">Class diagrams</span><br />
  89 <br />
  90 </strong></span><br />
  91 <span class="listDiagrams">&nbsp;&nbsp;
  92 <a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
  93 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  94 <a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
  95 &nbsp;<br>
  96 <hr /><span class="subtitles"><a name="Contours"></a>Contours<br />
  97 <br />
  98 <strong>
  99 <span class="listDiagrams">Class diagrams<br />
 100 <br />
 101 </span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 102         -
 103 <a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controler)</a> <br>
 104 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
 105 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
 106 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controler</a><br />
 107         <br />
 108 </div><span class="subtitles">
 109 <strong>
 110 <span class="listDiagrams">Sequence diagrams<br />
 111 <br />
 112 </span></strong></span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 113         -
 114 <a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new
 115         contour MVC</a>
 116 <div class="paragraph">
 117 When a new
 118         contour has to be created it is necessary to instantiate the MVC
 119         model shown in the section before. It is important to note that Contours
 120         module needs a viewer to draw and to manage the contour. For that reason,
 121         after creating the model, view and controller and their relations
 122         (Controller uses View and Model, and View has relation with the model), it
 123         is necessary to say the viewer where it will be managed. The specific
 124         methods to do this task are in the diagram.</div><br />
 125 <hr /><span class="subtitles"><a name="Cutter"></a>Cutter</span><br>
 126 <span class="subtitles">
 127 <br />
 128 <strong>
 129 <span class="listDiagrams">Component diagrams<br />
 130 <br />
 131 </span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 132         -
 133 <a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module
 134         components </a>
 135 </div>
 136 <span class="subtitles">
 137 <br />
 138 <strong>
 139 <span class="listDiagrams">Class diagrams<br />
 140 <br />
 141 </span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -
 142         <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module
 143         integration </a> <br>
 144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">-
 145         Interface</a> <br>
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">-
 147         Kernel</a></div>
 148 <br />
 149 <hr /><span class="subtitles"><a name="Plotter"></a>Plotter and data representation</span><br>
 150
 151 <br />
 152 <strong>
 153 <span class="listDiagrams"><span class="style1">Class diagrams</span><br class="style1" />
 154 </span></strong><span class="style1"></span></span><br />
 155 <br />
 156 <div class="text">
 157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
 158 </div>
 159
 160 </body>
 161
 162 </html>