Updated test macro for ZDC Shuttle preprocessor
[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()
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(7, 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   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "PEDESTALS", "LDC0", "ZDCPedestal.dat");
65   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "EMDCALIB",  "LDC0", "ZDCEMDCalib.dat");
66   shuttle->AddInputFile(AliTestShuttle::kDAQ, "ZDC", "EMDCALIB",  "LDC0", "ZDCEMDEqual.dat");
67
68   // TODO(3)
69   //
70   // The shuttle can read run type stored in the DAQ logbook.
71   // To test it, we must provide the run type manually. They will be retrieved in the preprocessor
72   // using GetRunType function.
73 //  shuttle->SetInputRunType("PEDESTALS");
74   shuttle->SetInputRunType("PULSER_RUN");
75
76   // TODO(4)
77   //
78   // The shuttle can read run parameters stored in the DAQ run logbook.
79   // To test it, we must provide the run parameters manually. They will be retrieved in the preprocessor
80   // using GetRunParameter function.
81   // In real life the parameters will be retrieved automatically from the run logbook;
82   shuttle->AddInputRunParameter("totalEvents", "1000");
83   shuttle->AddInputRunParameter("NumberOfGDCs", "1");
84
85   // TODO(5) NEW!
86   //
87   // This is for preprocessor that require data from HLT.
88   // Since HLT may be switched off, the preprocessor should first query the Run logbook where
89   // the HLT status is stored. SHUTTLE implements a shortcut function (GetHLTStatus) that returns
90   // a bool directly. 1 = HLT ON, 0 = HLT OFF
91   //
92   Bool_t hltStatus=kFALSE;
93   //shuttle->SetInputHLTStatus(hltStatus);
94
95   // TODO(6)
96   //
97   // The shuttle can query condition parameters valid from the current run from the OCDB
98   // To test it, we must first store the object into the OCDB. It will be retrieved in the preprocessor
99   // using GetFromOCDB function.
100 /*
101   TObjString obj("This is a condition parameter stored in OCDB");
102   AliCDBId id("ZDC/Calib/Data", 0, AliCDBRunRange::Infinity());
103   AliCDBMetaData md;
104   AliCDBEntry entry(&obj, id, &md);
105
106   shuttle->AddInputCDBEntry(&entry);
107 */
108   // TODO(6)
109   // Create the preprocessor that should be tested, it registers itself automatically to the shuttle
110   AliPreprocessor* test = new AliZDCPreprocessor(shuttle);
111
112   // Test the preprocessor
113   shuttle->Process();
114
115   // TODO(7)
116   // In the preprocessor AliShuttleInterface::Store should be called to put the final
117   // data to the CDB. To check if all went fine have a look at the files produced in
118   // $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/SHUTTLE/Data
119   //
120   // Check the file which should have been created
121   AliCDBEntry* chkEntry = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
122                         ->Get("ZDC/Calib/Data", 7);
123   if (!chkEntry)
124   {
125     printf("The file is not there. Something went wrong.\n");
126     return;
127   }
128
129   AliTestDataDCS* output = dynamic_cast<AliTestDataDCS*> (chkEntry->GetObject());
130   // If everything went fine, draw the result
131   if (output)
132     output->Draw();
133 }
134
135 TMap* CreateDCSAliasMap()
136 {
137   // Creates a DCS structure
138   // The structure is the following:
139   //   TMap (key --> value)
140   //     <DCSAlias> --> <valueList>
141   //     <DCSAlias> is a string
142   //     <valueList> is a TObjArray of AliDCSValue
143   //     An AliDCSValue consists of timestamp and a value in form of a AliSimpleValue
144
145   // In this example 6 aliases exists: DCSAlias1 ... DCSAlias6
146   // Each contains 1000 values randomly generated by TRandom::Gaus + 5*nAlias
147
148   TMap* aliasMap = new TMap;
149   aliasMap->SetOwner(1);
150
151   TRandom random;
152   TString aliasNames[28];
153
154   // ******************************** alignment values
155   aliasNames[0] = "ZDC_ZNA_POS.actual.position";
156   aliasNames[1] = "ZDC_ZPA_POS.actual.position";
157   aliasNames[2] = "ZDC_ZNC_POS.actual.position";
158   aliasNames[3] = "ZDC_ZPC_POS.actual.position";
159   //
160   for(int nAlias=0; nAlias<4; nAlias++)
161   {
162     TObjArray* valueSet = new TObjArray;
163     valueSet->SetOwner(1);
164
165     TString aliasName = aliasNames[nAlias];
166     printf("\n\n alias: %s\n\n",aliasName.Data());
167
168     Float_t simVal = (Float_t) (random.Rndm()*0.025+random.Rndm()*0.1);
169     for(int i=0;i<3;i++)
170     {
171       int timeStamp1[3] = {0,500,1000};
172       AliDCSValue* dcsVal = new AliDCSValue(simVal, timeStamp1[i]);
173       printf("%s\n",dcsVal->ToString());
174       valueSet->Add(dcsVal);
175     }
176     aliasMap->Add(new TObjString(aliasName), valueSet);
177   }
178   // ******************************** HV values
179   /*TString ZNAAlias = "ZNA_HV.actual.vMon";
180   TString ZPAAlias = "ZPA_HV.actual.vMon";
181   TString ZNCAlias = "ZNC_HV.actual.vMon";
182   TString ZPCAlias = "ZPC_HV.actual.vMon";
183   TString idat[5];
184   for(int i=0;i<5;i++)
185   {
186     idat[i] = i;
187     aliasNames[i+3]  = ZNAAlias.Insert(6,idat[i]);
188     aliasNames[i+7]  = ZPAAlias.Insert(6,idat[i]);
189     aliasNames[i+11] = ZNCAlias.Insert(6,idat[i]);
190     aliasNames[i+15] = ZPCAlias.Insert(6,idat[i]);
191   }*/
192   aliasNames[4]  = "ZDC_ZNA_HV0.actual.vMon";
193   aliasNames[5]  = "ZDC_ZNA_HV1.actual.vMon";
194   aliasNames[6]  = "ZDC_ZNA_HV2.actual.vMon";
195   aliasNames[7]  = "ZDC_ZNA_HV3.actual.vMon";
196   aliasNames[8]  = "ZDC_ZNA_HV4.actual.vMon";
197   //
198   aliasNames[9]   = "ZDC_ZPA_HV0.actual.vMon";
199   aliasNames[10]  = "ZDC_ZPA_HV1.actual.vMon";
200   aliasNames[11]  = "ZDC_ZPA_HV2.actual.vMon";
201   aliasNames[12]  = "ZDC_ZPA_HV3.actual.vMon";
202   aliasNames[13]  = "ZDC_ZPA_HV4.actual.vMon";
203   //
204   aliasNames[14]  = "ZDC_ZNC_HV0.actual.vMon";
205   aliasNames[15]  = "ZDC_ZNC_HV1.actual.vMon";
206   aliasNames[16]  = "ZDC_ZNC_HV2.actual.vMon";
207   aliasNames[17]  = "ZDC_ZNC_HV3.actual.vMon";
208   aliasNames[18]  = "ZDC_ZNC_HV4.actual.vMon";
209   //
210   aliasNames[19]  = "ZDC_ZPC_HV0.actual.vMon";
211   aliasNames[20]  = "ZDC_ZPC_HV1.actual.vMon";
212   aliasNames[21]  = "ZDC_ZPC_HV2.actual.vMon";
213   aliasNames[22]  = "ZDC_ZPC_HV3.actual.vMon";
214   aliasNames[23]  = "ZDC_ZPC_HV4.actual.vMon";
215   //
216   aliasNames[24]  = "ZDC_ZEM_HV0.actual.vMon";
217   aliasNames[25]  = "ZDC_ZEM_HV1.actual.vMon";
218   //
219   aliasNames[26]  = "ZDC_REFA_HV0.actual.vMon";
220   aliasNames[27]  = "ZDC_REFC_HV1.actual.vMon";
221   //
222   for(int nAlias=4;nAlias<28;nAlias++)
223   {
224     TObjArray* valueSet = new TObjArray;
225     valueSet->SetOwner(1);
226    
227     TString aliasName = aliasNames[nAlias];
228     printf("\n\n alias: %s\n\n",aliasName.Data());
229
230     for(int timeStamp=0;timeStamp<=1000;timeStamp+=500)
231     {
232       Float_t simVal = (Float_t) (random.Gaus()*600.+1800.);
233       AliDCSValue* dcsVal = new AliDCSValue(simVal, timeStamp);
234       printf("%s\n",dcsVal->ToString());
235       valueSet->Add(dcsVal);
236     }
237     aliasMap->Add(new TObjString(aliasName), valueSet);
238   }
239
240   return aliasMap;
241 }
242
243 TMap* ReadDCSAliasMap()
244 {
245   // Open a file that contains DCS input data
246   // The CDB framework is used to open the file, this means the file is located
247   // in $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/DCS/Data
248   // The file contains an AliCDBEntry that contains a TMap with the DCS structure.
249   // An explanation of the structure can be found in CreateDCSAliasMap()
250
251   AliCDBEntry *entry = AliCDBManager::Instance()->Get("ZDC/DCS/Data", 0);
252   return dynamic_cast<TMap*> (entry->GetObject());
253 }
254
255 void WriteDCSAliasMap()
256 {
257   // This writes the output from CreateDCSAliasMap to a CDB file
258
259   TMap* dcsAliasMap = CreateDCSAliasMap();
260
261   AliCDBMetaData metaData;
262         metaData.SetBeamPeriod(0);
263         metaData.SetResponsible("Responsible person");
264         metaData.SetComment("Test object for TestPreprocessor.C");
265
266   AliCDBId id("ZDC/DCS/Data", 0, 0);
267
268   // initialize location of CDB
269   AliCDBManager::Instance()->SetDefaultStorage("local://$ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB");
270
271   AliCDBManager::Instance()->Put(dcsAliasMap, id, &metaData);
272 }