]>
Commit | Line | Data |
---|---|---|
26a4668d | 1 | #ifndef ALIHLTMUONCONSTANTS_H |
2 | #define ALIHLTMUONCONSTANTS_H | |
e6357f88 | 3 | /************************************************************************** |
4 | * This file is property of and copyright by the ALICE HLT Project * | |
5 | * All rights reserved. * | |
6 | * * | |
7 | * Primary Authors: * | |
8 | * Indranil Das <indra.das@saha.ac.in> * | |
9 | * Artur Szostak <artursz@iafrica.com> * | |
10 | * * | |
11 | * Permission to use, copy, modify and distribute this software and its * | |
12 | * documentation strictly for non-commercial purposes is hereby granted * | |
13 | * without fee, provided that the above copyright notice appears in all * | |
14 | * copies and that both the copyright notice and this permission notice * | |
15 | * appear in the supporting documentation. The authors make no claims * | |
16 | * about the suitability of this software for any purpose. It is * | |
17 | * provided "as is" without express or implied warranty. * | |
18 | **************************************************************************/ | |
26a4668d | 19 | |
20 | /* $Id$ */ | |
21 | ||
22 | /** | |
23 | * @file AliHLTMUONConstants.h | |
24 | * @author Indranil Das <indra.das@saha.ac.in>, | |
25 | * Artur Szostak <artursz@iafrica.com> | |
26 | * @date | |
27 | * @brief Class containing various dimuon HLT constants used in the system. | |
28 | */ | |
29 | ||
b12fe461 | 30 | // Forward declare structures. |
31 | extern "C" { | |
32 | struct AliHLTComponentDataType; | |
33 | struct AliHLTMUONTriggerRecordStruct; | |
34 | struct AliHLTMUONTrigRecInfoStruct; | |
35 | struct AliHLTMUONTriggerChannelStruct; | |
36 | struct AliHLTMUONRecHitStruct; | |
37 | struct AliHLTMUONChannelStruct; | |
38 | struct AliHLTMUONClusterStruct; | |
39 | struct AliHLTMUONMansoTrackStruct; | |
40 | struct AliHLTMUONMansoRoIStruct; | |
41 | struct AliHLTMUONMansoCandidateStruct; | |
42 | struct AliHLTMUONTrackDecisionStruct; | |
43 | struct AliHLTMUONPairDecisionStruct; | |
44 | } // extern "C" | |
26a4668d | 45 | |
46 | /** | |
47 | * AliHLTMUONConstants contains a list of global dimuon HLT specific constants | |
48 | * and constant structures used in the system. | |
49 | * Static methods are provided to access these values. | |
50 | */ | |
51 | class AliHLTMUONConstants | |
52 | { | |
53 | public: | |
54 | ||
c8ec7c7e | 55 | static const AliHLTMUONTriggerRecordStruct& NilTriggerRecordStruct() |
56 | { | |
57 | return fgkNilTriggerRecordStruct; | |
58 | } | |
59 | ||
60 | static const AliHLTMUONTrigRecInfoStruct& NilTrigRecInfoStruct() | |
61 | { | |
62 | return fgkNilTrigRecInfoStruct; | |
63 | } | |
64 | ||
65 | static const AliHLTMUONTriggerChannelStruct& NilTriggerChannelStruct() | |
66 | { | |
67 | return fgkNilTriggerChannelStruct; | |
68 | } | |
69 | ||
26a4668d | 70 | static const AliHLTMUONRecHitStruct& NilRecHitStruct() |
71 | { | |
72 | return fgkNilRecHitStruct; | |
73 | } | |
74 | ||
910807dd | 75 | static const AliHLTMUONChannelStruct& NilChannelStruct() |
26a4668d | 76 | { |
910807dd | 77 | return fgkNilChannelStruct; |
26a4668d | 78 | } |
79 | ||
910807dd | 80 | static const AliHLTMUONClusterStruct& NilClusterStruct() |
26a4668d | 81 | { |
910807dd | 82 | return fgkNilClusterStruct; |
26a4668d | 83 | } |
84 | ||
90a74d7a | 85 | static const AliHLTMUONMansoTrackStruct& NilMansoTrackStruct() |
86 | { | |
87 | return fgkNilMansoTrackStruct; | |
88 | } | |
89 | ||
90 | static const AliHLTMUONMansoRoIStruct& NilMansoRoIStruct() | |
91 | { | |
92 | return fgkNilMansoRoIStruct; | |
93 | } | |
94 | ||
95 | static const AliHLTMUONMansoCandidateStruct& NilMansoCandidateStruct() | |
96 | { | |
97 | return fgkNilMansoCandidateStruct; | |
98 | } | |
99 | ||
100 | static const AliHLTMUONTrackDecisionStruct& NilTrackDecisionStruct() | |
101 | { | |
102 | return fgkNilTrackDecisionStruct; | |
103 | } | |
104 | ||
105 | static const AliHLTMUONPairDecisionStruct& NilPairDecisionStruct() | |
106 | { | |
107 | return fgkNilPairDecisionStruct; | |
108 | } | |
109 | ||
668eee9f | 110 | // Returns the raw data type for MUON DDLs. To figure out if the DDL format |
111 | // will be for a tracking DDL or trigger DDL one needs to also check the | |
112 | // sepcification word of the input data block. If one of the first 20 least | |
113 | // significant bits are set then it is a tracker DDL otherwise if it is | |
114 | // the 21st or 22nd bit then it is from the muon trigger. | |
115 | static const AliHLTComponentDataType& DDLRawDataType() | |
26a4668d | 116 | { |
668eee9f | 117 | return fgkDDLRawDataType; |
26a4668d | 118 | } |
119 | ||
910807dd | 120 | static const AliHLTComponentDataType& TriggerRecordsBlockDataType() |
26a4668d | 121 | { |
910807dd | 122 | return fgkTriggerRecordsBlockDataType; |
26a4668d | 123 | } |
124 | ||
910807dd | 125 | static const AliHLTComponentDataType& TrigRecsDebugBlockDataType() |
26a4668d | 126 | { |
910807dd | 127 | return fgkTrigRecsDebugBlockDataType; |
26a4668d | 128 | } |
129 | ||
910807dd | 130 | static const AliHLTComponentDataType& TriggerChannelBlockDataType() |
26a4668d | 131 | { |
910807dd | 132 | return fgkTriggerChannelBlockDataType; |
133 | } | |
134 | ||
135 | static const AliHLTComponentDataType& RecHitsBlockDataType() | |
136 | { | |
137 | return fgkRecHitsBlockDataType; | |
138 | } | |
139 | ||
140 | static const AliHLTComponentDataType& ClusterBlockDataType() | |
141 | { | |
142 | return fgkClusterBlockDataType; | |
26a4668d | 143 | } |
144 | ||
910807dd | 145 | static const AliHLTComponentDataType& ChannelBlockDataType() |
26a4668d | 146 | { |
910807dd | 147 | return fgkChannelBlockDataType; |
26a4668d | 148 | } |
149 | ||
150 | static const AliHLTComponentDataType& MansoTracksBlockDataType() | |
151 | { | |
152 | return fgkMansoTracksBlockDataType; | |
153 | } | |
154 | ||
90a74d7a | 155 | static const AliHLTComponentDataType& MansoCandidatesBlockDataType() |
26a4668d | 156 | { |
90a74d7a | 157 | return fgkMansoCandidatesBlockDataType; |
910807dd | 158 | } |
159 | ||
90a74d7a | 160 | static const AliHLTComponentDataType& SinglesDecisionBlockDataType() |
910807dd | 161 | { |
90a74d7a | 162 | return fgkSinglesDecisionBlockDataType; |
26a4668d | 163 | } |
164 | ||
90a74d7a | 165 | static const AliHLTComponentDataType& PairsDecisionBlockDataType() |
26a4668d | 166 | { |
90a74d7a | 167 | return fgkPairsDecisionBlockDataType; |
26a4668d | 168 | } |
b12fe461 | 169 | |
170 | static const char* RecHitsSourceId() | |
171 | { | |
172 | return fgkRecHitsSourceId; | |
173 | } | |
6cde4e61 | 174 | |
e6357f88 | 175 | static const char* TriggerRecordsSourceId() |
176 | { | |
177 | return fgkTriggerRecordsSourceId; | |
178 | } | |
179 | ||
180 | static const char* MansoTracksSourceId() | |
181 | { | |
182 | return fgkMansoTracksSourceId; | |
183 | } | |
184 | ||
185 | static const char* TriggerReconstructorId() | |
186 | { | |
187 | return fgkTriggerReconstructorId; | |
188 | } | |
189 | ||
190 | static const char* HitReconstructorId() | |
191 | { | |
192 | return fgkHitReconstructorId; | |
193 | } | |
194 | ||
6cde4e61 | 195 | static const char* MansoTrackerFSMId() |
196 | { | |
197 | return fgkMansoTrackerFSMId; | |
198 | } | |
e6357f88 | 199 | |
200 | static const char* DecisionComponentId() | |
201 | { | |
202 | return fgkDecisionComponentId; | |
203 | } | |
8134dd2e | 204 | |
450e0b36 | 205 | static const char* RootifierComponentId() |
8134dd2e | 206 | { |
450e0b36 | 207 | return fgkRootifierComponentId; |
8134dd2e | 208 | } |
0528e93a | 209 | |
210 | static const char* EmptyEventFilterComponentId() | |
211 | { | |
212 | return fgkEmptyEventFilterComponentId; | |
213 | } | |
c9537879 | 214 | |
215 | static const char* DecisionComponentCDBPath() | |
216 | { | |
217 | return fgkDecisionComponentCDBPath; | |
218 | } | |
26a4668d | 219 | |
220 | private: | |
90a74d7a | 221 | |
b12fe461 | 222 | // Should never have to create, destroy or copy this object. |
26a4668d | 223 | AliHLTMUONConstants(); |
b12fe461 | 224 | AliHLTMUONConstants(const AliHLTMUONConstants& obj); |
26a4668d | 225 | ~AliHLTMUONConstants(); |
b12fe461 | 226 | AliHLTMUONConstants& operator = (const AliHLTMUONConstants& obj); |
c8ec7c7e | 227 | |
b12fe461 | 228 | // The following are null/nil structures that can also be used as sentinels: |
229 | static const AliHLTMUONTriggerRecordStruct fgkNilTriggerRecordStruct; // Nil trigger record. | |
230 | static const AliHLTMUONTrigRecInfoStruct fgkNilTrigRecInfoStruct; // Nil trigger record debug information. | |
231 | static const AliHLTMUONTriggerChannelStruct fgkNilTriggerChannelStruct; // Nil trigger chamber channel. | |
232 | static const AliHLTMUONRecHitStruct fgkNilRecHitStruct; // Nil reconstructed hit. | |
233 | static const AliHLTMUONChannelStruct fgkNilChannelStruct; // Nil tracking chamber channel. | |
234 | static const AliHLTMUONClusterStruct fgkNilClusterStruct; // Nil tracking chamber cluster. | |
235 | static const AliHLTMUONMansoTrackStruct fgkNilMansoTrackStruct; // Nil manso track. | |
236 | static const AliHLTMUONMansoRoIStruct fgkNilMansoRoIStruct; // Nil manso region of interest. | |
237 | static const AliHLTMUONMansoCandidateStruct fgkNilMansoCandidateStruct; // Nil manso candidate track. | |
238 | static const AliHLTMUONTrackDecisionStruct fgkNilTrackDecisionStruct; // Nil decision for single track. | |
239 | static const AliHLTMUONPairDecisionStruct fgkNilPairDecisionStruct; // Nil decision for track pair. | |
240 | ||
241 | // HLT component input and output data block types: | |
668eee9f | 242 | static const AliHLTComponentDataType fgkDDLRawDataType; // DDL packed data block type from dimuon spectrometer. |
b12fe461 | 243 | static const AliHLTComponentDataType fgkTriggerRecordsBlockDataType; // Trigger records block type generated by trigger DDL translation components. |
244 | static const AliHLTComponentDataType fgkTrigRecsDebugBlockDataType; // Debugging information block type generated by trigger DDL translation components. | |
245 | static const AliHLTComponentDataType fgkTriggerChannelBlockDataType; // Debugging information about the channels from the hardware trigger. | |
246 | static const AliHLTComponentDataType fgkRecHitsBlockDataType; // Reconstructed hits block type generated by hit reconstruction components. | |
247 | static const AliHLTComponentDataType fgkClusterBlockDataType; // Debugging information block type for reconstructed hit clusters. | |
248 | static const AliHLTComponentDataType fgkChannelBlockDataType; // Debugging information block type for channels corresponding to clusters. | |
249 | static const AliHLTComponentDataType fgkMansoTracksBlockDataType; // Manso tracks block type generated by Manso tracker components. | |
250 | static const AliHLTComponentDataType fgkMansoCandidatesBlockDataType; // Debugging information about a track candidate generated by the Manso algorithm. | |
251 | static const AliHLTComponentDataType fgkSinglesDecisionBlockDataType; // Trigger decision block type for single track decisions. | |
252 | static const AliHLTComponentDataType fgkPairsDecisionBlockDataType; // Trigger decision block type for pairs of particles. | |
253 | ||
254 | // Component ID names: | |
e6357f88 | 255 | static const char* fgkRecHitsSourceId; // Name of source component for reconstructed hits for debugging. |
256 | static const char* fgkTriggerRecordsSourceId; // Name of source component for trigger records for debugging. | |
257 | static const char* fgkMansoTracksSourceId; // Name of source component for Manso tracks for debugging. | |
258 | static const char* fgkTriggerReconstructorId; // Trigger record reconstructor component name. | |
259 | static const char* fgkHitReconstructorId; // Centre of gravity cluster finder component name. | |
6cde4e61 | 260 | static const char* fgkMansoTrackerFSMId; // Manso tracker FSM implementation component name. |
e6357f88 | 261 | static const char* fgkDecisionComponentId; // dHLT decision component name. |
450e0b36 | 262 | static const char* fgkRootifierComponentId; // The name of the event filter debugging component. |
0528e93a | 263 | static const char* fgkEmptyEventFilterComponentId; // The name of the event filter debugging component. |
c9537879 | 264 | |
265 | // CDB path entries to configuration information. | |
266 | static const char* fgkDecisionComponentCDBPath; // Path to CDB entry for trigger decision component. | |
26a4668d | 267 | }; |
268 | ||
269 | #endif // ALIHLTMUONCONSTANTS_H |