Analysis  version 7.0 - august 2014
DocTreeRun.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file DocTreeRun.hh
3  *
4  * Fichier de documentation des classes d'analyse TreeRun et GEVTreeRun.
5  *
6  */
7 //======================================================================
8 
9 
10 /*! \page tree_run_analysis Analyses spécifiques des TTree/ROOT
11  *
12  * \par Classes d'analyse spécifiques
13  *
14  * Pour l'analyse des données de fichiers de TTree/ROOT, les classes
15  * TreeRun (analyse de base, héritant de RunBase) et GEVTreeRun
16  * (analyse avec interface graphique, héritant de GEVRunBase)
17  * sont définies.
18  *
19  * Elle spécifient les fonctions de traitement des fichiers ROOT contenant
20  * un TTree (qui doit avoir le même nom et la même structure dans tous
21  * les fichiers analysés ensemble): ouverture, fermeture, lecture des
22  * événements.
23  *
24  * Un programme d'analyse prêt à l'emploi est inclus: \b TreeRun, 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 de base. * * * \par Configuration pour l'utilisation des bibliothèques * * Le fichier de configuration \b event_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) * * * \par Définition d'une classe d'analyse utilisateur * * Le script shell (\b tcsh) tree_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 tree_run. * * Pour voir les options du script: \verbatim $ tree_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 $ tree_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 ! * */
25  * sur l'interface graphique.
26  * 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 de base. * * * \par Configuration pour l'utilisation des bibliothèques * * Le fichier de configuration \b event_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) * * * \par Définition d'une classe d'analyse utilisateur * * Le script shell (\b tcsh) tree_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 tree_run. * * Pour voir les options du script: \verbatim $ tree_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 $ tree_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 ! * */
27  * (pas de paramètres calculés), et de faire tous les traitements
28  * possibles par l'interface graphique de base.
29  *
30  *
31  * \par Configuration pour l'utilisation des bibliothèques
32  *
33  * Le fichier de configuration \b event_config.csh (dans le répertoire
34  * \b scripts) définit les variables d'environnement et les alias pour
35  * l'utilisation des bibliothèques.
36  *
37  * Il doit être appelé dans le fichier de configuration du shell (\b .cshrc):
38  * - soit par le script général de l'ensemble des bibliothèques d'analyse
39  * - soit directement (nécessite également la configuration pour les
40  * bibliothèques additionnelles pour ROOT)
41  *
42  *
43  * \par Définition d'une classe d'analyse utilisateur
44  *
45  * Le script shell (\b tcsh) tree_run.csh (dans le répertoire \b scripts)
46  * permet de générer automatiquement les fichiers utilisateur pour une
47  * nouvelle analyse.
48  * Un alias est défini: \b tree_run.
49  *
50  * Pour voir les options du script:
51  \verbatim
52  $ tree_run -help
53  \endverbatim
54  *
55  * Pour générer les fichiers (squelette) d'une nouvelle analyse (avec
56  * interface graphique si l'option \b -gui est spécifiée, il suffit
57  * d'exécuter dans le shell, dans le répertoire où le programme doit
58  * être installé :
59  \verbatim
60  $ tree_run -gui
61  \endverbatim
62  *
63  * Les fichiers créés sont:
64  * - les fichiers .hh (header) et .cpp (code C++) de la classe d'analyse
65  * utilisateur
66  * - un fichier .cpp avec un programme principal type
67  * - un script de compilation (makefile)
68  *
69  * Les codes C++ sont prêts à être modifiés pour inclure les analyses
70  * souhaitées !
71  *
72  */