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