1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 ///////////////////////////////////////////////////////////////////////////////
20 /// This is a class for reading raw data from a root file.
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
26 /// The file name and the event number are arguments of the constructor
27 /// of AliRawReaderRoot.
29 ///////////////////////////////////////////////////////////////////////////////
33 #include "AliRawReaderRoot.h"
34 #include "AliRawEvent.h"
35 #include "AliRawEventHeaderBase.h"
36 #include "AliRawEquipment.h"
37 #include "AliRawEquipmentHeader.h"
38 #include "AliRawData.h"
41 ClassImp(AliRawReaderRoot)
44 AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
47 fEventIndex(eventNumber),
57 // create an object to read digits from the given input file for the
58 // event with the given number
60 TDirectory* dir = gDirectory;
61 fFile = TFile::Open(fileName);
63 if (!fFile || !fFile->IsOpen()) {
64 Error("AliRawReaderRoot", "could not open file %s", fileName);
67 TTree* tree = (TTree*) fFile->Get("RAW");
69 Error("AliRawReaderRoot", "no raw data tree found");
72 fBranch = tree->GetBranch("rawevent");
74 Error("AliRawReaderRoot", "no raw data branch found");
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);
88 AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
101 // create an object to read digits from the given raw event
105 AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
106 AliRawReader(rawReader),
109 fEventIndex(rawReader.fEventIndex),
111 fSubEventIndex(rawReader.fSubEventIndex),
113 fEquipmentIndex(rawReader.fEquipmentIndex),
121 if (rawReader.fFile) {
122 TDirectory* dir = gDirectory;
123 fFile = TFile::Open(rawReader.fFile->GetName());
125 if (!fFile || !fFile->IsOpen()) {
126 Error("AliRawReaderRoot", "could not open file %s",
127 rawReader.fFile->GetName());
130 TTree* tree = (TTree*) fFile->Get("RAW");
132 Error("AliRawReaderRoot", "no raw data tree found");
135 fBranch = tree->GetBranch("rawevent");
137 Error("AliRawReaderRoot", "no raw data branch found");
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",
151 fEvent = rawReader.fEvent;
154 if (fSubEventIndex > 0) {
155 fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
156 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
157 fRawData = fEquipment->GetRawData();
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();
168 AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot&
171 // assignment operator
173 this->~AliRawReaderRoot();
174 new(this) AliRawReaderRoot(rawReader);
178 AliRawReaderRoot::~AliRawReaderRoot()
180 // delete objects and close root file
183 if (fEvent) delete fEvent;
190 UInt_t AliRawReaderRoot::GetType() const
192 // get the type from the event header
194 if (!fEvent) return 0;
195 return fEvent->GetHeader()->Get("Type");
198 UInt_t AliRawReaderRoot::GetRunNumber() const
200 // get the run number from the event header
202 if (!fEvent) return 0;
203 return fEvent->GetHeader()->Get("RunNb");
206 const UInt_t* AliRawReaderRoot::GetEventId() const
208 // get the event id from the event header
210 if (!fEvent) return NULL;
211 return fEvent->GetHeader()->GetP("Id");
214 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
216 // get the trigger pattern from the event header
218 if (!fEvent) return NULL;
219 return fEvent->GetHeader()->GetP("TriggerPattern");
222 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
224 // get the detector pattern from the event header
226 if (!fEvent) return NULL;
227 return fEvent->GetHeader()->GetP("DetectorPattern");
230 const UInt_t* AliRawReaderRoot::GetAttributes() const
232 // get the type attributes from the event header
234 if (!fEvent) return NULL;
235 return fEvent->GetHeader()->GetP("TypeAttribute");
238 const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
240 // get the type attributes from the sub event header
242 if (!fSubEvent) return NULL;
243 return fSubEvent->GetHeader()->GetP("TypeAttribute");
246 UInt_t AliRawReaderRoot::GetLDCId() const
248 // get the LDC Id from the event header
250 if (!fEvent || !fSubEvent) return 0;
251 return fSubEvent->GetHeader()->Get("LdcId");
254 UInt_t AliRawReaderRoot::GetGDCId() const
256 // get the GDC Id from the event header
258 if (!fEvent) return 0;
259 return fEvent->GetHeader()->Get("GdcId");
263 Int_t AliRawReaderRoot::GetEquipmentSize() const
265 // get the size of the equipment
267 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
268 return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
271 Int_t AliRawReaderRoot::GetEquipmentType() const
273 // get the type from the equipment header
275 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
276 return fEquipment->GetEquipmentHeader()->GetEquipmentType();
279 Int_t AliRawReaderRoot::GetEquipmentId() const
281 // get the ID from the equipment header
283 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
284 return fEquipment->GetEquipmentHeader()->GetId();
287 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
289 // get the attributes from the equipment header
291 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
292 return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
295 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
297 // get the basic element size from the equipment header
299 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
300 return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
303 Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
305 // get the size of the equipment header (28 bytes by default)
307 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
308 return fEquipment->GetEquipmentHeader()->HeaderSize();
312 Bool_t AliRawReaderRoot::ReadHeader()
314 // read a data header at the current position
315 // returns kFALSE if the data header could not be read
318 if (!fEvent) return kFALSE;
321 // skip payload (if event was not selected)
322 if (fCount > 0) fPosition += fCount;
324 // get the first or the next equipment if at the end of an equipment
325 if (!fEquipment || (fPosition >= fEnd)) {
327 // get the first or the next sub event if at the end of a sub event
328 if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
330 // check for end of event data
331 if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
332 fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
334 // check the magic word of the sub event
335 if (!fSubEvent->GetHeader()->IsValid()) {
336 Error("ReadHeader", "wrong magic number in sub event!");
337 fSubEvent->GetHeader()->Dump();
338 fErrorCode = kErrMagic;
347 // get the next equipment and raw data
349 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
350 if (!fEquipment) continue;
351 fRawData = fEquipment->GetRawData();
356 fPosition = (UChar_t*) fRawData->GetBuffer();
357 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
360 // continue with the next equipment if no data left in the payload
361 if (fPosition >= fEnd) continue;
363 if (fRequireHeader) {
364 // check that there are enough bytes left for the data header
365 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
366 Error("ReadHeader", "could not read data header!");
367 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
368 fEquipment->GetEquipmentHeader()->Dump();
371 fErrorCode = kErrNoDataHeader;
375 // "read" the data header
376 fHeader = (AliRawDataHeader*) fPosition;
377 if ((fPosition + fHeader->fSize) != fEnd) {
378 Warning("ReadHeader",
379 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
380 fHeader->fSize, fEnd - fPosition);
381 fHeader->fSize = fEnd - fPosition;
383 fPosition += sizeof(AliRawDataHeader);
386 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
387 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
389 // check consistency of data size in the header and in the sub event
390 if (fPosition + fCount > fEnd) {
391 Error("ReadHeader", "size in data header exceeds event size!");
392 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
393 fEquipment->GetEquipmentHeader()->Dump();
396 fErrorCode = kErrSize;
401 fCount = fEnd - fPosition;
404 } while (!IsSelected());
409 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
411 // reads the next payload at the current position
412 // returns kFALSE if the data could not be read
415 while (fCount == 0) {
416 if (!ReadHeader()) return kFALSE;
424 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
426 // reads the next block of data at the current position
427 // returns kFALSE if the data could not be read
430 if (fPosition + size > fEnd) {
431 Error("ReadNext", "could not read data!");
432 fErrorCode = kErrOutOfBounds;
435 memcpy(data, fPosition, size);
442 Bool_t AliRawReaderRoot::Reset()
444 // reset the current position to the beginning of the event
454 fPosition = fEnd = NULL;
459 Bool_t AliRawReaderRoot::NextEvent()
461 // go to the next event in the root file
463 if (!fFile) return kFALSE;
467 fEvent = new AliRawEvent;
468 fBranch->SetAddress(&fEvent);
469 if (fBranch->GetEntry(fEventIndex+1) <= 0)
472 } while (!IsEventSelected());
476 Bool_t AliRawReaderRoot::RewindEvents()
478 // go back to the beginning of the root file
480 if (!fFile) return kFALSE;
484 fEvent = new AliRawEvent;
485 fBranch->SetAddress(&fEvent);
490 Int_t AliRawReaderRoot::CheckData() const
492 // check the consistency of the data
494 if (!fEvent) return 0;
496 AliRawEvent* subEvent = NULL;
497 Int_t subEventIndex = 0;
498 AliRawEquipment* equipment = NULL;
499 Int_t equipmentIndex = 0;
500 UChar_t* position = 0;
505 // get the first or the next sub event if at the end of an equipment
506 if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
508 // check for end of event data
509 if (subEventIndex >= fEvent->GetNSubEvents()) return result;
510 subEvent = fEvent->GetSubEvent(subEventIndex++);
512 // check the magic word of the sub event
513 if (!fSubEvent->GetHeader()->IsValid()) {
521 // get the next equipment and raw data
522 equipment = subEvent->GetEquipment(equipmentIndex++);
523 if (!equipment) continue;
524 AliRawData* rawData = equipment->GetRawData();
525 if (!rawData) continue;
526 position = (UChar_t*) rawData->GetBuffer();
527 end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
529 // continue with the next sub event if no data left in the payload
530 if (position >= end) continue;
532 if (fRequireHeader) {
533 // check that there are enough bytes left for the data header
534 if (position + sizeof(AliRawDataHeader) > end) {
535 result |= kErrNoDataHeader;
539 // check consistency of data size in the header and in the equipment
540 AliRawDataHeader* header = (AliRawDataHeader*) position;
541 if ((position + header->fSize) != end) {
542 Warning("ReadHeader",
543 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
544 header->fSize, end - position);
545 header->fSize = end - position;