SHUTTLE/TestShuttle/TestPreprocessor.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 TestPreprocessor()
  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/OCDB/SHUTTLE/TestShuttle/TestCDB");
  23   AliTestShuttle::SetMainRefStorage("local://$ALICE_ROOT/OCDB/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
  46   // now give the alias map to the shuttle
  47   shuttle->SetDCSInput(dcsAliasMap);
  48
  49   // TODO(2)
  50   //
  51   // The shuttle can also process files that originate from DCS, DAQ and HLT.
  52   // To test it, we provide some local files and locations where these would be found when
  53   // the online machinery would be there.
  54   // In real life this functions would be produces by the sub-detectors
  55   // calibration programs in DCS, DAQ or HLT. These files can then be retrieved using the Shuttle.
  56   //
  57   // Files are added with the function AliTestShuttle::AddInputFile. The syntax is:
  58   // AddInputFile(<system>, <detector>, <id>, <source>, <local-file>)
  59   // In this example we add a file originating from the GDC with the id PEDESTALS
  60   // Three files originating from different LDCs but with the same id are also added
  61   // Note that the test preprocessor name is TPC. The name of the detector's preprocessor must follow
  62   // the "online" naming convention ALICE-INT-2003-039.
  63   shuttle->AddInputFile(AliShuttleInterface::kDAQ, "TPC", "PEDESTALS", "GDC0", "file1.root");
  64   shuttle->AddInputFile(AliShuttleInterface::kDAQ, "TPC", "DRIFTVELOCITY", "LDC0", "file2a.root");
  65   shuttle->AddInputFile(AliShuttleInterface::kDAQ, "TPC", "DRIFTVELOCITY", "LDC1", "file2b.root");
  66   shuttle->AddInputFile(AliShuttleInterface::kDAQ, "TPC", "DRIFTVELOCITY", "LDC2", "file2c.root");
  67   shuttle->AddInputFile(AliShuttleInterface::kHLT, "TPC", "HLTData", "source1", "hlt_file1.root");
  68   shuttle->AddInputFile(AliShuttleInterface::kHLT, "TPC", "HLTData", "source2", "hlt_file2.root");
  69
  70   // TODO(3)
  71   //
  72   // The shuttle can read run type stored in the DAQ logbook.
  73   // To test it, we must provide the run type manually. They will be retrieved in the preprocessor
  74   // using GetRunType function.
  75   shuttle->SetInputRunType("PHYSICS");
  76
  77   // TODO(4)
  78   //
  79   // The shuttle can read run parameters stored in the DAQ run logbook.
  80   // To test it, we must provide the run parameters manually. They will be retrieved in the preprocessor
  81   // using GetRunParameter function.
  82   shuttle->AddInputRunParameter("totalEvents", "30000");
  83   shuttle->AddInputRunParameter("NumberOfGDCs", "15");
  84
  85   // TODO(5)
  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
  93   Bool_t hltStatus=kTRUE;
  94   shuttle->SetInputHLTStatus(hltStatus);
  95
  96
  97   // TODO(6)
  98   // Create the preprocessor that should be tested, it registers itself automatically to the shuttle
  99   AliPreprocessor* test = new AliTestPreprocessor(shuttle);
 100
 101   // Test the preprocessor
 102   shuttle->Process();
 103
 104   // TODO(7)
 105   // In the preprocessor AliShuttleInterface::Store should be called to put the final
 106   // data to the CDB. To check if all went fine have a look at the files produced in
 107   // $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/SHUTTLE/Data
 108   //
 109   // Check the file which should have been created
 110   AliCDBEntry* chkEntry = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
 111                         ->Get("TPC/Calib/Data", 7);
 112   if (!chkEntry)
 113   {
 114     printf("The file is not there. Something went wrong.\n");
 115     return;
 116   }
 117
 118   AliTestDataDCS* output = dynamic_cast<AliTestDataDCS*> (chkEntry->GetObject());
 119   // If everything went fine, draw the result
 120   if (output)
 121     output->Draw();
 122 }
 123
 124 TMap* CreateDCSAliasMap()
 125 {
 126   // Creates a DCS structure
 127   // The structure is the following:
 128   //   TMap (key --> value)
 129   //     <DCSAlias> --> <valueList>
 130   //     <DCSAlias> is a string
 131   //     <valueList> is a TObjArray of AliDCSValue
 132   //     An AliDCSValue consists of timestamp and a value in form of a AliSimpleValue
 133
 134   // In this example 6 aliases exists: DCSAlias1 ... DCSAlias6
 135   // Each contains 1000 values randomly generated by TRandom::Gaus + 5*nAlias
 136
 137   TMap* aliasMap = new TMap;
 138   aliasMap->SetOwner(1);
 139
 140   TRandom random;
 141
 142   for(int nAlias=0;nAlias<6;nAlias++)
 143   {
 144     TObjArray* valueSet = new TObjArray;
 145     valueSet->SetOwner(1);
 146
 147     TString aliasName="DCSAlias";
 148     aliasName += nAlias;
 149     //printf("\n\n alias: %s\n\n",aliasName.Data());
 150
 151     for (int timeStamp=0;timeStamp<1000;timeStamp+=10)
 152     {
 153       AliDCSValue* dcsVal = new AliDCSValue((Float_t) (random.Gaus()+5*nAlias), timeStamp);
 154       //printf("%s\n",dcsVal->ToString().Data());
 155       valueSet->Add(dcsVal);
 156     }
 157     aliasMap->Add(new TObjString(aliasName), valueSet);
 158   }
 159
 160   return aliasMap;
 161 }
 162
 163 TMap* ReadDCSAliasMap()
 164 {
 165   // Open a file that contains DCS input data
 166   // The CDB framework is used to open the file, this means the file is located
 167   // in $ALICE_ROOT/SHUTTLE/TestShuttle/TestCDB/<detector>/DCS/Data
 168   // The file contains an AliCDBEntry that contains a TMap with the DCS structure.
 169   // An explanation of the structure can be found in CreateDCSAliasMap()
 170
 171   AliCDBEntry *entry = AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
 172                         ->Get("DET/DCS/Data", 0);
 173   return dynamic_cast<TMap*> (entry->GetObject());
 174 }
 175
 176 void WriteDCSAliasMap()
 177 {
 178   // This writes the output from CreateDCSAliasMap to a CDB file
 179
 180   TMap* dcsAliasMap = CreateDCSAliasMap();
 181
 182   AliCDBMetaData metaData;
 183         metaData.SetBeamPeriod(0);
 184         metaData.SetResponsible("Responsible person");
 185         metaData.SetComment("Test object for TestPreprocessor.C");
 186
 187   AliCDBId id("DET/DCS/Data", 0, 0);
 188
 189   // look into AliTestShuttle's CDB main folder
 190
 191   AliCDBManager::Instance()->GetStorage(AliShuttleInterface::GetMainCDB())
 192                         ->Put(dcsAliasMap, id, &metaData);
 193 }