Analysis  version 7.0 - august 2014
DocSimulRun.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file DocSimulRun.hh
3  *
4  * Fichier de documentation des classes d'analyse SimulRun et GEVSimulRun.
5  *
6  */
7 //======================================================================
8 
9 
10 /*! \page simul_run_analysis Analyses spécifiques sans fichier d'entrée (simulation)
11  *
12  * \par Classes d'analyse spécifiques
13  *
14  * Pour l'analyse des données sans fichier d'entrée (simulations),
15  * les classes SimulRun (analyse de base, héritant de RunBase) et
16  * GEVSimulRun (analyse avec interface graphique, héritant de GEVRunBase)
17  * sont définies.
18  *
19  * Comme ces classes n'utilisent pas de fichiers d'entrée, 2 nouvelles
20  * fonctions utilisateurs peuvent être utilisées pour générer l'équivalent
21  * d'une structure d'événement brut.
22  * - \b CreateEvent : définition des paramètres bruts simulés (appelée * à l'initialisation) * - \b FillRawEvent : affectation des paramètres bruts (appelée au début * du traitement de chaque événement) * * Ce n'est obligatoire, et tous les paramètres peuvent être simulés comme * paramètres utilisateur (fonctions UserEventCreate et UserEvent). * * S'il n'y a pas de fichiers d'entrée, on peut néanmoins grouper les * événements générés par ensembles (pseudo-fichiers) avec un numéro * et un nom d'analyse. * Celà présente l'intérêt notemment de pouvoir sauvegarder des TTree * dans des fichiers en gardant ces regroupements. * * L'interface graphique de base est modifiée du fait de l'absence de * fichiers d'entrée. * La partie correspondante est remplacée par la saisie du nom et * des numéros d'analyse, et le nombre d'événements générés par pseudo-fichier. * * * \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) simul_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 simul_run. * * Pour voir les options du script: \verbatim $ simul_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 $ simul_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 ! * */
23  * à l'initialisation)
24  * - \b FillRawEvent : affectation des paramètres bruts (appelée au début
25  * du traitement de chaque événement)
26  *
27  * Ce n'est obligatoire, et tous les paramètres peuvent être simulés comme
28  * paramètres utilisateur (fonctions UserEventCreate et UserEvent).
29  *
30  * S'il n'y a pas de fichiers d'entrée, on peut néanmoins grouper les
31  * événements générés par ensembles (pseudo-fichiers) avec un numéro
32  * et un nom d'analyse.
33  * Celà présente l'intérêt notemment de pouvoir sauvegarder des TTree
34  * dans des fichiers en gardant ces regroupements.
35  *
36  * L'interface graphique de base est modifiée du fait de l'absence de
37  * fichiers d'entrée.
38  * La partie correspondante est remplacée par la saisie du nom et
39  * des numéros d'analyse, et le nombre d'événements générés par pseudo-fichier.
40  *
41  *
42  * \par Configuration pour l'utilisation des bibliothèques
43  *
44  * Le fichier de configuration \b event_config.csh (dans le répertoire
45  * \b scripts) définit les variables d'environnement et les alias pour
46  * l'utilisation des bibliothèques.
47  *
48  * Il doit être appelé dans le fichier de configuration du shell (\b .cshrc):
49  * - soit par le script général de l'ensemble des bibliothèques d'analyse
50  * - soit directement (nécessite également la configuration pour les
51  * bibliothèques additionnelles pour ROOT)
52  *
53  *
54  * \par Définition d'une classe d'analyse utilisateur
55  *
56  * Le script shell (\b tcsh) simul_run.csh (dans le répertoire \b scripts)
57  * permet de générer automatiquement les fichiers utilisateur pour une
58  * nouvelle analyse.
59  * Un alias est défini: \b simul_run.
60  *
61  * Pour voir les options du script:
62  \verbatim
63  $ simul_run -help
64  \endverbatim
65  *
66  * Pour générer les fichiers (squelette) d'une nouvelle analyse (avec
67  * interface graphique si l'option \b -gui est spécifiée, il suffit
68  * d'exécuter dans le shell, dans le répertoire où le programme doit
69  * être installé :
70  \verbatim
71  $ simul_run -gui
72  \endverbatim
73  *
74  * Les fichiers créés sont:
75  * - les fichiers .hh (header) et .cpp (code C++) de la classe d'analyse
76  * utilisateur
77  * - un fichier .cpp avec un programme principal type
78  * - un script de compilation (makefile)
79  *
80  * Les codes C++ sont prêts à être modifiés pour inclure les analyses
81  * souhaitées !
82  *
83  */