doc/examples/README.txt

This directory contains some very simple macros, just to show how to use the PamLevel2 class.
The macros need as input the name of a Level2 .root file produced by DarthVader 
(example1 and example2) or a list of files (see example3).

example1 - Example to integrate all detector info and solve the y-view tracks ambiguity
example2 - Example to get pamela tracks and integrate the trajectory in the apparatus
example3 - Example to loop over events, reading more than one file
Loop     - Example to loop over events, apply some selection cuts (My-Selection.cpp) and filling an 
           output file with histograms (My-Histos.cpp) and/or trees. 

In order to run the scripts:

1) Copy the magnetic field maps into the magnetic-field/ directory.
   You can find them in the CVS repository, inside DarthVader/param/trk-param/field_param-0/

2) Add the path of the directory containing the DarthVader libraries and the PamLevel2 library to the 
   shell variable LD_LIBRARY_PATH

3) Open a root session and execute the following commands:

[] .x load.C
[] .L example1.C
[] example1("level2-data-path/level2-file, execute the command.root")
Tracker      : set branch address TrkLevel2
Calorimeter  : set branch address CaloLevel2
ToF          : set branch address ToFLevel2
Trigger      : set branch address TrigLevel2
S4           : set branch address S4Level2
NeutronD     : set branch address NDLevel2
Anticounter  : set branch address AcLevel2

 Start loop over events
 
 Done

4) Macros example1 and example2 produce some histograms. Example3 just loop over events and tracks and 
counts time. It is usefull to check processing time.


5) To create Loop.exe execute the command (you need the PAMELA environment variables):

> make Loop.exe

The executable is create by compiling and linking the files:

Loop.cpp
My-Selection.cpp
My-Histos.cpp

You can use My-Selection.cpp and My-Histos.cpp as a template to inplement your own
selection cuts and analysis. 
More generally, you can compile and link Loop.cpp with your own source files (you need 
to edit also the Makefile), where you should implement at least the following functions:

bool Select(PamLevel2*);
void CreateHistos(TFile*);
void FillHistos(PamLevel2*);
void SaveHistos(TFile*);

To know how to use Loop.exe, issue:
./Loop.exe --help

(If you execute "make Loop-0.exe" the old example code, previously posted on the cvs, 
is compiled and linked. This is not a very general example, better use the new one)
1	pam-fi	1.1	This directory contains some very simple macros, just to show how to use the PamLevel2 class.
2	pam-fi	1.2	The macros need as input the name of a Level2 .root file produced by DarthVader
3			(example1 and example2) or a list of files (see example3).
4
5			example1 - Example to integrate all detector info and solve the y-view tracks ambiguity
6			example2 - Example to get pamela tracks and integrate the trajectory in the apparatus
7			example3 - Example to loop over events, reading more than one file
8	pam-fi	1.4	Loop - Example to loop over events, apply some selection cuts (My-Selection.cpp) and filling an
9	pam-fi	1.3	output file with histograms (My-Histos.cpp) and/or trees.
10	pam-fi	1.1
11			In order to run the scripts:
12
13			1) Copy the magnetic field maps into the magnetic-field/ directory.
14			You can find them in the CVS repository, inside DarthVader/param/trk-param/field_param-0/
15
16			2) Add the path of the directory containing the DarthVader libraries and the PamLevel2 library to the
17			shell variable LD_LIBRARY_PATH
18
19			3) Open a root session and execute the following commands:
20
21			[] .x load.C
22			[] .L example1.C
23	pam-fi	1.4	[] example1("level2-data-path/level2-file, execute the command.root")
24	pam-fi	1.1	Tracker : set branch address TrkLevel2
25			Calorimeter : set branch address CaloLevel2
26			ToF : set branch address ToFLevel2
27			Trigger : set branch address TrigLevel2
28			S4 : set branch address S4Level2
29			NeutronD : set branch address NDLevel2
30			Anticounter : set branch address AcLevel2
31
32			Start loop over events
33
34			Done
35
36	pam-fi	1.2	4) Macros example1 and example2 produce some histograms. Example3 just loop over events and tracks and
37			counts time. It is usefull to check processing time.
38	pam-fi	1.3
39
40	pam-fi	1.4	5) To create Loop.exe execute the command (you need the PAMELA environment variables):
41
42			> make Loop.exe
43
44			The executable is create by compiling and linking the files:
45
46			Loop.cpp
47			My-Selection.cpp
48			My-Histos.cpp
49
50			You can use My-Selection.cpp and My-Histos.cpp as a template to inplement your own
51			selection cuts and analysis.
52			More generally, you can compile and link Loop.cpp with your own source files (you need
53			to edit also the Makefile), where you should implement at least the following functions:
54
55			bool Select(PamLevel2*);
56			void CreateHistos(TFile*);
57			void FillHistos(PamLevel2*);
58			void SaveHistos(TFile*);
59
60			To know how to use Loop.exe, issue:
61	pam-fi	1.3	./Loop.exe --help
62	pam-fi	1.4
63			(If you execute "make Loop-0.exe" the old example code, previously posted on the cvs,
64			is compiled and linked. This is not a very general example, better use the new one)