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 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /><title>General Description</title>
   4
   5 <style type="text/css">
   6 .titles {
   7 font-family: Geneva, Arial, Helvetica, sans-serif;
   8 color: #000000;
   9 font-size: large;
  10 font-weight: bold;
  11 }
  12 .text {
  13 font-family: Geneva, Arial, Helvetica, sans-serif;
  14 font-size: small;
  15 font-weight: normal;
  16 }
  17 a.el {
  18 font-weight:bold;
  19 text-decoration:none;
  20 }
  21 a {
  22 color:#1A41A8;
  23 }
  24 .subtitles {
  25 font-family: Geneva, Arial, Helvetica, sans-serif;
  26 font-size: 90%;
  27 font-weight: bold;
  28 text-decoration: underline;
  29 }
  30 .listDiagrams {
  31 font-family: Geneva, Arial, Helvetica, sans-serif;
  32 margin-left: 25px;
  33 font-size: small;
  34 font-weight: bold;
  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 font-weight: bold;
  44 }
  45 .style3 {
  46 font-family: Geneva, Arial, Helvetica, sans-serif;
  47 font-size: 21px;
  48 text-decoration: underline;
  49 text-align: justify;
  50 }
  51 .style4 {
  52 font-family: Geneva, Arial, Helvetica, sans-serif;
  53 color: #000000;
  54 font-size: x-large;
  55 font-weight: bold;
  56 text-align: center;
  57 }
  58 </style></head>
  59 <body>
  60 <h2 style="text-align: left;" class="style4">General
  61 Description</h2>
  62 <h2 style="text-align: justify;"><span class="text"><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>
  63 is a C++ application developed by the <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">CreaTools</a>
  64 software team. As such, it is contained within the&nbsp;CreaTools <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaToolsArchitecture">general
  65 architecture</a>. Its principal objective as a standalone
  66 application is to let the user create flexible contour shapes over
  67 different kinds of images. The drawn contours can afterwards by used to
  68 extract statistical information out of these images.</span></h2><h2 style="text-align: justify;"><span class="text">A gross approximation
  69 of&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
  70 general architectural
  71 distribution can be seen in this diagram. In short<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
  72 creaContours</a></strong> can be
  73 thought of as being divided in three parts, each one of which will be explained and detailed in this document.&nbsp;</span></h2>
  74 <hr />
  75 <h2 style="text-align: left;" class="style4">Table of Contents</h2><h4>Libraries</h4><h2><span class="text">The 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:</span></h2>
  76
  77 <ul>
  78 <li>
  79 <h2><span class="text"><a class="el" href="#Interface_Icons_NDimensions_lib">Interface_Icons_NDimensions_lib</a>.
  80 The set of classes that represents&nbsp;<strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>'
  81 menus and the buttons
  82 contained within.</span>&nbsp;<span class="text"></span></h2></li><li><h2><span class="text"><a class="el" href="#Interface_ManagerContour_NDimensions_lib">Interface_ManagerContour_NDimensions_lib</a>.
  83 This is where are found the classes that define the functions
  84 associated to the creation and edition of the contours.</span></h2></li><li><h2><span class="text"><a class="el" href="#kernel_ManagerContour_NDimensions_li">kernel_ManagerContour_NDimensions_lib</a>.
  85 As its name suggests, this is the group of classes that constitute the
  86 kernel of the application. These are multiple-purpose classes that
  87 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></span></h2></li></ul><h4>Tutorials</h4><span class="text"><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a></strong>
  88 is continously evolving. Its development it's not yet finished and tha
  89 application sees new features being added to it on a regular basis. The
  90 tutorials give a rough idea of how to contribute to the development of
  91 certain aspects of the application.<br /></span><ul><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>
  92 <ul>
  93 </ul>
  94 <hr />
  95 <h2 style="text-align: left;" class="style4">Modules
  96 Description</h2>
  97 <p class="text">In this section, each module of<span class="text"><strong><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">
  98 creaContours</a></strong></span> is fleshed out
  99 through class,&nbsp;sequence and component diagrams. The objective
 100 is to provide as much useful information about each component as it is
 101 possible.</p>
 102 <a name="Interface_Icons_NDimensions_lib"></a>
 103 <span class="text">
 104 <div class="style3"> Interface_Icons_NDimensions_lib</div>
 105 <ul>
 106 <li>Class diagram.</li>
 107 <li>Adding an additional button. <span style="font-family: Geneva,Arial,Helvetica,sans-serif;">Adding
 108 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;">
 109 is an important part of its development. Therefore, a small how-to guide
 110 has been included in the documentation..</span></strong></span></li>
 111 </ul>
 112 <span class="text"></span><span style="font-weight: normal;" class="listDiagrams"></span>
 113 <br />
 114 <hr /><span class="subtitles"><a name="Interface_ManagerContour_NDimensions_lib"></a></span>
 115 <br />
 116 <div class="style3">Interface_ManagerContour_NDimensions_lib</div>
 117 </span>
 118 <ul><span class="text"><li>Class diagram</li>
 119 </span>
 120 </ul>
 121 <span class="text">
 122 <hr /><a name="kernel_ManagerContour_NDimensions_li"></a>
 123 <div class="style3">kernel_ManagerContour_NDimensions_lib</div>
 124 </span><ul><li><span class="text">Class diagram</span></li></ul><span class="text">
 125 <hr /></span><h2 style="text-align: left;" class="style4"><a name="tutorials"></a>Tutorials</h2><ul><li>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><a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsCreaContours">creaContours</a><span style="font-weight: normal;"></span></strong></span></span><span class="text"><span class="text"><strong>. <span style="font-weight: normal;">For
 126 that purpose, a step-by-step detailed guide is presented alongside
 127 diagrams and images that aid the comprehension of the process.</span></strong></span></span></li></ul><h2></h2><h2><span class="text">
 128 </span></h2>
 129 </body></html>