lib/doxygen/DoxyMainPage.txt.in

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