MUON/AliMUONDigitMaker.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 /// \class AliMUONDigitMaker
  20 /// MUON Digit maker from rawdata.
  21 ///
  22 /// Raw2Digits:
  23 /// Using real mapping  for tracker
  24 /// Indranil Das (Adapted for runloader: Ch. Finck) july 05
  25 ///
  26 /// Implemented non-constant buspatch numbers for tracking
  27 /// with correct DDL id.
  28 /// (Ch. Finck, dec 05)
  29 ///
  30 /// Add reader for scaler trigger events
  31 /// Use memcpy instead of assignment elt by elt
  32 /// (Ch. Finck, Jan 06)
  33 ///
  34 /// Using new interface with AliMUONRawStreamTracker(Trigger)
  35 /// (New interface of AliMUONRawReader class)
  36 /// (further details could be found in Alice-note)
  37 /// (Ch. Finck, March 06)
  38 ///
  39 /// Add (S)Digit maker tracker (for free)
  40 /// and for trigger. Create trigger inverse mapping.
  41 ///
  42 /// \author Ch. Finck, oct 06
  43 //-----------------------------------------------------------------------------
  44
  45 #include "AliMUONDigitMaker.h"
  46
  47 #include "AliMUONDDLTrigger.h"
  48 #include "AliMUONDarcHeader.h"
  49 #include "AliMUONVDigit.h"
  50 #include "AliMUONVDigitStore.h"
  51 #include "AliMUONGlobalTrigger.h"
  52 #include "AliMUONLocalStruct.h"
  53 #include "AliMUONLocalTrigger.h"
  54 #include "AliMUONLogger.h"
  55 #include "AliMUONRawStreamTracker.h"
  56 #include "AliMUONRawStreamTrackerHP.h"
  57 #include "AliMUONRawStreamTrigger.h"
  58 #include "AliMUONRawStreamTriggerHP.h"
  59 #include "AliMUONRegHeader.h"
  60 #include "AliMUONTriggerCircuit.h"
  61 #include "AliMUONVTriggerStore.h"
  62 #include "AliMpDetElement.h"
  63 #include "AliMpTriggerCrate.h"
  64 #include "AliMpLocalBoard.h"
  65 #include "AliMpCathodType.h"
  66 #include "AliMpDDLStore.h"
  67 #include "AliMpDEManager.h"
  68 #include "AliMpPad.h"
  69 #include "AliMpSegmentation.h"
  70 #include "AliMpVSegmentation.h"
  71 #include "AliCodeTimer.h"
  72 #include "AliLog.h"
  73 #include "AliRawReader.h"
  74 #include <TArrayS.h>
  75
  76 /// \cond CLASSIMP
  77 ClassImp(AliMUONDigitMaker) // Class implementation in ROOT context
  78 /// \endcond
  79
  80 //__________________________________________________________________________
  81 AliMUONDigitMaker::AliMUONDigitMaker(
  82       Bool_t enableErrorLogger,
  83       Bool_t useFastTrackerDecoder, Bool_t useFastTriggerDecoder
  84   ) :
  85     TObject(),
  86     fScalerEvent(kFALSE),
  87     fMakeTriggerDigits(kFALSE),
  88     fRawStreamTracker(NULL),
  89     fRawStreamTrigger(NULL),
  90     fDigitStore(0x0),
  91     fTriggerStore(0x0),
  92   fLogger(new AliMUONLogger(10000))
  93 {
  94   /// ctor
  95
  96   AliDebug(1,"");
  97
  98   CreateRawStreamTracker(useFastTrackerDecoder);
  99   CreateRawStreamTrigger(useFastTriggerDecoder);
 100
 101   // Standard Constructor
 102   if (enableErrorLogger) {
 103     fRawStreamTracker->EnabbleErrorLogger();
 104     fRawStreamTrigger->EnabbleErrorLogger();
 105   }
 106
 107   SetMakeTriggerDigits();
 108
 109 }
 110
 111 //__________________________________________________________________________
 112 AliMUONDigitMaker::~AliMUONDigitMaker()
 113 {
 114   /// clean up
 115   /// and time processing measure
 116
 117   delete fRawStreamTracker;
 118   delete fRawStreamTrigger;
 119   delete fLogger;
 120 }
 121
 122 //__________________________________________________________________________
 123 void AliMUONDigitMaker::CreateRawStreamTracker(Bool_t useFastDecoder)
 124 {
 125 /// Create raw stream tracker according to the passed option
 126
 127   if (useFastDecoder)
 128   {
 129     fRawStreamTracker = new AliMUONRawStreamTrackerHP();
 130   }
 131   else {
 132     AliInfo("Using non-high performance tracker decoder.");
 133     fRawStreamTracker = new AliMUONRawStreamTracker();
 134   }
 135 }
 136
 137 //__________________________________________________________________________
 138 void AliMUONDigitMaker::CreateRawStreamTrigger(Bool_t useFastDecoder)
 139 {
 140 /// Create raw stream trigger according to the passed option
 141
 142   if (useFastDecoder)
 143   {
 144     fRawStreamTrigger = new AliMUONRawStreamTriggerHP();
 145   }
 146   else {
 147     AliInfo("Using non-high performance tracker decoder.");
 148     fRawStreamTrigger = new AliMUONRawStreamTrigger();
 149   }
 150 }
 151
 152 //____________________________________________________________________
 153 void
 154 AliMUONDigitMaker::Print(Option_t*) const
 155 {
 156   /// Printout
 157
 158   cout << "RawStreamerTracker class=" << fRawStreamTracker->ClassName()
 159        << " MakeTriggerDigits=" << fMakeTriggerDigits
 160        << " ScalerEvent=" << fScalerEvent
 161        << " DigitStore=" << fDigitStore
 162        << " TriggerStore=" << fTriggerStore << endl;
 163
 164   if ( fLogger ) fLogger->Print();
 165 }
 166
 167 //____________________________________________________________________
 168 Int_t
 169 AliMUONDigitMaker::Raw2Digits(AliRawReader* rawReader,
 170                                         AliMUONVDigitStore* digitStore,
 171                                         AliMUONVTriggerStore* triggerStore)
 172 {
 173   /// Main method to creates digit
 174   /// for tracker
 175   /// and trigger
 176
 177   AliDebug(1,Form("rawReader=%p digitStore=%p triggerStore=%p",
 178                   rawReader,digitStore,triggerStore));
 179
 180   fDigitStore = digitStore;
 181   fTriggerStore = triggerStore;
 182
 183   if (!fDigitStore && !fTriggerStore)
 184   {
 185     fLogger->Log("No digit or trigger store given. Nothing to do...");
 186     return kTriggerBAD & kTrackerBAD;
 187   }
 188
 189   Int_t tracker(kOK);
 190   Int_t trigger(kOK);
 191
 192   if ( fDigitStore )
 193   {
 194     fDigitStore->Clear(); // insure we start with an empty container
 195     tracker = ReadTrackerDDL(rawReader);
 196   }
 197
 198   if ( fTriggerStore || fMakeTriggerDigits )
 199   {
 200     if ( fTriggerStore ) fTriggerStore->Clear();
 201     if ( fMakeTriggerDigits && !fDigitStore )
 202     {
 203       fLogger->Log("Asking for trigger digits but digitStore is null");
 204     }
 205     else
 206     {
 207       trigger = ReadTriggerDDL(rawReader);
 208     }
 209   }
 210
 211   return tracker | trigger;
 212 }
 213
 214 //____________________________________________________________________
 215 Int_t
 216 AliMUONDigitMaker::ReadTrackerDDL(AliRawReader* rawReader)
 217 {
 218   /// Reading tracker DDL
 219   /// filling the fDigitStore container, which must not be null
 220
 221   AliDebug(1,"");
 222
 223   AliCodeTimerAuto("");
 224
 225   // elex info
 226   Int_t    buspatchId;
 227   UChar_t  channelId;
 228   UShort_t manuId;
 229   UShort_t charge;
 230
 231   fRawStreamTracker->SetReader(rawReader);
 232   fRawStreamTracker->First();
 233
 234   while ( fRawStreamTracker->Next(buspatchId,manuId,channelId,charge) )
 235   {
 236     // getting DE from buspatch
 237     Int_t detElemId = AliMpDDLStore::Instance()->GetDEfromBus(buspatchId);
 238
 239     AliMpDetElement* de = AliMpDDLStore::Instance()->GetDetElement(detElemId);
 240
 241     if (!de)
 242       {
 243         fLogger->Log(Form("DE %04d does not exist !"));
 244         continue;
 245       }
 246
 247     if (!de->IsConnectedChannel(manuId,channelId))
 248       {
 249         // non connected pad, do nothing (this is not an error !)
 250         continue;
 251       }
 252
 253     const AliMpVSegmentation* seg
 254       = AliMpSegmentation::Instance()->GetMpSegmentationByElectronics(detElemId,
 255                                                                       manuId);
 256
 257     if (!seg)
 258     {
 259       fLogger->Log(Form("(DE,MANUID)=(%04d,%04d) is not valid",detElemId,manuId));
 260       continue;
 261     }
 262
 263     AliMp::CathodType cathodeType = de->GetCathodType(seg->PlaneType());
 264
 265     AliMpPad pad = seg->PadByLocation(AliMpIntPair(manuId,channelId),kFALSE);
 266
 267     if (!pad.IsValid())
 268     {
 269       fLogger->Log(Form("No pad for detElemId: %d, manuId: %d, channelId: %d",
 270                     detElemId, manuId, channelId));
 271       continue;
 272     }
 273
 274     AliMUONVDigit* digit = fDigitStore->Add(detElemId,manuId,channelId,cathodeType,
 275                                             AliMUONVDigitStore::kDeny);
 276
 277     if (!digit)
 278     {
 279       fLogger->Log(Form("Digit DE %04d Manu %04d Channel %02d could not be added",
 280                     detElemId, manuId, channelId));
 281       continue;
 282     }
 283
 284     digit->SetPadXY(pad.GetIndices().GetFirst(),
 285                    pad.GetIndices().GetSecond());
 286
 287           digit->SetADC(charge);
 288
 289   }
 290
 291   if ( fRawStreamTracker->IsErrorMessage() )
 292   {
 293     return kTrackerBAD;
 294   }
 295
 296   return kOK;
 297 }
 298
 299 //____________________________________________________________________
 300 Int_t
 301 AliMUONDigitMaker::ReadTriggerDDL(AliRawReader* rawReader)
 302 {
 303   /// reading tracker DDL
 304   /// filling the fTriggerStore container, which must not be null
 305
 306   AliDebug(1,"");
 307
 308   AliMUONDDLTrigger*       ddlTrigger      = 0x0;
 309   AliMUONDarcHeader*       darcHeader      = 0x0;
 310   AliMUONRegHeader*        regHeader       = 0x0;
 311   AliMUONLocalStruct*      localStruct     = 0x0;
 312
 313   Int_t loCircuit;
 314
 315   AliCodeTimerAuto("");
 316
 317   if (UsingFastTriggerDecoder()) return ReadTriggerDDLFast(rawReader);
 318
 319   fRawStreamTrigger->SetReader(rawReader);
 320
 321   while (fRawStreamTrigger->NextDDL())
 322   {
 323     ddlTrigger = fRawStreamTrigger->GetDDLTrigger();
 324     darcHeader = ddlTrigger->GetDarcHeader();
 325
 326     // fill global trigger information
 327     if (fTriggerStore)
 328     {
 329       if (darcHeader->GetGlobalFlag())
 330       {
 331           AliMUONGlobalTrigger globalTrigger;
 332           globalTrigger.SetFromGlobalResponse(darcHeader->GetGlobalOutput());
 333           fTriggerStore->SetGlobal(globalTrigger);
 334       }
 335     }
 336
 337     Int_t nReg = darcHeader->GetRegHeaderEntries();
 338
 339     for(Int_t iReg = 0; iReg < nReg ;iReg++)
 340     {   //reg loop
 341
 342
 343       // crate info
 344       AliMpTriggerCrate* crate = AliMpDDLStore::Instance()->
 345                                 GetTriggerCrate(fRawStreamTrigger->GetDDL(), iReg);
 346
 347       if (!crate)
 348         fLogger->Log(Form("Missing crate number %d in DDL %d\n", iReg, fRawStreamTrigger->GetDDL()));
 349
 350
 351       regHeader =  darcHeader->GetRegHeaderEntry(iReg);
 352
 353       Int_t nLocal = regHeader->GetLocalEntries();
 354       for(Int_t iLocal = 0; iLocal < nLocal; iLocal++)
 355       {
 356
 357         localStruct = regHeader->GetLocalEntry(iLocal);
 358
 359         // if card exist
 360         if (localStruct) {
 361
 362           loCircuit = crate->GetLocalBoardId(localStruct->GetId());
 363
 364           if ( !loCircuit ) continue; // empty slot
 365
 366           AliMpLocalBoard* localBoard = AliMpDDLStore::Instance()->GetLocalBoard(loCircuit, false);
 367
 368           // skip copy cards
 369           if( !localBoard->IsNotified())
 370              continue;
 371
 372           if (fTriggerStore)
 373           {
 374             // fill local trigger
 375             AliMUONLocalTrigger localTrigger;
 376             localTrigger.SetLocalStruct(loCircuit, *localStruct);
 377             fTriggerStore->Add(localTrigger);
 378           }
 379
 380           if ( fMakeTriggerDigits )
 381           {
 382             //FIXEME should find something better than a TArray
 383             TArrayS xyPattern[2];
 384
 385             localStruct->GetXPattern(xyPattern[0]);
 386             localStruct->GetYPattern(xyPattern[1]);
 387
 388             TriggerDigits(loCircuit, xyPattern, *fDigitStore);
 389           }
 390         } // if triggerY
 391       } // iLocal
 392     } // iReg
 393   } // NextDDL
 394
 395   return kOK;
 396 }
 397
 398 //____________________________________________________________________
 399 Int_t
 400 AliMUONDigitMaker::ReadTriggerDDLFast(AliRawReader* rawReader)
 401 {
 402   /// reading tracker DDL like ReadTriggerDDL but with fast decoder interface.
 403   /// filling the fTriggerStore container, which must not be null
 404
 405   const AliMUONRawStreamTriggerHP::AliHeader*          darcHeader  = 0x0;
 406   const AliMUONRawStreamTriggerHP::AliRegionalHeader*  regHeader   = 0x0;
 407   const AliMUONRawStreamTriggerHP::AliLocalStruct*     localStruct = 0x0;
 408
 409   Int_t loCircuit;
 410
 411   fRawStreamTrigger->SetReader(rawReader);
 412   AliMUONRawStreamTriggerHP* rawStreamTrigger =
 413     dynamic_cast<AliMUONRawStreamTriggerHP*>(fRawStreamTrigger);
 414
 415   while (fRawStreamTrigger->NextDDL())
 416   {
 417     darcHeader = rawStreamTrigger->GetHeaders();
 418
 419     // fill global trigger information
 420     if (fTriggerStore)
 421     {
 422       if (darcHeader->GetGlobalFlag())
 423       {
 424           AliMUONGlobalTrigger globalTrigger;
 425           globalTrigger.SetFromGlobalResponse(darcHeader->GetGlobalOutput());
 426           fTriggerStore->SetGlobal(globalTrigger);
 427       }
 428     }
 429
 430     Int_t nReg = rawStreamTrigger->GetRegionalHeaderCount();
 431
 432     for(Int_t iReg = 0; iReg < nReg ;iReg++)
 433     {   //reg loop
 434
 435
 436       // crate info
 437       AliMpTriggerCrate* crate = AliMpDDLStore::Instance()->
 438                                 GetTriggerCrate(fRawStreamTrigger->GetDDL(), iReg);
 439
 440       if (!crate)
 441         fLogger->Log(Form("Missing crate number %d in DDL %d\n", iReg, fRawStreamTrigger->GetDDL()));
 442
 443
 444       regHeader =  rawStreamTrigger->GetRegionalHeader(iReg);
 445
 446       Int_t nLocal = regHeader->GetLocalStructCount();
 447       for(Int_t iLocal = 0; iLocal < nLocal; iLocal++)
 448       {
 449
 450         localStruct = regHeader->GetLocalStruct(iLocal);
 451
 452         // if card exist
 453         if (localStruct) {
 454
 455           loCircuit = crate->GetLocalBoardId(localStruct->GetId());
 456
 457           if ( !loCircuit ) continue; // empty slot
 458
 459           AliMpLocalBoard* localBoard = AliMpDDLStore::Instance()->GetLocalBoard(loCircuit, kTRUE);
 460
 461           // skip copy cards
 462           if( !localBoard->IsNotified())
 463              continue;
 464
 465           if (fTriggerStore)
 466           {
 467             // fill local trigger
 468             AliMUONLocalTrigger localTrigger;
 469             localTrigger.SetLoCircuit(loCircuit);
 470             localTrigger.SetLoStripX((Int_t)localStruct->GetXPos());
 471             localTrigger.SetLoStripY((Int_t)localStruct->GetYPos());
 472             localTrigger.SetLoDev((Int_t)localStruct->GetXDev());
 473             localTrigger.SetLoSdev((Int_t)localStruct->GetSXDev());
 474             localTrigger.SetLoTrigY((Int_t)localStruct->GetTrigY());
 475             localTrigger.SetLoLpt(localStruct->GetLpt());
 476             localTrigger.SetLoHpt(localStruct->GetHpt());
 477             localTrigger.SetX1Pattern(localStruct->GetX1());
 478             localTrigger.SetX2Pattern(localStruct->GetX2());
 479             localTrigger.SetX3Pattern(localStruct->GetX3());
 480             localTrigger.SetX4Pattern(localStruct->GetX4());
 481             localTrigger.SetY1Pattern(localStruct->GetY1());
 482             localTrigger.SetY2Pattern(localStruct->GetY2());
 483             localTrigger.SetY3Pattern(localStruct->GetY3());
 484             localTrigger.SetY4Pattern(localStruct->GetY4());
 485             fTriggerStore->Add(localTrigger);
 486           }
 487
 488           if ( fMakeTriggerDigits )
 489           {
 490             //FIXEME should find something better than a TArray
 491             TArrayS xyPattern[2];
 492
 493             localStruct->GetXPattern(xyPattern[0]);
 494             localStruct->GetYPattern(xyPattern[1]);
 495
 496             TriggerDigits(loCircuit, xyPattern, *fDigitStore);
 497           }
 498         } // if triggerY
 499       } // iLocal
 500     } // iReg
 501   } // NextDDL
 502
 503   return kOK;
 504 }
 505
 506 //____________________________________________________________________
 507 Int_t AliMUONDigitMaker::TriggerDigits(Int_t nBoard,
 508                                        TArrayS* xyPattern,
 509                                        AliMUONVDigitStore& digitStore) const
 510 {
 511   /// make digits for trigger from pattern, and add them to digitStore
 512
 513   AliCodeTimerAuto("");
 514
 515   Int_t detElemId;
 516
 517   AliMpLocalBoard* localBoard = AliMpDDLStore::Instance()->GetLocalBoard(nBoard);
 518
 519   Int_t n,b;
 520
 521   // loop over x1-4 and y1-4
 522   for (Int_t iChamber = 0; iChamber < 4; ++iChamber)
 523   {
 524     for (Int_t iCath = 0; iCath < 2; ++iCath)
 525     {
 526       Int_t pattern = (Int_t)xyPattern[iCath].At(iChamber);
 527       if (!pattern) continue;
 528
 529       // get detElemId
 530       detElemId = AliMpDDLStore::Instance()->GetDEfromLocalBoard(nBoard, iChamber);
 531
 532         const AliMpVSegmentation* seg
 533           = AliMpSegmentation::Instance()
 534           ->GetMpSegmentation(detElemId, AliMp::GetCathodType(iCath));
 535
 536         // loop over the 16 bits of pattern
 537         for (Int_t ibitxy = 0; ibitxy < 16; ++ibitxy)
 538         {
 539           if ((pattern >> ibitxy) & 0x1)
 540           {
 541             // not quite sure about this
 542             Int_t offset = 0;
 543             if (iCath && localBoard->GetSwitch(6)) offset = -8;
 544
 545             AliMpPad pad = seg->PadByLocation(AliMpIntPair(nBoard,ibitxy+offset),kTRUE);
 546
 547             if (!pad.IsValid())
 548             {
 549               fLogger->Log(Form("No pad for detElemId: %d, nboard %d, ibitxy: %d\n",
 550                               detElemId, nBoard, ibitxy));
 551               continue;
 552             }
 553
 554             n = pad.GetLocation(0).GetFirst(); // always take first location so that digits are not inserted several times
 555             b = pad.GetLocation(0).GetSecond();
 556
 557             AliDebug(1,Form("Using localBoard %d ixy %d instead of %d,%d",
 558                             n,b,nBoard,ibitxy));
 559
 560             AliMUONVDigit* digit = digitStore.Add(detElemId,n,b,iCath,AliMUONVDigitStore::kDeny);
 561
 562             if (!digit)
 563             {
 564                 AliDebug(1, Form("Digit DE %04d LocalBoard %03d ibitxy %02d cath %d already in store",
 565                                  detElemId,nBoard,ibitxy,iCath));
 566                 continue;
 567             }
 568
 569             Int_t padX = pad.GetIndices().GetFirst();
 570             Int_t padY = pad.GetIndices().GetSecond();
 571
 572             // fill digit
 573             digit->SetPadXY(padX,padY);
 574             digit->SetCharge(1.);
 575           }// xyPattern
 576         }// ibitxy
 577     }// cath
 578   } // ichamber
 579
 580   return kTRUE;
 581 }
 582
 583 //____________________________________________________________________
 584 Bool_t AliMUONDigitMaker::UsingFastTrackerDecoder() const
 585 {
 586 /// Returns kTRUE if the digit maker is using the high performance decoder for
 587 /// tracker DDL stream decoding.
 588
 589   return (fRawStreamTracker->IsA() == AliMUONRawStreamTrackerHP::Class());
 590 }
 591
 592 //____________________________________________________________________
 593 Bool_t AliMUONDigitMaker::UsingFastTriggerDecoder() const
 594 {
 595 /// Returns kTRUE if the digit maker is using the high performance decoder for
 596 /// trigger DDL stream decoding.
 597
 598   return (fRawStreamTrigger->IsA() == AliMUONRawStreamTriggerHP::Class());
 599 }
 600
 601 //____________________________________________________________________
 602 void  AliMUONDigitMaker::SetFastTrackerDecoder(Bool_t useFastDecoder)
 603 {
 604 /// Set fast raw data decoder
 605
 606   delete fRawStreamTracker;
 607   CreateRawStreamTracker(useFastDecoder);
 608 }
 609
 610 //____________________________________________________________________
 611 void  AliMUONDigitMaker::SetFastTriggerDecoder(Bool_t useFastDecoder)
 612 {
 613 /// Set fast raw data decoder
 614
 615   delete fRawStreamTrigger;
 616   CreateRawStreamTrigger(useFastDecoder);
 617 }
 618