Analysis  version 7.0 - august 2014
DocGanilRun.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file DocGanilRun.hh
3  *
4  * Fichier de documentation des classes d'analyse GanilRun et GuiGanilRun.
5  *
6  */
7 //======================================================================
8 
9 
10 /*! \page ganil_run_analysis Analyses spécifiques des données de l'acquisition GANIL
11  *
12  * \par Classes d'analyse spécifiques
13  *
14  * Pour l'analyse des données de fichiers de l'acquisition GANIL, les classes
15  * GanilRun (analyse de base, héritant de RunBase) et GuiGanilRun
16  * (analyse avec interface graphique, héritant de GEVRunBase)
17  * sont définies.
18  *
19  * Elle spécifient les fonctions de traitement spécifique des fichiers GANIL:
20  * ouverture, fermeture, lecture des en-têtes, lecture des événements...
21  *
22  * La classe GanilRun définit des fonctions spécifiques pour afficher le
23  * contenu des buffers d'en-tête et de fin.
24  *
25  * Des nouvelles fonctions utilisateurs sont définies (en plus de celles de
26  * la classe de base RunBase):
27  * - \b UserScaler() : fonction appelée lorsqu'un buffer d'échelles est
28  * lu (la classe définit aussi des fonction pour accéder au contenu des
29  * échelles)
30  * - \b UserBuffer() : fonction appelée chaque fois qu'un buffer est lu
31  * (après les buffers d'en-tête de fichier); cette fonction a surtout
32  * vocation à tester le contenu des buffers.
33  *
34  * L'interface graphique de base est complétée dans la classe GuiGanilRun
35  * par l'affichage du nombre de buffers lus et du numéro de run
36  * contenu dans le fichier.
37  *
38  * Un programme d'analyse prêt à l'emploi est inclus: \b GanilRun, basé * sur l'interface graphique. * Il permet d'analyser les données brutes des fichiers d'entrée * (pas de paramètres calculés), et de faire tous les traitements * possibles par l'interface graphique. * * * \par Configuration pour l'utilisation des bibliothèques * * Le fichier de configuration \b ganil_run_config.csh (dans le répertoire * \b scripts) définit les variables d'environnement et les alias pour * l'utilisation des bibliothèques. * * Il doit être appelé dans le fichier de configuration du shell (\b .cshrc): * - soit par le script général de l'ensemble des bibliothèques d'analyse * - soit directement (nécessite également la configuration pour les * bibliothèques additionnelles pour ROOT et pour les bibliothèques * Event) * * * \par Définition d'une classe d'analyse utilisateur * * Le script shell (\b tcsh) ganil_run.csh (dans le répertoire \b scripts) * permet de générer automatiquement les fichiers utilisateur pour une * nouvelle analyse. * Un alias est défini: \b ganil_run. * * Pour voir les options du script: \verbatim $ ganil_run -help \endverbatim * * Pour générer les fichiers (squelette) d'une nouvelle analyse (avec * interface graphique si l'option \b -gui est spécifiée, il suffit * d'exécuter dans le shell, dans le répertoire où le programme doit * être installé : \verbatim $ ganil_run -gui \endverbatim * * Les fichiers créés sont: * - les fichiers .hh (header) et .cpp (code C++) de la classe d'analyse * utilisateur * - un fichier .cpp avec un programme principal type * - un script de compilation (makefile) * * Les codes C++ sont prêts à être modifiés pour inclure les analyses * souhaitées ! * */
39  * sur l'interface graphique.
40  * Il permet d'analyser les données brutes des fichiers d'entrée * (pas de paramètres calculés), et de faire tous les traitements * possibles par l'interface graphique. * * * \par Configuration pour l'utilisation des bibliothèques * * Le fichier de configuration \b ganil_run_config.csh (dans le répertoire * \b scripts) définit les variables d'environnement et les alias pour * l'utilisation des bibliothèques. * * Il doit être appelé dans le fichier de configuration du shell (\b .cshrc): * - soit par le script général de l'ensemble des bibliothèques d'analyse * - soit directement (nécessite également la configuration pour les * bibliothèques additionnelles pour ROOT et pour les bibliothèques * Event) * * * \par Définition d'une classe d'analyse utilisateur * * Le script shell (\b tcsh) ganil_run.csh (dans le répertoire \b scripts) * permet de générer automatiquement les fichiers utilisateur pour une * nouvelle analyse. * Un alias est défini: \b ganil_run. * * Pour voir les options du script: \verbatim $ ganil_run -help \endverbatim * * Pour générer les fichiers (squelette) d'une nouvelle analyse (avec * interface graphique si l'option \b -gui est spécifiée, il suffit * d'exécuter dans le shell, dans le répertoire où le programme doit * être installé : \verbatim $ ganil_run -gui \endverbatim * * Les fichiers créés sont: * - les fichiers .hh (header) et .cpp (code C++) de la classe d'analyse * utilisateur * - un fichier .cpp avec un programme principal type * - un script de compilation (makefile) * * Les codes C++ sont prêts à être modifiés pour inclure les analyses * souhaitées ! * */
41  * (pas de paramètres calculés), et de faire tous les traitements
42  * possibles par l'interface graphique.
43  *
44  *
45  * \par Configuration pour l'utilisation des bibliothèques
46  *
47  * Le fichier de configuration \b ganil_run_config.csh (dans le répertoire
48  * \b scripts) définit les variables d'environnement et les alias pour
49  * l'utilisation des bibliothèques.
50  *
51  * Il doit être appelé dans le fichier de configuration du shell (\b .cshrc):
52  * - soit par le script général de l'ensemble des bibliothèques d'analyse
53  * - soit directement (nécessite également la configuration pour les
54  * bibliothèques additionnelles pour ROOT et pour les bibliothèques
55  * Event)
56  *
57  *
58  * \par Définition d'une classe d'analyse utilisateur
59  *
60  * Le script shell (\b tcsh) ganil_run.csh (dans le répertoire \b scripts)
61  * permet de générer automatiquement les fichiers utilisateur pour une
62  * nouvelle analyse.
63  * Un alias est défini: \b ganil_run.
64  *
65  * Pour voir les options du script:
66  \verbatim
67  $ ganil_run -help
68  \endverbatim
69  *
70  * Pour générer les fichiers (squelette) d'une nouvelle analyse (avec
71  * interface graphique si l'option \b -gui est spécifiée, il suffit
72  * d'exécuter dans le shell, dans le répertoire où le programme doit
73  * être installé :
74  \verbatim
75  $ ganil_run -gui
76  \endverbatim
77  *
78  * Les fichiers créés sont:
79  * - les fichiers .hh (header) et .cpp (code C++) de la classe d'analyse
80  * utilisateur
81  * - un fichier .cpp avec un programme principal type
82  * - un script de compilation (makefile)
83  *
84  * Les codes C++ sont prêts à être modifiés pour inclure les analyses
85  * souhaitées !
86  *
87  */