STEER/AliCentralTrigger.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   7  * Permission to use, copy, modify and distribute this software and its   *
   8  * documentation strictly for non-commercial purposes is hereby granted   *
   9  * without fee, provided that the above copyright notice appears in all   *
  10  * copies and that both the copyright notice and this permission notice   *
  11  * appear in the supporting documentation. The authors make no claims     *
  12  * about the suitability of this software for any purpose. It is          *
  13  * provided "as is" without express or implied warranty.                  *
  14  **************************************************************************/
  15
  16 /* $Id$ */
  17
  18 ///////////////////////////////////////////////////////////////////////////////
  19 //                                                                           //
  20 // This class for running the Central Trigger Processor                      //
  21 //                                                                           //
  22 //                                                                           //
  23 //    Load Configuration                                                     //
  24 //    Make a list the trigger detectors involved (from the classes)          //
  25 //    For the each event                                                     //
  26 //           Run the Trigger for the each detector                           //
  27 //           Get the inputs                                                  //
  28 //           Check the trigger classes                                       //
  29 //           Create the class mask                                           //
  30 //           Save result                                                     //
  31 //                                                                           //
  32 //                                                                           //
  33 ///////////////////////////////////////////////////////////////////////////////
  34
  35 #include <TString.h>
  36 #include <TObjString.h>
  37 #include <TObjArray.h>
  38 #include <TStopwatch.h>
  39 #include <TFile.h>
  40 #include <TTree.h>
  41
  42 #include "AliLog.h"
  43 #include "AliRun.h"
  44 #include "AliRunLoader.h"
  45 #include "AliModule.h"
  46
  47 #include "AliTriggerInput.h"
  48 #include "AliTriggerDetector.h"
  49 #include "AliTriggerConfiguration.h"
  50 #include "AliTriggerClass.h"
  51 #include "AliTriggerCluster.h"
  52 #include "AliCentralTrigger.h"
  53 #include "AliDetectorEventHeader.h"
  54 #include "AliHeader.h"
  55
  56 #include "AliCDBManager.h"
  57 #include "AliCDBPath.h"
  58 #include "AliCDBEntry.h"
  59
  60 ClassImp( AliCentralTrigger )
  61
  62 //_____________________________________________________________________________
  63 AliCentralTrigger::AliCentralTrigger() :
  64    TObject(),
  65    fClassMask(0),
  66    fClusterMask(0),
  67    fL0TriggerInputs(0),
  68    fL1TriggerInputs(0),
  69    fL2TriggerInputs(0),
  70    fConfiguration(NULL)
  71 {
  72    // Default constructor
  73   SetOwner();
  74 }
  75
  76 //_____________________________________________________________________________
  77 AliCentralTrigger::AliCentralTrigger( TString & config ) :
  78    TObject(),
  79    fClassMask(0),
  80    fClusterMask(0),
  81    fL0TriggerInputs(0),
  82    fL1TriggerInputs(0),
  83    fL2TriggerInputs(0),
  84    fConfiguration(NULL)
  85 {
  86    // Default constructor
  87    LoadConfiguration( config );
  88 }
  89
  90 //_____________________________________________________________________________
  91 AliCentralTrigger::~AliCentralTrigger()
  92 {
  93   // Destructor
  94   DeleteConfiguration();
  95 }
  96
  97 //_____________________________________________________________________________
  98 void AliCentralTrigger::DeleteConfiguration()
  99 {
 100   // Delete the active configuration
 101   fClassMask = 0;
 102   fClusterMask = 0;
 103   fL0TriggerInputs = 0;
 104   fL1TriggerInputs = 0;
 105   fL2TriggerInputs = 0;
 106   if (fConfiguration) {
 107     if (IsOwner()) delete fConfiguration;
 108     fConfiguration = 0x0;
 109   }
 110 }
 111
 112 //_____________________________________________________________________________
 113 void AliCentralTrigger::Reset()
 114 {
 115    // Reset Class Mask and classes
 116    fClassMask = 0;
 117    fClusterMask = 0;
 118    fL0TriggerInputs = 0;
 119    fL1TriggerInputs = 0;
 120    fL2TriggerInputs = 0;
 121
 122    if (fConfiguration) {
 123      const TObjArray& classesArray = fConfiguration->GetClasses();
 124      Int_t nclasses = classesArray.GetEntriesFast();
 125      for( Int_t j=0; j<nclasses; j++ ) {
 126        AliTriggerClass* trclass = (AliTriggerClass*)classesArray.At( j );
 127        trclass->Reset();
 128      }
 129    }
 130 }
 131
 132 //_____________________________________________________________________________
 133 void AliCentralTrigger::MakeBranch( TString name, TTree * tree )
 134 {
 135    // Make a branch to store only trigger class mask event by event
 136
 137    if( tree )  {
 138       AliDebug( 1, "Got Tree from folder." );
 139       TBranch* branch = tree->GetBranch( name );
 140       if( branch == 0x0 ) {
 141          AliDebug( 1, "Creating new branch" );
 142          branch = tree->Branch( name, &(this->fClassMask), "fClassMask/l:fClusterMask/i:fL0TriggerInputs/i:fL1TriggerInputs/i:fL2TriggerInputs/s" );
 143          branch->SetAutoDelete( kFALSE );
 144       }
 145       else {
 146          AliDebug( 1, "Got Branch from Tree" );
 147          branch->SetAddress( &(this->fClassMask) );
 148       }
 149    }
 150 }
 151
 152 //_____________________________________________________________________________
 153 Bool_t AliCentralTrigger::LoadConfiguration( TString & config )
 154 {
 155    // Load one and only one pre-created COnfiguration from database/file that match
 156    // with the input string 'config'
 157    // Ej: "p-p", "Pb-Pb" or "p-p-DIMUON CALIBRATION-CENTRAL-BARREL"
 158
 159    // Delete the active configuration, if any
 160   DeleteConfiguration();
 161
 162    // Load the selected configuration
 163    if (!config.IsNull()) {
 164      fConfiguration = AliTriggerConfiguration::LoadConfiguration( config );
 165      SetOwner();
 166      if(fConfiguration)
 167        return kTRUE;
 168      else {
 169        AliError( Form( "Valid TriggerConfiguration (%s) is not found ! Disabling the trigger simulation !", config.Data() ) );
 170        return kFALSE;
 171      }
 172    }
 173    else {
 174      // Load one and only one trigger descriptor from CDB
 175      AliInfo( "Getting trigger configuration from OCDB!" );
 176
 177      AliCDBPath path( "GRP", "CTP", "Config" );
 178
 179      AliCDBEntry *entry=AliCDBManager::Instance()->Get(path.GetPath());
 180      SetOwner(kFALSE);
 181      if( !entry ) AliFatal( "Couldn't load trigger description data from CDB!" );
 182
 183      fConfiguration = (AliTriggerConfiguration *)entry->GetObject();
 184      if(fConfiguration)
 185        return kTRUE;
 186      else {
 187        AliError( "No valid configuration is found in the CDB ! Disabling the trigger simulation !" );
 188        return kFALSE;
 189      }
 190    }
 191 }
 192
 193 //_____________________________________________________________________________
 194 TString AliCentralTrigger::GetDetectors()
 195 {
 196    // return TString with the detectors (modules) to be used for triggering
 197
 198    TString result;
 199
 200    if (fConfiguration)
 201      result = fConfiguration->GetTriggeringModules();
 202
 203    return result;
 204 }
 205
 206 //_____________________________________________________________________________
 207 Bool_t AliCentralTrigger::RunTrigger( AliRunLoader* runLoader, const char *detectors )
 208 {
 209    // run the trigger
 210
 211    if( !fConfiguration ) {
 212       AliError( "No trigger configuration loaded, skipping trigger" );
 213       return kFALSE;
 214    }
 215
 216    TTree *tree = runLoader->TreeCT();
 217    if( !tree ) {
 218       AliError( "No folder with trigger loaded, skipping trigger" );
 219       return kFALSE;
 220    }
 221
 222    TStopwatch stopwatch;
 223    stopwatch.Start();
 224
 225    AliInfo( Form(" Triggering Detectors: %s \n", GetDetectors().Data() ) );
 226    AliInfo( Form(" Detectors with digits: %s \n", detectors ) );
 227
 228    // Process each event
 229    for( Int_t iEvent = 0; iEvent < runLoader->GetNumberOfEvents(); iEvent++ ) {
 230       AliInfo( Form("Processing event %d", iEvent) );
 231       runLoader->GetEvent( iEvent );
 232       // Get detectors involve
 233       TString detStr = GetDetectors();
 234       TString detWithDigits = detectors;
 235       TObjArray* detArray = runLoader->GetAliRun()->Detectors();
 236       // Reset Mask
 237       fClassMask = 0;
 238       fClusterMask = 0;
 239       // Reset configuration object (inputs and classes)
 240       fConfiguration->Reset();
 241       TObjArray trgdetArray; // use as garbage collector
 242       for( Int_t iDet = 0; iDet < detArray->GetEntriesFast(); iDet++ ) {
 243          AliModule* det = (AliModule*) detArray->At( iDet );
 244          if( !det || !det->IsActive() ) continue;
 245          if( IsSelected(det->GetName(), detStr) &&
 246              IsSelected(det->GetName(), detWithDigits) ) {
 247
 248             AliDebug(1,Form("Triggering from digits for %s", det->GetName() ) );
 249             AliTriggerDetector* trgdet = det->CreateTriggerDetector();
 250             trgdet->AssignInputs(fConfiguration->GetInputs());
 251             TStopwatch stopwatchDet;
 252             stopwatchDet.Start();
 253             trgdet->Trigger();
 254             AliDebug(1, Form("Execution time for %s: R:%.2fs C:%.2fs",
 255                      det->GetName(), stopwatchDet.RealTime(), stopwatchDet.CpuTime() ) );
 256
 257             trgdetArray.AddLast( trgdet );
 258
 259             // Write trigger detector in Event folder in Digits file
 260             TString loadername = det->GetName();
 261             loadername.Append( "Loader" );
 262             AliLoader * loader = runLoader->GetLoader( loadername );
 263             if( loader ) {
 264                AliDataLoader * dataLoader = loader->GetDigitsDataLoader();
 265                if( !dataLoader->IsFileOpen() ) {
 266                   if( dataLoader->OpenFile( "UPDATE" ) ) {
 267                      AliWarning( Form( "\n\nCan't write trigger for %s\n", det->GetName() ) );
 268                   }
 269                }
 270                dataLoader->Cd();
 271                if( gFile && !gFile->IsWritable() ) {
 272                   gFile->ReOpen( "UPDATE" );
 273                   dataLoader->Cd();
 274                }
 275                trgdet->Write( "Trigger", TObject::kOverwrite );
 276                dataLoader->CloseFile();
 277             }
 278             else  AliWarning( Form( "Not loader found for %s", det->GetName() ) );
 279          }
 280       }
 281
 282       // Check trigger conditions and create the trigger class mask
 283       TriggerClasses();
 284       // Calculate trigger Input pattern
 285       TriggerInputs();
 286
 287       // Clear trigger detectors
 288       trgdetArray.SetOwner();
 289       trgdetArray.Delete();
 290
 291       if( (detStr.CompareTo( "ALL" ) != 0) && !detStr.IsNull() ) {
 292          AliError( Form("the following detectors were not found: %s",
 293                    detStr.Data()));
 294          //JF return kFALSE;
 295       }
 296
 297       // Save trigger mask
 298       tree->Fill();
 299       AliInfo( Form("Trigger Class Mask:0x%X", fClassMask ) );
 300    } // end event loop
 301
 302    Reset();
 303 //   cout << endl <<  " Print " << endl;
 304 //   Print();
 305
 306    // Write
 307    runLoader->WriteTrigger( "OVERWRITE" );
 308
 309    return kTRUE;
 310 }
 311 //----------------------------------------------------------------------------
 312 void AliCentralTrigger::TriggerInputs()
 313 {
 314  // Find which inputs are in configuration
 315  // and calculate input pattern
 316  fL0TriggerInputs=0;
 317  fL1TriggerInputs=0;
 318  fL2TriggerInputs=0;
 319  if(fConfiguration){
 320     const TObjArray& inputsArray = fConfiguration->GetInputs();
 321     Int_t ninputs = inputsArray.GetEntriesFast();
 322     for( Int_t j=0; j<ninputs; j++ ) {
 323       AliTriggerInput* input = (AliTriggerInput*)inputsArray.At( j );
 324       if(input->GetValue()){
 325        UChar_t level=input->GetLevel();
 326             if(level == 0) fL0TriggerInputs |= (input->GetMask());
 327        else if(level == 1) fL1TriggerInputs |= (input->GetMask());
 328        else if(level == 2) fL2TriggerInputs |= (input->GetMask());
 329        else{
 330          AliError(Form("Unknown input level:%c:",level));
 331        }
 332       }
 333     }
 334  }
 335 }
 336 //_____________________________________________________________________________
 337 ULong64_t AliCentralTrigger::TriggerClasses()
 338 {
 339   // Check trigger conditions and create the trigger class
 340   // and trigger cluster masks
 341   fClassMask = 0;
 342   fClusterMask = 0;
 343   if (fConfiguration) {
 344     const TObjArray& classesArray = fConfiguration->GetClasses();
 345     Int_t nclasses = classesArray.GetEntriesFast();
 346     for( Int_t j=0; j<nclasses; j++ ) {
 347       AliTriggerClass* trclass = (AliTriggerClass*)classesArray.At( j );
 348       trclass->Trigger( fConfiguration->GetInputs(), fConfiguration->GetFunctions() );
 349       fClassMask |= trclass->GetValue();
 350       if (trclass->GetStatus()) {
 351         AliTriggerCluster *trclust = trclass->GetCluster();
 352         fClusterMask |= AliDAQ::DetectorPattern(trclust->GetDetectorsInCluster());
 353       }
 354     }
 355   }
 356   return fClassMask;
 357 }
 358 //_____________________________________________________________________________
 359 TObjArray* AliCentralTrigger::GetFiredClasses() const
 360 {
 361    // return only the true conditions
 362
 363    TObjArray* result = new TObjArray();
 364
 365    if (fConfiguration) {
 366      const TObjArray& classesArray = fConfiguration->GetClasses();
 367      Int_t nclasses = classesArray.GetEntriesFast();
 368      for( Int_t j=0; j<nclasses; j++ ) {
 369        AliTriggerClass* trclass = (AliTriggerClass*)classesArray.At( j );
 370        if( trclass->GetStatus() ) result->AddLast( trclass );
 371      }
 372    }
 373
 374    return result;
 375 }
 376
 377 //_____________________________________________________________________________
 378 void AliCentralTrigger::Print( const Option_t*  ) const
 379 {
 380    // Print
 381    cout << "Central Trigger: " << endl;
 382    cout << "  Trigger Class Mask: 0x" << hex << fClassMask << dec << endl;
 383    if (fConfiguration) fConfiguration->Print();
 384    cout << endl;
 385 }
 386
 387
 388 //////////////////////////////////////////////////////////////////////////////
 389 // Helper method
 390
 391 //_____________________________________________________________________________
 392 Bool_t AliCentralTrigger::IsSelected( TString detName, TString& detectors ) const
 393 {
 394    // check whether detName is contained in detectors
 395    // if yes, it is removed from detectors
 396
 397    // check if all detectors are selected
 398    if( (detectors.CompareTo("ALL") == 0 ) ||
 399         detectors.BeginsWith("ALL ") ||
 400         detectors.EndsWith(" ALL") ||
 401         detectors.Contains(" ALL ") ) {
 402       detectors = "ALL";
 403       return kTRUE;
 404    }
 405
 406    // search for the given detector
 407    Bool_t result = kFALSE;
 408    if( (detectors.CompareTo( detName ) == 0) ||
 409         detectors.BeginsWith( detName+" " ) ||
 410         detectors.EndsWith( " "+detName ) ||
 411         detectors.Contains( " "+detName+" " ) ) {
 412       detectors.ReplaceAll( detName, "" );
 413       result = kTRUE;
 414    }
 415
 416    // clean up the detectors string
 417    while( detectors.Contains("  ") )  detectors.ReplaceAll( "  ", " " );
 418    while( detectors.BeginsWith(" ") ) detectors.Remove( 0, 1 );
 419    while( detectors.EndsWith(" ") )   detectors.Remove( detectors.Length()-1, 1 );
 420
 421    return result;
 422 }
 423
 424 //_____________________________________________________________________________
 425 Bool_t AliCentralTrigger::CheckTriggeredDetectors() const
 426 {
 427   // Check the trigger mask, finds which trigger classes
 428   // have been fired, load the corresponding trigger clusters and
 429   // finally makes a list of the detectors that have been readout
 430   // for each particular event. This list is then compared to the
 431   // one stored in fClusterMask. Return value:
 432   // true = two lists are equal
 433   // false = two lists are not equal meaning wrong trigger config
 434   // is loaded.
 435
 436   if (!fConfiguration) {
 437     AliError("The trigger confiration has not yet been loaded! Cross-check is not possible!");
 438     return kFALSE;
 439   }
 440   else {
 441
 442     // Make a cross-check so that to exclude wrong trigger configuration used
 443     // Loop over the trigger classes
 444     UInt_t clusterMask = 0;
 445     const TObjArray& classesArray = fConfiguration->GetClasses();
 446     Int_t nclasses = classesArray.GetEntriesFast();
 447     for( Int_t j=0; j<nclasses; j++ ) {
 448       AliTriggerClass* trclass = (AliTriggerClass*)classesArray.At( j );
 449       if (trclass->GetMask() & fClassMask) { // class was fired
 450         AliTriggerCluster *trclust = trclass->GetCluster();
 451         clusterMask |= AliDAQ::DetectorPattern(trclust->GetDetectorsInCluster());
 452       }
 453     }
 454     // Compare the stored cluster mask with the one
 455     // that we get from trigger classes
 456     if (clusterMask != fClusterMask) {
 457       if ((clusterMask & fClusterMask) == clusterMask) {
 458         AliInfo(Form("Cluster mask from trigger classes (%x) and from data (%x) differ. Concurrent DAQ run(s) could be the reason.",
 459                      (UInt_t)clusterMask,(UInt_t)fClusterMask));
 460         return kTRUE;
 461       }
 462       else {
 463         AliError(Form("Wrong cluster mask from trigger classes (%x), expecting (%x)! Loaded trigger configuration is possibly wrong!",
 464                       (UInt_t)clusterMask,(UInt_t)fClusterMask));
 465         return kFALSE;
 466       }
 467     }
 468   }
 469
 470   return kTRUE;
 471 }