Updated AliZDCPreprocessor class
[u/mrichter/AliRoot.git] / ZDC / TestZDCPreprocessor.C
1 /* $Id$ */
2
3 // This class runs the test preprocessor
4 // It uses AliTestShuttle to simulate a full Shuttle process
5
6 // The input data is created in the functions
7 //   CreateDCSAliasMap() creates input that would in the same way come from DCS
8 //   ReadDCSAliasMap() reads from a file
9 //   CreateInputFilesMap() creates a list of local files, that can be accessed by the shuttle
10
11 void TestZDCPreprocessor(Int_t obj=0)
12 {
13   // load library
14   gSystem->Load("libTestShuttle.so");
15
16   // create AliTestShuttle instance
17   // The parameters are run, startTime, endTime
18   AliTestShuttle* shuttle = new AliTestShuttle(0, 0, 1);
19
20   // TODO if needed, change location of OCDB and Reference test folders
21   // by default they are set to $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB and TestReference
22   AliTestShuttle::SetMainCDB("local://$ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB");
23   AliTestShuttle::SetMainRefStorage("local://$ALICE_ROOT/SHUTTLE/TestShuttle/TestReference");
24
25   printf("Test OCDB storage Uri: %s\n", AliShuttleInterface::GetMainCDB().Data());
26   printf("Test Reference storage Uri: %s\n", AliShuttleInterface::GetMainRefStorage().Data());
27
28
29   // TODO(1)
30   //
31   // The shuttle can read DCS data, if the preprocessor should be tested to process DCS data,
32   // some fake data has to be created.
33   //
34   // The "fake" input data can be taken using either (a) or (b):
35   // (a) data from a file: Use ReadDCSAliasMap()
36   //     the format of the file is explained in ReadDCSAliasMap()
37   //     To use it uncomment the following line:
38   //
39   //TMap* dcsAliasMap = ReadDCSAliasMap();
40   //
41   // (b) generated in this macro: Use CreateDCSAliasMap() and its documentation
42   //     To use it uncomment the following line:
43   //
44   TMap* dcsAliasMap = CreateDCSAliasMap();
45   //WriteDCSAliasMap();
46
47   // now give the alias map to the shuttle
48   shuttle->SetDCSInput(dcsAliasMap);
49
50   // TODO(2)
51   //
52   // The shuttle can also process files that originate from DCS, DAQ and HLT.
53   // To test it, we provide some local files and locations where these would be found when
54   // the online machinery would be there.
55   // In real life this functions would be produces by the sub-detectors
56   // calibration programs in DCS, DAQ or HLT. These files can then be retrieved using the Shuttle.
57   //
58   // Files are added with the function AliTestShuttle::AddInputFile. The syntax is:
59   // AddInputFile(<system>, <detector>, <id>, <source>, <local-file>)
60   // In this example we add a file originating from the GDC with the id PEDESTALS
61   // Three files originating from different LDCs but with the same id are also added
62   // Note that the test preprocessor name is TPC. The name of the detector's preprocessor must follow
63   // the "online" naming convention ALICE-INT-2003-039.
64   //
65   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "PEDESTALS", "LDC0", "ZDCPedestal.dat");
66   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "PEDESTALS", "LDC0", "ZDCChMapping.dat");
67   //
68   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "LASER", "LDC0", "ZDCLaserCalib.dat");
69   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "LASER", "LDC0", "ZDCChMapping.dat");
70   //
71   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "EMDCALIB", "LDC0", "ZDCEMDCalib.dat");
72   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "EMDCALIB", "LDC0", "ZDCChMapping.dat");
73   //
74   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "PHYSICS", "LDC0", "ZDCChMapping.dat");
75   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "COSMICS", "LDC0", "ZDCChMapping.dat");
76   //
77   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "BC", "LDC0", "ZDCChMapping.dat");
78
79   // TODO(3)
80   //
81   // The shuttle can read run type stored in the DAQ logbook.
82   // To test it, we must provide the run type manually. They will be retrieved in the preprocessor
83   // using GetRunType function.
84   if(obj==1)      shuttle->SetInputRunType("STANDALONE_PEDESTAL");
85   else if(obj==2) shuttle->SetInputRunType("STANDALONE_LASER");
86   else if(obj==3) shuttle->SetInputRunType("STANDALONE_EMD");
87   else if(obj==4) shuttle->SetInputRunType("STANDALONE_COSMIC");
88   else if(obj==5) shuttle->SetInputRunType("STANDALONE_BC");
89   else if(obj==6) shuttle->SetInputRunType("PHYSICS");
90
91   // TODO(4)
92   //
93   // The shuttle can read run parameters stored in the DAQ run logbook.
94   // To test it, we must provide the run parameters manually. They will be retrieved in the preprocessor
95   // using GetRunParameter function.
96   // In real life the parameters will be retrieved automatically from the run logbook;
97   //shuttle->AddInputRunParameter("beamType", "Pb-Pb");
98   shuttle->AddInputRunParameter("beamType", "p-p");
99   shuttle->AddInputRunParameter("totalEvents", "1000");
100   shuttle->AddInputRunParameter("NumberOfGDCs", "1");
101
102   // TODO(5) NEW!
103   //
104   // This is for preprocessor that require data from HLT.
105   // Since HLT may be switched off, the preprocessor should first query the Run logbook where
106   // the HLT status is stored. SHUTTLE implements a shortcut function (GetHLTStatus) that returns
107   // a bool directly. 1 = HLT ON, 0 = HLT OFF
108   //
109   Bool_t hltStatus=kFALSE;
110   shuttle->SetInputHLTStatus(hltStatus);
111
112   // TODO(6)
113   //
114   // The shuttle can query condition parameters valid from the current run from the OCDB
115   // To test it, we must first store the object into the OCDB. It will be retrieved in the preprocessor
116   // using GetFromOCDB function.
117
118   /*TObjString obj("This is a condition parameter stored in OCDB");
119   AliCDBId id("ZDC/Calib/Data", 0, AliCDBRunRange::Infinity());
120   AliCDBMetaData md;
121   AliCDBEntry entry(&obj, id, &md);
122
123   shuttle->AddInputCDBEntry(&entry);
124   */
125   
126   // TODO(6)
127   // Create the preprocessor that should be tested, it registers itself automatically to the shuttle
128   AliPreprocessor* test = new AliZDCPreprocessor(shuttle);
129
130   // Test the preprocessor
131   shuttle->Process();
132
133   // TODO(7)
134   // In the preprocessor AliShuttleInterface::Store should be called to put the final
135   // data to the CDB. To check if all went fine have a look at the files produced in
136   // $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/SHUTTLE/Data
137   //
138   // Check the file which should have been created
139   AliCDBEntry* chkEntry0 = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
140                         ->Get("ZDC/Calib/ChMap", 0);
141   AliCDBEntry* chkEntry1;
142   if(obj==1) chkEntry1 = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
143                         ->Get("ZDC/Calib/Pedestals", 0);
144   else if(obj==2) chkEntry1 = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
145                         ->Get("ZDC/Calib/LaserCalib", 0);
146   else if(obj==3) chkEntry1 = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
147                         ->Get("ZDC/Calib/EMDCalib", 0);
148   
149   
150   if(!chkEntry0){
151     printf("No file in \n ZDC/Calib/ChMap\n");
152     return;
153   }
154   if(!chkEntry1){
155     if(obj==1) printf("No file in \n ZDC/Calib/Pedestal\n");
156     else if(obj==2) printf("No file in \n ZDC/Calib/LaserCalib\n");
157     else if(obj==3) printf("No file in \n ZDC/Calib/EMDCalib\n");
158     return;
159   }
160   
161
162   /*AliTestDataDCS* output = dynamic_cast<AliTestDataDCS*> (chkEntry1->GetObject());
163   // If everything went fine, draw the result
164   if (output)
165     output->Draw();*/
166 }
167
168 TMap* CreateDCSAliasMap()
169 {
170   // Creates a DCS structure
171   // The structure is the following:
172   //   TMap (key --> value)
173   //     <DCSAlias> --> <valueList>
174   //     <DCSAlias> is a string
175   //     <valueList> is a TObjArray of AliDCSValue
176   //     An AliDCSValue consists of timestamp and a value in form of a AliSimpleValue
177
178   // In this example 6 aliases exists: DCSAlias1 ... DCSAlias6
179   // Each contains 1000 values randomly generated by TRandom::Gaus + 5*nAlias
180
181   TMap* aliasMap = new TMap;
182   aliasMap->SetOwner(1);
183
184   TRandom random;
185   TString aliasNames[28];
186
187   // ******************************** alignment values
188   aliasNames[0] = "ZDC_ZNA_POS.actual.position";
189   aliasNames[1] = "ZDC_ZPA_POS.actual.position";
190   aliasNames[2] = "ZDC_ZNC_POS.actual.position";
191   aliasNames[3] = "ZDC_ZPC_POS.actual.position";
192   //
193   for(int nAlias=0; nAlias<4; nAlias++)
194   {
195     TObjArray* valueSet = new TObjArray;
196     valueSet->SetOwner(1);
197
198     TString aliasName = aliasNames[nAlias];
199     printf("\n\n alias: %s\n\n",aliasName.Data());
200
201     Float_t simVal = (Float_t) (random.Rndm()*0.025+random.Rndm()*0.1);
202     for(int i=0;i<3;i++)
203     {
204       int timeStamp1[3] = {0,500,1000};
205       AliDCSValue* dcsVal = new AliDCSValue(simVal, timeStamp1[i]);
206       printf("%s\n",dcsVal->ToString());
207       valueSet->Add(dcsVal);
208     }
209     aliasMap->Add(new TObjString(aliasName), valueSet);
210   }
211   // ******************************** HV values
212   aliasNames[4]  = "ZDC_ZNA_HV0.actual.vMon";
213   aliasNames[5]  = "ZDC_ZNA_HV1.actual.vMon";
214   aliasNames[6]  = "ZDC_ZNA_HV2.actual.vMon";
215   aliasNames[7]  = "ZDC_ZNA_HV3.actual.vMon";
216   aliasNames[8]  = "ZDC_ZNA_HV4.actual.vMon";
217   //
218   aliasNames[9]   = "ZDC_ZPA_HV0.actual.vMon";
219   aliasNames[10]  = "ZDC_ZPA_HV1.actual.vMon";
220   aliasNames[11]  = "ZDC_ZPA_HV2.actual.vMon";
221   aliasNames[12]  = "ZDC_ZPA_HV3.actual.vMon";
222   aliasNames[13]  = "ZDC_ZPA_HV4.actual.vMon";
223   //
224   aliasNames[14]  = "ZDC_ZNC_HV0.actual.vMon";
225   aliasNames[15]  = "ZDC_ZNC_HV1.actual.vMon";
226   aliasNames[16]  = "ZDC_ZNC_HV2.actual.vMon";
227   aliasNames[17]  = "ZDC_ZNC_HV3.actual.vMon";
228   aliasNames[18]  = "ZDC_ZNC_HV4.actual.vMon";
229   //
230   aliasNames[19]  = "ZDC_ZPC_HV0.actual.vMon";
231   aliasNames[20]  = "ZDC_ZPC_HV1.actual.vMon";
232   aliasNames[21]  = "ZDC_ZPC_HV2.actual.vMon";
233   aliasNames[22]  = "ZDC_ZPC_HV3.actual.vMon";
234   aliasNames[23]  = "ZDC_ZPC_HV4.actual.vMon";
235   //
236   aliasNames[24]  = "ZDC_ZEM_HV0.actual.vMon";
237   aliasNames[25]  = "ZDC_ZEM_HV1.actual.vMon";
238   //
239   aliasNames[26]  = "ZDC_REFA_HV.actual.vMon";
240   aliasNames[27]  = "ZDC_REFC_HV.actual.vMon";
241   //
242   for(int nAlias=4;nAlias<28;nAlias++)
243   {
244     TObjArray* valueSet = new TObjArray;
245     valueSet->SetOwner(1);
246    
247     TString aliasName = aliasNames[nAlias];
248     printf("\n\n alias: %s\n\n",aliasName.Data());
249
250     for(int timeStamp=0;timeStamp<=1000;timeStamp+=500)
251     {
252       Float_t simVal = (Float_t) (random.Gaus()*600.+1800.);
253       AliDCSValue* dcsVal = new AliDCSValue(simVal, timeStamp);
254       printf("%s\n",dcsVal->ToString());
255       valueSet->Add(dcsVal);
256     }
257     aliasMap->Add(new TObjString(aliasName), valueSet);
258   }
259
260   return aliasMap;
261 }
262
263 TMap* ReadDCSAliasMap()
264 {
265   // Open a file that contains DCS input data
266   // The CDB framework is used to open the file, this means the file is located
267   // in $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/DCS/Data
268   // The file contains an AliCDBEntry that contains a TMap with the DCS structure.
269   // An explanation of the structure can be found in CreateDCSAliasMap()
270
271   AliCDBEntry *entry = AliCDBManager::Instance()->Get("ZDC/DCS/Data", 0);
272   return dynamic_cast<TMap*> (entry->GetObject());
273 }
274
275 void WriteDCSAliasMap()
276 {
277   // This writes the output from CreateDCSAliasMap to a CDB file
278
279   TMap* dcsAliasMap = CreateDCSAliasMap();
280
281   AliCDBMetaData metaData;
282         metaData.SetBeamPeriod(0);
283         metaData.SetResponsible("Chiara Oppedisano");
284         metaData.SetComment("Test object for TestZDCPreprocessor.C");
285
286   AliCDBId id("ZDC/DCS/Data", 0, 0);
287
288   // initialize location of CDB
289   AliCDBManager::Instance()->SetDefaultStorage("local://$ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB");
290
291   AliCDBManager::Instance()->Put(dcsAliasMap, id, &metaData);
292 }