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"><head>
   3 <!--
   4 # ---------------------------------------------------------------------
   5 #
   6 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   7 #                        pour la Sant�)
   8 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   9 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
  10 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
  11 #
  12 #  This software is governed by the CeCILL-B license under French law and
  13 #  abiding by the rules of distribution of free software. You can  use,
  14 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  15 #  license as circulated by CEA, CNRS and INRIA at the following URL
  16 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  17 #  or in the file LICENSE.txt.
  18 #
  19 #  As a counterpart to the access to the source code and  rights to copy,
  20 #  modify and redistribute granted by the license, users are provided only
  21 #  with a limited warranty  and the software's author,  the holder of the
  22 #  economic rights,  and the successive licensors  have only  limited
  23 #  liability.
  24 #
  25 #  The fact that you are presently reading this means that you have had
  26 #  knowledge of the CeCILL-B license and that you accept its terms.
  27 # ------------------------------------------------------------------------ */
  28
  29 -->
  30 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /><title>General Description</title>
  31
  32 <style type="text/css">
  33 .titles {
  34 font-family: Geneva, Arial, Helvetica, sans-serif;
  35 color: #000000;
  36 font-size: large;
  37 font-weight: bold;
  38 }
  39 .text {
  40 font-family: Geneva, Arial, Helvetica, sans-serif;
  41 font-size: small;
  42 font-weight: normal;
  43 }
  44 a.el {
  45 font-weight:bold;
  46 text-decoration:none;
  47 }
  48 a {
  49 color:#1A41A8;
  50 }
  51 .subtitles {
  52 font-family: Geneva, Arial, Helvetica, sans-serif;
  53 font-size: 90%;
  54 font-weight: bold;
  55 text-decoration: underline;
  56 }
  57 .listDiagrams {
  58 font-family: Geneva, Arial, Helvetica, sans-serif;
  59 margin-left: 25px;
  60 font-size: small;
  61 font-weight: bold;
  62 }
  63 .paragraph {
  64 margin-left: 40px;
  65 font-family: Geneva, Arial, Helvetica, sans-serif;
  66 font-size: small;
  67 }
  68 .style1 {
  69 text-decoration: underline;
  70 font-weight: bold;
  71 }
  72 .style3 {
  73 font-family: Geneva, Arial, Helvetica, sans-serif;
  74 font-size: 21px;
  75 text-decoration: underline;
  76 text-align: justify;
  77 }
  78 .style4 {
  79 font-family: Geneva, Arial, Helvetica, sans-serif;
  80 color: #000000;
  81 font-size: x-large;
  82 font-weight: bold;
  83 text-align: center;
  84 }
  85 </style></head>
  86 <body>
  87 <h2 style="text-align: left;" class="style4"><big>General
  88 Description</big></h2>
  89 <big><big><big><big><big><big><big><big><span class="text"><big><strong style="font-family: Helvetica,Arial,sans-serif;"><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong><span style="font-family: Helvetica,Arial,sans-serif;">
  90 is a C++ application developed by the </span><a style="font-family: Helvetica,Arial,sans-serif;" class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">CreaTools</a><span style="font-family: Helvetica,Arial,sans-serif;">
  91 software team. As such, it is contained within the&nbsp;CreaTools </span><a style="font-family: Helvetica,Arial,sans-serif;" class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">general
  92 architecture</a><span style="font-family: Helvetica,Arial,sans-serif;">. Its principal objective as a standalone
  93 application is to let the user create flexible</span><span style="font-family: Helvetica,Arial,sans-serif;">contour shapes over
  94 different kinds of images. The drawn contours can afterwards by used to
  95 extract statistical information out of these images.</span></big> </span></big></big></big></big></big></big></big></big><h2 style="text-align: justify;"><span class="text"><big>A gross approximation
  96 of&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
  97 general architectural
  98 distribution can be seen in this diagram. In short<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
  99 creaContours</a></strong> can be
 100 thought of as being divided in three parts, each one of which will be explained and detailed in this document.</big>&nbsp;</span></h2>
 101 <hr />
 102 <h2 style="text-align: left;" class="style4"><big>Table of Contents</big></h2><h4><big><big>Libraries</big></big></h4><h2><big><span class="text">T<big>he first three sections of this guide shall be dedicated to the three main&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong> libraries:</big></span></big></h2>
 103
 104 <ul><big><big>
 105 </big></big><li><big><big>
 106 </big></big><h2><big><big><span class="text"><big><a class="el" href="#Interface_Icons_NDimensions_lib">Interface_Icons_NDimensions_lib</a></big>.
 107 <big>The set of classes that represents&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
 108 menus and the buttons
 109 contained within.</big></span>&nbsp;<span class="text"></span></big></big></h2></li><li><h2><big><big><span class="text"><big><a class="el" href="#Interface_ManagerContour_NDimensions_lib">Interface_ManagerContour_NDimensions_lib</a></big>.
 110 <big>This is where are found the classes that define the functions
 111 associated to the creation and edition of the contours. It's also here
 112 where the main class, wxContourMainFrame, is defined.&nbsp;</big></span></big></big></h2></li><li><h2><big><big><span class="text"><big><a class="el" href="#kernel_ManagerContour_NDimensions_li">kernel_ManagerContour_NDimensions_lib</a></big>.
 113 <big>As its name suggests, this is the group of classes that constitute the
 114 kernel of the application. These are multiple-purpose classes that
 115 serve as building blocks for the rest of&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong></big></span></big></big></h2></li></ul><h4><big><big>Tutorials</big></big></h4><big><span class="text"><big><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>
 116 is continously evolving. Its development it's not yet finished and tha
 117 application sees new features being added to it on a regular basis. The
 118 tutorials give a rough idea of how to contribute to the development of
 119 certain aspects of the application.</big><br /></span></big><ul style="font-family: Helvetica,Arial,sans-serif;"><li><a href="#tutorials">How to add a new button</a>. Quick step-by-step guide on how to add&nbsp;to the application. a new button&nbsp;and its associated functionality.</li></ul>
 120 <ul>
 121 </ul>
 122 <hr />
 123 <h2 style="text-align: left;" class="style4"><big>Modules
 124 Description</big></h2>
 125 <p class="text"><big>In this section, each module of<span class="text"><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
 126 creaContours</a></strong></span> is fleshed out
 127 through class,&nbsp;sequence and component diagrams. The objective
 128 is to provide as much useful information about each component as it is
 129 possible.</big></p>
 130 <a name="Interface_Icons_NDimensions_lib"></a>
 131 <span class="text">
 132 <div class="style3"><big> Interface_Icons_NDimensions_lib</big></div>
 133 <ul>
 134 <li><big>Class diagram.</big></li>
 135 <li><big>Adding an additional button. <span style="font-family: Geneva,Arial,Helvetica,sans-serif;">Adding
 136 a new button to </span><span class="text"><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a><span style="font-weight: normal;">
 137 is an important part of its development. Therefore, a small how-to guide
 138 has been included in the documentation..</span></strong></span></big></li>
 139 </ul>
 140 <span class="text"></span><span style="font-weight: normal;" class="listDiagrams"></span>
 141 <br />
 142 <hr /><span class="subtitles"><a name="Interface_ManagerContour_NDimensions_lib"></a></span>
 143 <br />
 144 <div class="style3"><big>Interface_ManagerContour_NDimensions_lib</big></div>
 145 </span>
 146 <ul><big><span class="text"><li><big>Class</big> <big>diagram</big></li>
 147 </span>
 148 </big></ul>
 149 <span class="text">
 150 <hr /><a name="kernel_ManagerContour_NDimensions_li"></a>
 151 <div class="style3"><big>kernel_ManagerContour_NDimensions_lib</big></div>
 152 </span><ul><li><big><span class="text"><big>Class</big><small> </small><big>diagram</big></span></big></li></ul><span class="text">
 153 <hr /></span><h2 style="text-align: left;" class="style4"><a name="tutorials"></a><big>Tutorials</big></h2><ul><li><big>How to add a new button. In this tutorial is explained how to add new button to&nbsp;<span class="text"><span class="text"><strong><big><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></big><span style="font-weight: normal;"></span></strong></span></span><span class="text"><span class="text"><strong>. <big><span style="font-weight: normal;">For
 154 that purpose, a step-by-step detailed guide is presented alongside
 155 diagrams and images that aid the comprehension of the process.</span></big></strong></span></span></big></li></ul><h2></h2><h2><span class="text">
 156 </span></h2>
 157 </body></html>