367fd902d96d2259f592d467bdec09347a9dd705
[u/mrichter/AliRoot.git] / MUON / READMEmapping
1  $Id$
2
3
4  The mapping package
5  ====================
6  
7  See detailed description in ALICE-INT-2003-025.
8
9  Test macros
10  ============
11    cd ../mapping/macro
12    root
13    root [0] .x testMacroName.C    
14                         - see available macros below   
15                    
16    A set of test macros be run at once by test_suite.pl scripts:
17      test_suite.pl      - run all test macros and compare results with
18                           the reference output
19      test_suite_ref.pl  - generates reference output
20                           !! this script will overwrite the refence output
21                              provided with the source;
22                              it should be used only by developers 
23
24    Macros included in the test suite:
25      testReadSector.C
26      testReadMotifType.C
27      testGraphics.C        
28      testSectorFind.C
29      testPlaneFind.C
30      testPrintLimits.C         
31      testExistingPads.C    
32      testPadDimensions.C    
33      testSectorPadIterators.C
34      testMotifTypeIterators.C     
35      testNeighboursPadIterator.C  
36      testAnyPadIterators.C  
37      testPadsUp.C
38      testPlaneAreaIterator.C
39      
40    Other macros (not included in the test suite):
41      testAllIndices.C
42      testUpdateGlobalIndices.C
43    
44
45   Data files format
46   ============
47
48   zones.dat:
49   -------------
50   Describes layout of zones, rows, row segments, subzones, motifs
51
52   SECTOR_DATA
53     number of zones  
54     number of rows  
55     direction of constant pad size (X or Y)
56   
57   ZONE     
58     number of zone  
59     half legth of pad size in x  
60     half legth of pad size in y
61
62   SUBZONE  
63     motif id  
64     motif type_id       
65
66   ROW_SEGMENT  
67     x offset (in number of pads) 
68     y offset (in number of pads) 
69     row number 
70     nof motifs 
71     first motif position Id
72     step to the next motif position Id (+1 or -1)
73   
74   zones_special.dat:
75   ------------------
76   Describes layout of special row segments (with irregular motifs)
77
78   SECTOR_SPECIAL_DATA
79
80   MOTIF
81     zone id
82     motif id  
83     motif type_id       
84
85   ROW
86     row number
87   
88   PAD_ROWS
89     number of these pad rows in row   
90   
91   PAD_ROW_SEGMENT
92     mumber of pads in the rows segment  
93     motif id  
94     motif position id
95   
96   motifX.dat
97   ----------
98   Describes characteristics of the motif type X
99
100   In lines:
101     Berg number
102     Kapton number
103     Pad number
104     Gassi number
105
106   motifSpecialX.dat
107   ------------------
108   Describes characteristics of the special motif with motif Id X;
109   the special motif caontains pads of different size
110
111   In lines:
112     pad index i (in x)
113     pad index j (in y)
114     half legth of pad size in x  
115     half legth of pad size in y
116   
117   padPosX.dat
118   -----------
119   Maps pad numbers used in the motifX.dat files to
120   the local pad indices (i,j)
121
122   In lines:
123     Pad number
124     pad index i (in x)
125     pad index j (in y)
126   
127   
128