RAW/AliRawReaderRoot.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 is a class for reading raw data from a root file.
  21 ///
  22 /// The root file is expected to contain a tree of name "RAW" with
  23 /// a branch of name "rawevent" which contains objects of type
  24 /// AliRawEvent.
  25 ///
  26 /// The file name and the event number are arguments of the constructor
  27 /// of AliRawReaderRoot.
  28 ///
  29 ///////////////////////////////////////////////////////////////////////////////
  30
  31 #include <TFile.h>
  32 #include <TTree.h>
  33 #include "AliRawReaderRoot.h"
  34 #include "AliRawEvent.h"
  35 #include "AliRawEventHeaderBase.h"
  36 #include "AliRawEquipment.h"
  37 #include "AliRawEquipmentHeader.h"
  38 #include "AliRawData.h"
  39
  40
  41 ClassImp(AliRawReaderRoot)
  42
  43
  44 AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
  45   fFile(NULL),
  46   fBranch(NULL),
  47   fEventIndex(eventNumber),
  48   fEvent(NULL),
  49   fSubEventIndex(0),
  50   fSubEvent(NULL),
  51   fEquipmentIndex(0),
  52   fEquipment(NULL),
  53   fRawData(NULL),
  54   fPosition(NULL),
  55   fEnd(NULL)
  56 {
  57 // create an object to read digits from the given input file for the
  58 // event with the given number
  59
  60   TDirectory* dir = gDirectory;
  61   fFile = TFile::Open(fileName);
  62   dir->cd();
  63   if (!fFile || !fFile->IsOpen()) {
  64     Error("AliRawReaderRoot", "could not open file %s", fileName);
  65     return;
  66   }
  67   TTree* tree = (TTree*) fFile->Get("RAW");
  68   if (!tree) {
  69     Error("AliRawReaderRoot", "no raw data tree found");
  70     return;
  71   }
  72   fBranch = tree->GetBranch("rawevent");
  73   if (!fBranch) {
  74     Error("AliRawReaderRoot", "no raw data branch found");
  75     return;
  76   }
  77
  78   fEvent = new AliRawEvent;
  79   fBranch->SetAddress(&fEvent);
  80   if (fEventIndex >= 0) {
  81     if (fBranch->GetEntry(fEventIndex) <= 0) {
  82       Error("AliRawReaderRoot", "no event with number %d found", fEventIndex);
  83       return;
  84     }
  85   }
  86 }
  87
  88 AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
  89   fFile(NULL),
  90   fBranch(NULL),
  91   fEventIndex(-1),
  92   fEvent(event),
  93   fSubEventIndex(0),
  94   fSubEvent(NULL),
  95   fEquipmentIndex(0),
  96   fEquipment(NULL),
  97   fRawData(NULL),
  98   fPosition(NULL),
  99   fEnd(NULL)
 100 {
 101 // create an object to read digits from the given raw event
 102
 103 }
 104
 105 AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
 106   AliRawReader(rawReader),
 107   fFile(NULL),
 108   fBranch(NULL),
 109   fEventIndex(rawReader.fEventIndex),
 110   fEvent(NULL),
 111   fSubEventIndex(rawReader.fSubEventIndex),
 112   fSubEvent(NULL),
 113   fEquipmentIndex(rawReader.fEquipmentIndex),
 114   fEquipment(NULL),
 115   fRawData(NULL),
 116   fPosition(NULL),
 117   fEnd(NULL)
 118 {
 119 // copy constructor
 120
 121   if (rawReader.fFile) {
 122     TDirectory* dir = gDirectory;
 123     fFile = TFile::Open(rawReader.fFile->GetName());
 124     dir->cd();
 125     if (!fFile || !fFile->IsOpen()) {
 126       Error("AliRawReaderRoot", "could not open file %s",
 127             rawReader.fFile->GetName());
 128       return;
 129     }
 130     TTree* tree = (TTree*) fFile->Get("RAW");
 131     if (!tree) {
 132       Error("AliRawReaderRoot", "no raw data tree found");
 133       return;
 134     }
 135     fBranch = tree->GetBranch("rawevent");
 136     if (!fBranch) {
 137       Error("AliRawReaderRoot", "no raw data branch found");
 138       return;
 139     }
 140
 141     fEvent = new AliRawEvent;
 142     fBranch->SetAddress(&fEvent);
 143     if (fEventIndex >= 0) {
 144       if (fBranch->GetEntry(fEventIndex) <= 0) {
 145         Error("AliRawReaderRoot", "no event with number %d found",
 146               fEventIndex);
 147         return;
 148       }
 149     }
 150   } else {
 151     fEvent = rawReader.fEvent;
 152   }
 153
 154   if (fSubEventIndex > 0) {
 155     fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
 156     fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
 157     fRawData = fEquipment->GetRawData();
 158       fCount = 0;
 159     fHeader = (AliRawDataHeader*) ((UChar_t*) fRawData->GetBuffer() +
 160       ((UChar_t*) rawReader.fHeader -
 161        (UChar_t*) rawReader.fRawData->GetBuffer()));
 162     fPosition = (UChar_t*) fRawData->GetBuffer() +
 163       (rawReader.fPosition - (UChar_t*) rawReader.fRawData->GetBuffer());
 164     fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
 165   }
 166 }
 167
 168 AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot&
 169                                                 rawReader)
 170 {
 171 // assignment operator
 172
 173   this->~AliRawReaderRoot();
 174   new(this) AliRawReaderRoot(rawReader);
 175   return *this;
 176 }
 177
 178 AliRawReaderRoot::~AliRawReaderRoot()
 179 {
 180 // delete objects and close root file
 181
 182   if (fFile) {
 183     if (fEvent) delete fEvent;
 184     fFile->Close();
 185     delete fFile;
 186   }
 187 }
 188
 189 const AliRawEventHeaderBase* AliRawReaderRoot::GetEventHeader() const
 190 {
 191   // Get the even header
 192   // Return NULL in case of failure
 193   if (!fEvent) return NULL;
 194   return fEvent->GetHeader();
 195 }
 196
 197 UInt_t AliRawReaderRoot::GetType() const
 198 {
 199 // get the type from the event header
 200
 201   if (!fEvent) return 0;
 202   return fEvent->GetHeader()->Get("Type");
 203 }
 204
 205 UInt_t AliRawReaderRoot::GetRunNumber() const
 206 {
 207 // get the run number from the event header
 208
 209   if (!fEvent) return 0;
 210   return fEvent->GetHeader()->Get("RunNb");
 211 }
 212
 213 const UInt_t* AliRawReaderRoot::GetEventId() const
 214 {
 215 // get the event id from the event header
 216
 217   if (!fEvent) return NULL;
 218   return fEvent->GetHeader()->GetP("Id");
 219 }
 220
 221 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
 222 {
 223 // get the trigger pattern from the event header
 224
 225   if (!fEvent) return NULL;
 226   return fEvent->GetHeader()->GetP("TriggerPattern");
 227 }
 228
 229 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
 230 {
 231 // get the detector pattern from the event header
 232
 233   if (!fEvent) return NULL;
 234   return fEvent->GetHeader()->GetP("DetectorPattern");
 235 }
 236
 237 const UInt_t* AliRawReaderRoot::GetAttributes() const
 238 {
 239 // get the type attributes from the event header
 240
 241   if (!fEvent) return NULL;
 242   return fEvent->GetHeader()->GetP("TypeAttribute");
 243 }
 244
 245 const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
 246 {
 247 // get the type attributes from the sub event header
 248
 249   if (!fSubEvent) return NULL;
 250   return fSubEvent->GetHeader()->GetP("TypeAttribute");
 251 }
 252
 253 UInt_t AliRawReaderRoot::GetLDCId() const
 254 {
 255 // get the LDC Id from the event header
 256
 257   if (!fEvent || !fSubEvent) return 0;
 258   return fSubEvent->GetHeader()->Get("LdcId");
 259 }
 260
 261 UInt_t AliRawReaderRoot::GetGDCId() const
 262 {
 263 // get the GDC Id from the event header
 264
 265   if (!fEvent) return 0;
 266   return fEvent->GetHeader()->Get("GdcId");
 267 }
 268
 269
 270 Int_t AliRawReaderRoot::GetEquipmentSize() const
 271 {
 272 // get the size of the equipment
 273
 274   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 275   return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
 276 }
 277
 278 Int_t AliRawReaderRoot::GetEquipmentType() const
 279 {
 280 // get the type from the equipment header
 281
 282   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
 283   return fEquipment->GetEquipmentHeader()->GetEquipmentType();
 284 }
 285
 286 Int_t AliRawReaderRoot::GetEquipmentId() const
 287 {
 288 // get the ID from the equipment header
 289
 290   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
 291   return fEquipment->GetEquipmentHeader()->GetId();
 292 }
 293
 294 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
 295 {
 296 // get the attributes from the equipment header
 297
 298   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
 299   return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
 300 }
 301
 302 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
 303 {
 304 // get the basic element size from the equipment header
 305
 306   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 307   return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
 308 }
 309
 310 Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
 311 {
 312 // get the size of the equipment header (28 bytes by default)
 313
 314   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 315   return fEquipment->GetEquipmentHeader()->HeaderSize();
 316 }
 317
 318
 319 Bool_t AliRawReaderRoot::ReadHeader()
 320 {
 321 // read a data header at the current position
 322 // returns kFALSE if the data header could not be read
 323
 324   fErrorCode = 0;
 325   if (!fEvent) return kFALSE;
 326
 327   do {
 328     // skip payload (if event was not selected)
 329     if (fCount > 0) fPosition += fCount;
 330
 331     // get the first or the next equipment if at the end of an equipment
 332     if (!fEquipment || (fPosition >= fEnd)) {
 333
 334       // get the first or the next sub event if at the end of a sub event
 335       if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
 336
 337         // check for end of event data
 338         if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
 339         fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
 340
 341         // check the magic word of the sub event
 342         if (!fSubEvent->GetHeader()->IsValid()) {
 343           Error("ReadHeader", "wrong magic number in sub event!");
 344           fSubEvent->GetHeader()->Dump();
 345           fErrorCode = kErrMagic;
 346           return kFALSE;
 347         }
 348
 349         fEquipmentIndex = 0;
 350         fEquipment = NULL;
 351         fRawData = NULL;
 352       }
 353
 354       // get the next equipment and raw data
 355       fCount = 0;
 356       fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
 357       if (!fEquipment) continue;
 358       fRawData = fEquipment->GetRawData();
 359       if (!fRawData) {
 360         fPosition = fEnd;
 361         continue;
 362       }
 363       fPosition = (UChar_t*) fRawData->GetBuffer();
 364       fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
 365     }
 366
 367     // continue with the next equipment if no data left in the payload
 368     if (fPosition >= fEnd) continue;
 369
 370     if (fRequireHeader) {
 371       // check that there are enough bytes left for the data header
 372       if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
 373         Error("ReadHeader", "could not read data header!");
 374         Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
 375         fEquipment->GetEquipmentHeader()->Dump();
 376         fCount = 0;
 377         fPosition = fEnd;
 378         fErrorCode = kErrNoDataHeader;
 379         continue;
 380       }
 381
 382       // "read" the data header
 383       fHeader = (AliRawDataHeader*) fPosition;
 384       if ((fPosition + fHeader->fSize) != fEnd) {
 385         Warning("ReadHeader",
 386                 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
 387                 fHeader->fSize, fEnd - fPosition);
 388         fHeader->fSize = fEnd - fPosition;
 389       }
 390       fPosition += sizeof(AliRawDataHeader);
 391     }
 392
 393     if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
 394       fCount = fHeader->fSize - sizeof(AliRawDataHeader);
 395
 396       // check consistency of data size in the header and in the sub event
 397       if (fPosition + fCount > fEnd) {
 398         Error("ReadHeader", "size in data header exceeds event size!");
 399         Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
 400         fEquipment->GetEquipmentHeader()->Dump();
 401         fCount = 0;
 402         fPosition = fEnd;
 403         fErrorCode = kErrSize;
 404         continue;
 405       }
 406
 407     } else {
 408       fCount = fEnd - fPosition;
 409     }
 410
 411   } while (!IsSelected());
 412
 413   return kTRUE;
 414 }
 415
 416 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
 417 {
 418 // reads the next payload at the current position
 419 // returns kFALSE if the data could not be read
 420
 421   fErrorCode = 0;
 422   while (fCount == 0) {
 423     if (!ReadHeader()) return kFALSE;
 424   }
 425   data = fPosition;
 426   fPosition += fCount;
 427   fCount = 0;
 428   return kTRUE;
 429 }
 430
 431 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
 432 {
 433 // reads the next block of data at the current position
 434 // returns kFALSE if the data could not be read
 435
 436   fErrorCode = 0;
 437   if (fPosition + size > fEnd) {
 438     Error("ReadNext", "could not read data!");
 439     fErrorCode = kErrOutOfBounds;
 440     return kFALSE;
 441   }
 442   memcpy(data, fPosition, size);
 443   fPosition += size;
 444   fCount -= size;
 445   return kTRUE;
 446 }
 447
 448
 449 Bool_t AliRawReaderRoot::Reset()
 450 {
 451 // reset the current position to the beginning of the event
 452
 453   fSubEventIndex = 0;
 454   fSubEvent = NULL;
 455   fEquipmentIndex = 0;
 456   fEquipment = NULL;
 457   fRawData = NULL;
 458   fHeader = NULL;
 459
 460   fCount = 0;
 461   fPosition = fEnd = NULL;
 462   return kTRUE;
 463 }
 464
 465
 466 Bool_t AliRawReaderRoot::NextEvent()
 467 {
 468 // go to the next event in the root file
 469
 470   if (!fFile) return kFALSE;
 471
 472   do {
 473     delete fEvent;
 474     fEvent = new AliRawEvent;
 475     fBranch->SetAddress(&fEvent);
 476     if (fBranch->GetEntry(fEventIndex+1) <= 0)
 477       return kFALSE;
 478     fEventIndex++;
 479   } while (!IsEventSelected());
 480   return Reset();
 481 }
 482
 483 Bool_t AliRawReaderRoot::RewindEvents()
 484 {
 485 // go back to the beginning of the root file
 486
 487   if (!fFile) return kFALSE;
 488
 489   fEventIndex = -1;
 490   delete fEvent;
 491   fEvent = new AliRawEvent;
 492   fBranch->SetAddress(&fEvent);
 493   return Reset();
 494 }
 495
 496
 497 Int_t AliRawReaderRoot::CheckData() const
 498 {
 499 // check the consistency of the data
 500
 501   if (!fEvent) return 0;
 502
 503   AliRawEvent* subEvent = NULL;
 504   Int_t subEventIndex = 0;
 505   AliRawEquipment* equipment = NULL;
 506   Int_t equipmentIndex = 0;
 507   UChar_t* position = 0;
 508   UChar_t* end = 0;
 509   Int_t result = 0;
 510
 511   while (kTRUE) {
 512     // get the first or the next sub event if at the end of an equipment
 513     if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
 514
 515       // check for end of event data
 516       if (subEventIndex >= fEvent->GetNSubEvents()) return result;
 517       subEvent = fEvent->GetSubEvent(subEventIndex++);
 518
 519       // check the magic word of the sub event
 520       if (!fSubEvent->GetHeader()->IsValid()) {
 521         result |= kErrMagic;
 522         return result;
 523       }
 524
 525       equipmentIndex = 0;
 526     }
 527
 528     // get the next equipment and raw data
 529     equipment = subEvent->GetEquipment(equipmentIndex++);
 530     if (!equipment) continue;
 531     AliRawData* rawData = equipment->GetRawData();
 532     if (!rawData) continue;
 533     position = (UChar_t*) rawData->GetBuffer();
 534     end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
 535
 536     // continue with the next sub event if no data left in the payload
 537     if (position >= end) continue;
 538
 539     if (fRequireHeader) {
 540     // check that there are enough bytes left for the data header
 541       if (position + sizeof(AliRawDataHeader) > end) {
 542         result |= kErrNoDataHeader;
 543         continue;
 544       }
 545
 546       // check consistency of data size in the header and in the equipment
 547       AliRawDataHeader* header = (AliRawDataHeader*) position;
 548       if ((position + header->fSize) != end) {
 549         Warning("ReadHeader",
 550                 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
 551                 header->fSize, end - position);
 552         header->fSize = end - position;
 553         result |= kErrSize;
 554       }
 555     }
 556     position = end;
 557   };
 558
 559   return result;
 560 }