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 "AliRawEventHeader.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()->GetType();
198 UInt_t AliRawReaderRoot::GetRunNumber() const
200 // get the run number from the event header
202 if (!fEvent) return 0;
203 return fEvent->GetHeader()->GetRunNumber();
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()->GetId();
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()->GetTriggerPattern();
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()->GetDetectorPattern();
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()->GetTypeAttribute();
238 UInt_t AliRawReaderRoot::GetLDCId() const
240 // get the LDC Id from the event header
242 if (!fEvent || !fSubEvent) return 0;
243 return fSubEvent->GetHeader()->GetLDCId();
246 UInt_t AliRawReaderRoot::GetGDCId() const
248 // get the GDC Id from the event header
250 if (!fEvent) return 0;
251 return fEvent->GetHeader()->GetGDCId();
255 Int_t AliRawReaderRoot::GetEquipmentSize() const
257 // get the size of the equipment
259 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
260 return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
263 Int_t AliRawReaderRoot::GetEquipmentType() const
265 // get the type from the equipment header
267 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
268 return fEquipment->GetEquipmentHeader()->GetEquipmentType();
271 Int_t AliRawReaderRoot::GetEquipmentId() const
273 // get the ID from the equipment header
275 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
276 return fEquipment->GetEquipmentHeader()->GetId();
279 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
281 // get the attributes from the equipment header
283 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
284 return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
287 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
289 // get the basic element size from the equipment header
291 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
292 return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
296 Bool_t AliRawReaderRoot::ReadHeader()
298 // read a data header at the current position
299 // returns kFALSE if the data header could not be read
302 if (!fEvent) return kFALSE;
305 // skip payload (if event was not selected)
306 if (fCount > 0) fPosition += fCount;
308 // get the first or the next equipment if at the end of an equipment
309 if (!fEquipment || (fPosition >= fEnd)) {
311 // get the first or the next sub event if at the end of a sub event
312 if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
314 // check for end of event data
315 if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
316 fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
318 // check the magic word of the sub event
319 if (!fSubEvent->GetHeader()->IsValid()) {
320 Error("ReadHeader", "wrong magic number in sub event!");
321 fSubEvent->GetHeader()->Dump();
322 fErrorCode = kErrMagic;
331 // get the next equipment and raw data
333 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
334 if (!fEquipment) continue;
335 fRawData = fEquipment->GetRawData();
340 fPosition = (UChar_t*) fRawData->GetBuffer();
341 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
344 // continue with the next equipment if no data left in the payload
345 if (fPosition >= fEnd) continue;
347 // check that there are enough bytes left for the data header
348 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
349 Error("ReadHeader", "could not read data header!");
350 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
351 fEquipment->GetEquipmentHeader()->Dump();
354 fErrorCode = kErrNoDataHeader;
358 // "read" the data header
359 fHeader = (AliRawDataHeader*) fPosition;
360 fPosition += sizeof(AliRawDataHeader);
361 if (fHeader->fSize != 0xFFFFFFFF) {
362 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
364 fCount = fEnd - fPosition;
367 // check consistency of data size in the header and in the sub event
368 if (fPosition + fCount > fEnd) {
369 Error("ReadHeader", "size in data header exceeds event size!");
370 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
371 fEquipment->GetEquipmentHeader()->Dump();
374 fErrorCode = kErrSize;
378 } while (!IsSelected());
383 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
385 // reads the next payload at the current position
386 // returns kFALSE if the data could not be read
389 while (fCount == 0) {
390 if (!ReadHeader()) return kFALSE;
398 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
400 // reads the next block of data at the current position
401 // returns kFALSE if the data could not be read
404 if (fPosition + size > fEnd) {
405 Error("ReadNext", "could not read data!");
406 fErrorCode = kErrOutOfBounds;
409 memcpy(data, fPosition, size);
416 Bool_t AliRawReaderRoot::Reset()
418 // reset the current position to the beginning of the event
428 fPosition = fEnd = NULL;
433 Bool_t AliRawReaderRoot::NextEvent()
435 // go to the next event in the root file
437 if (!fFile) return kFALSE;
440 if (fBranch->GetEntry(fEventIndex+1) <= 0) {
442 fEvent = new AliRawEvent;
443 fBranch->SetAddress(&fEvent);
447 } while (!IsEventSelected());
451 Bool_t AliRawReaderRoot::RewindEvents()
453 // go back to the beginning of the root file
455 if (!fFile) return kFALSE;
459 fEvent = new AliRawEvent;
460 fBranch->SetAddress(&fEvent);
465 Int_t AliRawReaderRoot::CheckData() const
467 // check the consistency of the data
469 if (!fEvent) return 0;
471 AliRawEvent* subEvent = NULL;
472 Int_t subEventIndex = 0;
473 AliRawEquipment* equipment = NULL;
474 Int_t equipmentIndex = 0;
475 UChar_t* position = 0;
480 // get the first or the next sub event if at the end of an equipment
481 if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
483 // check for end of event data
484 if (subEventIndex >= fEvent->GetNSubEvents()) return result;
485 subEvent = fEvent->GetSubEvent(subEventIndex++);
487 // check the magic word of the sub event
488 if (!fSubEvent->GetHeader()->IsValid()) {
496 // get the next equipment and raw data
497 equipment = subEvent->GetEquipment(equipmentIndex++);
498 if (!equipment) continue;
499 AliRawData* rawData = equipment->GetRawData();
500 if (!rawData) continue;
501 position = (UChar_t*) rawData->GetBuffer();
502 end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
504 // continue with the next sub event if no data left in the payload
505 if (position >= end) continue;
507 // check that there are enough bytes left for the data header
508 if (position + sizeof(AliRawDataHeader) > end) {
509 result |= kErrNoDataHeader;
513 // check consistency of data size in the header and in the equipment
514 AliRawDataHeader* header = (AliRawDataHeader*) position;
515 if (header->fSize != 0xFFFFFFFF) {
516 if (position + header->fSize > end) {