Analysis  version 7.0 - august 2014
DocMainPage.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file DocMainPage.hh
3  *
4  * Fichier principal de la documentation pour les bibliothèques
5  * d'analyse
6  */
7 //======================================================================
8 
9 
10 /*! \mainpage
11  *
12  * Descriptions des classes des bibliothèques pour les analyses
13  * basée sur ROOT, de données provenant de différents systèmes.
14  *
15  * Cette version des bibliothèques nécéssite:
16  * - l'installation de ROOT (versions de 5.22 à 5.34)
17  * - the general purpose library GCpp (version \gcpp_version)
18  * - the Root additional library package: GRootTools (version \groot_version)
19  *
20  *
21  * \par Description générale
22  *
23  * L'ensemble représente plusieurs couches de bibliothèques qui utilisent
24  * les fonctionnalités de ROOT.
25  *
26  * Une première couche de bibliothèques:
27  * - la bibliothèque générique (Event) définissant les classes de base;
28  * - une bibliothèques pour les interface graphiques correspondantes
29  * (GuiEvent).
30  *
31  * A cette couche principale viennentt s'ajouter les couches spécifiques
32  * selon le type de données à analyser.
33  * - la couche TreeRun (qui fait partie de la bibliothèque Event)
34  * pour traiter des données de fichiers TTree de ROOT;
35  * - la couche GanilRun pour des données de l'acquisition GANIL;
36  * - la couche SimulRun pour des données ne provenant d'aucun fichier
37  * d'entrée, ce qui peut être utile pour générer des simulations (qui fait partie
38  * de la bibliothèque Event);
39  * - pour chacune, la biblithèque d'interface graphique associée.
40  *
41  * Pour chacune des couches spécifiques, des classes d'analyse sont définies.
42  * Pour définir son analyse, l'utilisateur doit simplement créer une
43  * classe héritant d'une de ces classes de base
44  * (des scripts permettent de générer automatiquement les fichiers requis).
45  *
46  * Les principales classes d'analyse sont les suivantes (plus de détails
47  * sont donnés dans les documentations spécifiques):
48  * - EventManager (bibliothèque Event): classe de base qui gère les
49  * structures d'analyse;
50  * - RunBase et GEVRunBase : classes de base pour les classes d'analyses
51  * sans ou avec GUI, dont héritent les classes mentionnées ci-dessous;
52  * - TreeRun et GEVTreeRun : classes de base pour l'analyse des TTree/ROOT;
53  * - GanilRun et GuiGanilRun : classes de base pour l'analyse spécifique GANIL;
54  * - MidasRun et GuiMidasRun : classes de base pour l'analyse spécifique MIDAS;
55  * - SimulRun et GuiSimulRun : classes de base pour l'analyse sans données d'entrée.
56  *
57  * \ref analysis_compilation
58  *
59  * \ref analysis_configuration
60  *
61  *
62  * \par Descriptions détaillées par ensemble de bibliothèques
63  *
64  * - \ref event_description
65  * - \ref tree_run_analysis
66  * - \ref simul_run_analysis
67  * - \ref ganil_run_analysis
68  *
69  * \par Bibliothèques utilisées
70  *
71  * Voir les documentations des bibliothèques de base.
72  *
73  *
74  * \par Versions des bibliothèques
75  *
76  * - \ref analysis_release
77  * - \ref event_release
78  * - \ref ganil_run_release
79  *
80  *
81  * \ref analysis_bugs
82  *
83  */