General Description

X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2Fdoxygen%2FTemplateHomeLibDoxygen.html;h=1af4abdcab0c4043a87133ab591ae1a1d8d49acc;hb=refs%2Fheads%2Fvtk7itk4;hp=7ae82580f8093d0987b06aeb026b9b3e9599feff;hpb=4a87c22cc8be50b2154cb7772ad38cd4cec274df;p=creaContours.git diff --git a/lib/doxygen/TemplateHomeLibDoxygen.html b/lib/doxygen/TemplateHomeLibDoxygen.html index 7ae8258..1af4abd 100644 --- a/lib/doxygen/TemplateHomeLibDoxygen.html +++ b/lib/doxygen/TemplateHomeLibDoxygen.html @@ -1,5 +1,32 @@ + General Description -

General -Description

creaContours -is a C++ application developed by the CreaTools -software team. As such, it is contained within the CreaTools general -architecture. Its principal objective as a standalone -application is to let the user create flexible contour shapes over +
General +Description
+creaContours +is a C++ application developed by the CreaTools +software team. As such, it is contained within the CreaTools general +architecture. Its principal objective as a standalone +application is to let the user create flexiblecontour shapes over different kinds of images. The drawn contours can afterwards by used to -extract statistical information out of these images.

A gross approximation +extract statistical information out of these images.

A gross approximation of creaContours' general architectural distribution can be seen in this diagram. In short creaContours can be -thought of as being divided in three parts, each one of which will be explained and detailed in this document.

+thought of as being divided in three parts, each one of which will be explained and detailed in this document.

Libraries

The first three sections of this guide shall be dedicated to the three main creaContours libraries:

Libraries

The first three sections of this guide shall be dedicated to the three main creaContours libraries:

-
Interface_Icons_NDimensions_lib. -The set of classes that represents creaContours' +
- +
  Interface_Icons_NDimensions_lib. +The set of classes that represents creaContours' menus and the buttons -contained within.
- Interface_ManagerContour_NDimensions_lib. -This is where are found the classes that define the functions -associated to the creation and edition of the contours.
- kernel_ManagerContour_NDimensions_lib. -As its name suggests, this is the group of classes that constitute the +contained within.
- Interface_ManagerContour_NDimensions_lib. +This is where are found the classes that define the functions +associated to the creation and edition of the contours. It's also here +where the main class, wxContourMainFrame, is defined.
- kernel_ManagerContour_NDimensions_lib. +As its name suggests, this is the group of classes that constitute the kernel of the application. These are multiple-purpose classes that -serve as building blocks for the rest of creaContours
Tutorials
creaContours +serve as building blocks for the rest of creaContours

Tutorials

creaContours is continously evolving. Its development it's not yet finished and tha application sees new features being added to it on a regular basis. The tutorials give a rough idea of how to contribute to the development of -certain aspects of the application.

How to add a new button. Quick step-by-step guide on how to add to the application. a new button and its associated functionality.

+certain aspects of the application.

How to add a new button. Quick step-by-step guide on how to add to the application. a new button and its associated functionality.

Modules -Description

In this section, each module of +

Modules +Description

+
In this section, each module of creaContours is fleshed out through class, sequence and component diagrams. The objective is to provide as much useful information about each component as it is -possible.
+possible.
-
Interface_Icons_NDimensions_lib
+
Interface_Icons_NDimensions_lib

-
Class diagram.
-
Adding an additional button. Adding +
Class diagram.
+
Adding an additional button. Adding a new button to creaContours is an important part of its development. Therefore, a small how-to guide -has been included in the documentation..
+has been included in the documentation..

Interface_ManagerContour_NDimensions_lib

Class diagram

kernel_ManagerContour_NDimensions_lib

Class diagram

Tutorials

How to add a new button. In this tutorial is explained how to add new button to creaContours
. For +
kernel_ManagerContour_NDimensions_lib
+
Class diagram
+
Tutorials
How to add a new button. In this tutorial is explained how to add new button to creaContours. For that purpose, a step-by-step detailed guide is presented alongside -diagrams and images that aid the comprehension of the process.
+diagrams and images that aid the comprehension of the process.

\ No newline at end of file