lib/doxygen/DoxyMainPage.txt.in

   1 /**
   2  * \mainpage creaContours documentation
   3
   4 \htmlonly
   5 <!--
   6 # ---------------------------------------------------------------------
   7 #
   8 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   9 #                        pour la Sant�)
  10 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
  11 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
  12 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
  13 #
  14 #  This software is governed by the CeCILL-B license under French law and
  15 #  abiding by the rules of distribution of free software. You can  use,
  16 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 #  license as circulated by CEA, CNRS and INRIA at the following URL
  18 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 #  or in the file LICENSE.txt.
  20 #
  21 #  As a counterpart to the access to the source code and  rights to copy,
  22 #  modify and redistribute granted by the license, users are provided only
  23 #  with a limited warranty  and the software's author,  the holder of the
  24 #  economic rights,  and the successive licensors  have only  limited
  25 #  liability.
  26 #
  27 #  The fact that you are presently reading this means that you have had
  28 #  knowledge of the CeCILL-B license and that you accept its terms.
  29 # ------------------------------------------------------------------------ */
  30
  31 -->
  32
  33 <!-- ******************************************************************************* -->
  34 <!-- Paste here the new code HTML for the main page of creaMaracasVisu documentation -->
  35 <!-- It is possible to use the file TemplateHomeLibDoxygen.html to edit easily -->
  36 <!-- but don't forget to delete head and body tags. RaC -->
  37 <!-- ******************************************************************************* -->
  38
  39   <meta content="text/html; charset=utf-8"
  40  http-equiv="Content-Type" />
  41   <title>General Description</title>
  42   <style type="text/css">
  43 .titles {
  44 font-family: Geneva, Arial, Helvetica, sans-serif;
  45 color: #000000;
  46 font-size: large;
  47 font-weight: bold;
  48 }
  49 .text {
  50 font-family: Geneva, Arial, Helvetica, sans-serif;
  51 font-size: small;
  52 font-weight: normal;
  53 }
  54 a.el {
  55 font-weight:bold;
  56 text-decoration:none;
  57 }
  58 a {
  59 color:#1A41A8;
  60 }
  61 .subtitles {
  62 font-family: Geneva, Arial, Helvetica, sans-serif;
  63 font-size: 90%;
  64 font-weight: bold;
  65 text-decoration: underline;
  66 }
  67 .listDiagrams {
  68 font-family: Geneva, Arial, Helvetica, sans-serif;
  69 margin-left: 25px;
  70 font-size: small;
  71 font-weight: bold;
  72 }
  73 .paragraph {
  74 margin-left: 40px;
  75 font-family: Geneva, Arial, Helvetica, sans-serif;
  76 font-size: small;
  77 }
  78 .style1 {
  79 text-decoration: underline;
  80 font-weight: bold;
  81 }
  82 .style3 {
  83 font-family: Geneva, Arial, Helvetica, sans-serif;
  84 font-size: 21px;
  85 text-decoration: underline;
  86 text-align: justify;
  87 }
  88 .style4 {
  89 font-family: Geneva, Arial, Helvetica, sans-serif;
  90 color: #000000;
  91 font-size: x-large;
  92 font-weight: bold;
  93 text-align: center;
  94 }
  95   </style>
  96 </head>
  97 <body>
  98 <h2 style="text-align: left;" class="style4">General
  99 Description</h2>
 100 <h2><span class="text"><strong><a class="el"
 101  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>
 102 is a C++ application developed by the <a class="el"
 103  href="http://www.creatis.insa-lyon.fr/site/fr/creatools">CreaTools</a>
 104 software team. As such, it is contained within the&nbsp;CreaTools <a
 105  class="el"
 106  href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">general
 107 architecture</a>. Its principal objective as a standalone
 108 application is to let the user create flexible contour shapes over
 109 different kinds of images. The drawn contours can afterwards by used to
 110 extract statistical information out of these images. </span></h2>
 111 <hr />
 112 <h2 style="text-align: left;" class="style4">Architecture
 113 Description</h2>
 114
 115 <h2>
 116   <span class="text">
 117     Here the <a class="el" href="../GeneralArchitecture_HTML/index.html">General Architecture</a>
 118   </span>
 119 </h2>
 120
 121
 122 <h2><span class="text">A gross approximation
 123 of&nbsp;<strong><a class="el"
 124  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
 125 general architectural
 126 distribution can be seen in this diagram. In short<strong><a
 127  class="el"
 128  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
 129 creaContours</a></strong> can be
 130 thought of as being divided in three parts<span
 131  style="font-weight: bold;"></span></span></h2>
 132 <ul>
 133   <li>
 134     <h2><span class="text"><a class="el"
 135  href="#Interface_Icons_NDimensions_lib">Interface_Icons_NDimensions_lib</a>.
 136 The set of classes that represents&nbsp;<strong><a
 137  class="el"
 138  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
 139 menus and the buttons
 140 contained within.</span>&nbsp;<span class="text"></span></h2>
 141   </li>
 142   <li>
 143     <h2><span class="text"><a class="el"
 144  href="#Interface_ManagerContour_NDimensions_lib">Interface_ManagerContour_NDimensions_lib</a>.
 145 This is where are found the classes that define the functions
 146 associated to the creation and edition of the contours. </span></h2>
 147   </li>
 148   <li>
 149     <h2><span class="text"><a class="el"
 150  href="#kernel_ManagerContour_NDimensions_li">kernel_ManagerContour_NDimensions_lib</a>.
 151 As its name suggests, this is the group of classes that constitute the
 152 kernel of the application. These are multiple-purpose classes that
 153 serve as building blocks for the rest of&nbsp;<strong><a
 154  class="el"
 155  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>.<br />
 156     </span></h2>
 157   </li>
 158 </ul>
 159 <ul>
 160 </ul>
 161 <hr />
 162 <h2 style="text-align: left;" class="style4">Modules
 163 Description</h2>
 164 <p class="text">In this section, each module of<span
 165  class="text"><strong><a class="el"
 166  href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
 167 creaContours</a></strong></span> is fleshed out
 168 through class,&nbsp;sequence and component diagrams. The objective
 169 is to provide as much useful information about each component as it is
 170 possible.</p>
 171 <a name="Interface_Icons_NDimensions_lib"></a>
 172 <div class="style3"> Interface_Icons_NDimensions_lib</div>
 173 <br />
 174 <span class="text"></span><span
 175  class="listDiagrams"></span>
 176 <br />
 177 <hr /><span class="subtitles"><a
 178  name="Interface_ManagerContour_NDimensions_lib"></a></span>
 179 <br />
 180 <div class="style3">Interface_ManagerContour_NDimensions_lib</div>
 181 <br />
 182 <hr /><a name="kernel_ManagerContour_NDimensions_li"></a>
 183 <div class="style3">kernel_ManagerContour_NDimensions_lib</div>
 184 <br />
 185 <hr /><span class="style3"></span><br />
 186 <span class="listDiagrams"></span><br />
 187
 188
 189 <!-- ******************************************************************************* -->
 190 <!--         End HTML Code         -->
 191 <!-- ******************************************************************************* -->
 192
 193 \endhtmlonly
 194
 195
 196  */