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;
189 const AliRawEventHeaderBase* AliRawReaderRoot::GetEventHeader() const
191 // Get the even header
192 // Return NULL in case of failure
193 if (!fEvent) return NULL;
194 return fEvent->GetHeader();
197 UInt_t AliRawReaderRoot::GetType() const
199 // get the type from the event header
201 if (!fEvent) return 0;
202 return fEvent->GetHeader()->Get("Type");
205 UInt_t AliRawReaderRoot::GetRunNumber() const
207 // get the run number from the event header
209 if (!fEvent) return 0;
210 return fEvent->GetHeader()->Get("RunNb");
213 const UInt_t* AliRawReaderRoot::GetEventId() const
215 // get the event id from the event header
217 if (!fEvent) return NULL;
218 return fEvent->GetHeader()->GetP("Id");
221 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
223 // get the trigger pattern from the event header
225 if (!fEvent) return NULL;
226 return fEvent->GetHeader()->GetP("TriggerPattern");
229 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
231 // get the detector pattern from the event header
233 if (!fEvent) return NULL;
234 return fEvent->GetHeader()->GetP("DetectorPattern");
237 const UInt_t* AliRawReaderRoot::GetAttributes() const
239 // get the type attributes from the event header
241 if (!fEvent) return NULL;
242 return fEvent->GetHeader()->GetP("TypeAttribute");
245 const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
247 // get the type attributes from the sub event header
249 if (!fSubEvent) return NULL;
250 return fSubEvent->GetHeader()->GetP("TypeAttribute");
253 UInt_t AliRawReaderRoot::GetLDCId() const
255 // get the LDC Id from the event header
257 if (!fEvent || !fSubEvent) return 0;
258 return fSubEvent->GetHeader()->Get("LdcId");
261 UInt_t AliRawReaderRoot::GetGDCId() const
263 // get the GDC Id from the event header
265 if (!fEvent) return 0;
266 return fEvent->GetHeader()->Get("GdcId");
270 Int_t AliRawReaderRoot::GetEquipmentSize() const
272 // get the size of the equipment
274 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
275 return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
278 Int_t AliRawReaderRoot::GetEquipmentType() const
280 // get the type from the equipment header
282 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
283 return fEquipment->GetEquipmentHeader()->GetEquipmentType();
286 Int_t AliRawReaderRoot::GetEquipmentId() const
288 // get the ID from the equipment header
290 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
291 return fEquipment->GetEquipmentHeader()->GetId();
294 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
296 // get the attributes from the equipment header
298 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
299 return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
302 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
304 // get the basic element size from the equipment header
306 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
307 return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
310 Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
312 // get the size of the equipment header (28 bytes by default)
314 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
315 return fEquipment->GetEquipmentHeader()->HeaderSize();
319 Bool_t AliRawReaderRoot::ReadHeader()
321 // read a data header at the current position
322 // returns kFALSE if the data header could not be read
325 if (!fEvent) return kFALSE;
328 // skip payload (if event was not selected)
329 if (fCount > 0) fPosition += fCount;
331 // get the first or the next equipment if at the end of an equipment
332 if (!fEquipment || (fPosition >= fEnd)) {
334 // get the first or the next sub event if at the end of a sub event
335 if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
337 // check for end of event data
338 if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
339 fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
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;
354 // get the next equipment and raw data
356 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
357 if (!fEquipment) continue;
362 fRawData = fEquipment->GetRawData();
367 fPosition = (UChar_t*) fRawData->GetBuffer();
368 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
371 // continue with the next equipment if no data left in the payload
372 if (fPosition >= fEnd) continue;
374 if (fRequireHeader) {
375 // check that there are enough bytes left for the data header
376 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
377 Error("ReadHeader", "could not read data header!");
378 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
379 fEquipment->GetEquipmentHeader()->Dump();
382 fErrorCode = kErrNoDataHeader;
386 // "read" the data header
387 fHeader = (AliRawDataHeader*) fPosition;
388 if ((fPosition + fHeader->fSize) != fEnd) {
389 Warning("ReadHeader",
390 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
391 fEquipment->GetEquipmentHeader()->GetId(),fHeader->fSize, fEnd - fPosition);
392 fHeader->fSize = fEnd - fPosition;
394 fPosition += sizeof(AliRawDataHeader);
397 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
398 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
400 // check consistency of data size in the header and in the sub event
401 if (fPosition + fCount > fEnd) {
402 Error("ReadHeader", "size in data header exceeds event size!");
403 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
404 fEquipment->GetEquipmentHeader()->Dump();
407 fErrorCode = kErrSize;
412 fCount = fEnd - fPosition;
415 } while (!IsSelected());
420 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
422 // reads the next payload at the current position
423 // returns kFALSE if the data could not be read
426 while (fCount == 0) {
427 if (!ReadHeader()) return kFALSE;
435 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
437 // reads the next block of data at the current position
438 // returns kFALSE if the data could not be read
441 if (fPosition + size > fEnd) {
442 Error("ReadNext", "could not read data!");
443 fErrorCode = kErrOutOfBounds;
446 memcpy(data, fPosition, size);
453 Bool_t AliRawReaderRoot::Reset()
455 // reset the current position to the beginning of the event
465 fPosition = fEnd = NULL;
470 Bool_t AliRawReaderRoot::NextEvent()
472 // go to the next event in the root file
474 if (!fFile) return kFALSE;
478 fEvent = new AliRawEvent;
479 fBranch->SetAddress(&fEvent);
480 if (fBranch->GetEntry(fEventIndex+1) <= 0)
483 } while (!IsEventSelected());
488 Bool_t AliRawReaderRoot::RewindEvents()
490 // go back to the beginning of the root file
492 if (!fFile) return kFALSE;
496 fEvent = new AliRawEvent;
497 fBranch->SetAddress(&fEvent);
503 Int_t AliRawReaderRoot::CheckData() const
505 // check the consistency of the data
507 if (!fEvent) return 0;
509 AliRawEvent* subEvent = NULL;
510 Int_t subEventIndex = 0;
511 AliRawEquipment* equipment = NULL;
512 Int_t equipmentIndex = 0;
513 UChar_t* position = 0;
518 // get the first or the next sub event if at the end of an equipment
519 if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
521 // check for end of event data
522 if (subEventIndex >= fEvent->GetNSubEvents()) return result;
523 subEvent = fEvent->GetSubEvent(subEventIndex++);
525 // check the magic word of the sub event
526 if (!fSubEvent->GetHeader()->IsValid()) {
534 // get the next equipment and raw data
535 equipment = subEvent->GetEquipment(equipmentIndex++);
536 if (!equipment) continue;
537 AliRawData* rawData = equipment->GetRawData();
538 if (!rawData) continue;
539 position = (UChar_t*) rawData->GetBuffer();
540 end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
542 // continue with the next sub event if no data left in the payload
543 if (position >= end) continue;
545 if (fRequireHeader) {
546 // check that there are enough bytes left for the data header
547 if (position + sizeof(AliRawDataHeader) > end) {
548 result |= kErrNoDataHeader;
552 // check consistency of data size in the header and in the equipment
553 AliRawDataHeader* header = (AliRawDataHeader*) position;
554 if ((position + header->fSize) != end) {
555 Warning("ReadHeader",
556 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
557 equipment->GetEquipmentHeader()->GetId(),header->fSize, end - position);
558 header->fSize = end - position;