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 // TRD raw data conversion class //
22 ///////////////////////////////////////////////////////////////////////////////
29 #include "AliRawDataHeaderSim.h"
30 #include "AliRawReader.h"
32 #include "AliFstream.h"
33 #include "AliLoader.h"
34 #include "AliTreeLoader.h"
36 #include "AliTRDrawData.h"
37 #include "AliTRDdigitsManager.h"
38 #include "AliTRDgeometry.h"
39 #include "AliTRDarrayDictionary.h"
40 #include "AliTRDarrayADC.h"
41 #include "AliTRDrawStream.h"
42 #include "AliTRDcalibDB.h"
43 #include "AliTRDSignalIndex.h"
44 #include "AliTRDfeeParam.h"
45 #include "AliTRDmcmSim.h"
46 #include "AliTRDtrackletWord.h"
47 #include "AliTRDdigitsParam.h"
49 ClassImp(AliTRDrawData)
51 Int_t AliTRDrawData::fgDataSuppressionLevel = 0;
53 //_____________________________________________________________________________
54 AliTRDrawData::AliTRDrawData()
66 ,fMcmSim(new AliTRDmcmSim)
70 // Default constructor
73 fFee = AliTRDfeeParam::Instance();
74 fNumberOfDDLs = AliDAQ::NumberOfDdls("TRD");
78 //_____________________________________________________________________________
79 AliTRDrawData::AliTRDrawData(const AliTRDrawData &r)
91 ,fMcmSim(new AliTRDmcmSim)
98 fFee = AliTRDfeeParam::Instance();
99 fNumberOfDDLs = AliDAQ::NumberOfDdls("TRD");
103 //_____________________________________________________________________________
104 AliTRDrawData::~AliTRDrawData()
111 fTracklets->Delete();
124 //_____________________________________________________________________________
125 Bool_t AliTRDrawData::Digits2Raw(TTree *digitsTree, const TTree *tracks )
128 // Initialize necessary parameters and call one
129 // of the raw data simulator selected by SetRawVersion.
131 // Currently tracklet output is not spported yet and it
132 // will be supported in higher version simulator.
135 AliTRDdigitsManager* const digitsManager = new AliTRDdigitsManager();
137 if (!digitsManager->ReadDigits(digitsTree)) {
138 delete digitsManager;
142 if (tracks != NULL) {
143 delete digitsManager;
144 AliError("Tracklet input is not supported yet.");
148 fGeo = new AliTRDgeometry();
150 if (!AliTRDcalibDB::Instance()) {
151 AliError("Could not get calibration object");
153 delete digitsManager;
157 Int_t retval = kTRUE;
158 Int_t rv = fFee->GetRAWversion();
160 // Call appropriate Raw Simulator
161 if ( rv > 0 && rv <= 3 ) retval = Digits2Raw(digitsManager);
164 AliWarning(Form("Unsupported raw version (%d).", rv));
169 delete digitsManager;
175 //_____________________________________________________________________________
176 Bool_t AliTRDrawData::Digits2Raw(AliTRDdigitsManager *digitsManager)
179 // Raw data simulator for all versions > 0. This is prepared for real data.
180 // This version simulate only raw data with ADC data and not with tracklet.
183 const Int_t kMaxHcWords = (fGeo->TBmax()/3)
189 // Buffer to temporary store half chamber data
190 UInt_t *hcBuffer = new UInt_t[kMaxHcWords];
192 Bool_t newEvent = kFALSE; // only for correct readout tree
193 Bool_t newSM = kFALSE; // new SM flag, for writing SM index words
194 Bool_t newStack = kFALSE; // new stack flag, for writing stack index words
196 // Get digits parameter
197 fDigitsParam = digitsManager->GetDigitsParam();
199 // sect is same as iDDL, so I use only sect here.
200 for (Int_t sect = 0; sect < fGeo->Nsector(); sect++) {
203 snprintf(name,1024,"TRD_%d.ddl",sect + AliTRDrawStream::kDDLOffset);
205 AliFstream* of = new AliFstream(name);
207 // Write a dummy data header
208 AliRawDataHeaderSim header; // the event header
209 UInt_t hpos = of->Tellp();
210 of->WriteBuffer((char *) (& header), sizeof(header));
212 // Reset payload byte size (payload does not include header).
213 Int_t npayloadbyte = 0;
215 // check the existance of the data
216 // SM index word and Stack index word
217 UInt_t *iwbuffer = new UInt_t[109]; // index word buffer; max 109 = 2 SM headers + 67 dummy headers + 5*8 stack headers
219 UInt_t bStackMask = 0x0;
220 Bool_t bStackHasData = kFALSE;
221 Bool_t bSMHasData = kFALSE;
223 //iwbuffer[nheader++] = 0x0001a020; // SM index words
224 iwbuffer[nheader++] = 0x0044a020; // SM index words | additional SM header:48 = 1 SM header + 47 dummy words(for future use)
225 iwbuffer[nheader++] = 0x10404071; // SM header
226 for ( Int_t i=0; i<66; i++ ) iwbuffer[nheader++] = 0x00000000; // dummy words
227 iwbuffer[nheader++] = 0x10000000; // end of dummy words
229 for ( Int_t stack= 0; stack < fGeo->Nstack(); stack++) {
230 UInt_t linkMask = 0x0;
231 for( Int_t layer = 0; layer < fGeo->Nlayer(); layer++) {
232 Int_t iDet = fGeo->GetDetector(layer,stack,sect);
233 AliTRDarrayADC *digits = (AliTRDarrayADC *) digitsManager->GetDigits(iDet);
234 if ( fgDataSuppressionLevel==0 || digits->HasData() ) {
235 bStackMask = bStackMask | ( 1 << stack ); // active stack mask for new stack
236 linkMask = linkMask | ( 3 << (2*layer) ); // 3 = 0011
237 bStackHasData = kTRUE;
242 if ( fgDataSuppressionLevel==0 || bStackHasData ){
243 iwbuffer[nheader++] = 0x0007a000 | linkMask; // stack index word + link masks
244 if (fgDataSuppressionLevel==0) iwbuffer[nheader-1] = 0x0007afff; // no suppression
245 iwbuffer[nheader++] = 0x04045b01; // stack header
246 for (Int_t i=0;i<6;i++) iwbuffer[nheader++] = 0x00000000; // 6 dummy words
247 bStackHasData = kFALSE;
251 if ( fgDataSuppressionLevel==0 || bSMHasData ){
252 iwbuffer[0] = iwbuffer[0] | bStackMask; // add stack masks to SM index word
253 if (fgDataSuppressionLevel==0) iwbuffer[0] = 0x0044a03f; // no suppression : all stacks are active
254 of->WriteBuffer((char *) iwbuffer, nheader*4);
255 AliDebug(11, Form("SM %d index word: %08x", sect, iwbuffer[0]));
256 AliDebug(11, Form("SM %d header: %08x", sect, iwbuffer[1]));
258 // end of SM & stack header ------------------------------------------------------------------------
259 // -------------------------------------------------------------------------------------------------
261 // Prepare chamber data
262 for( Int_t stack = 0; stack < fGeo->Nstack(); stack++) {
263 for( Int_t layer = 0; layer < fGeo->Nlayer(); layer++) {
265 Int_t iDet = fGeo->GetDetector(layer,stack,sect);
267 newEvent = kTRUE; // it is expected that each event has at least one tracklet;
268 // this is only needed for correct readout tree
270 AliDebug(11, Form("New event!! Event counter: %d",fEventCounter));
273 if ( stack==0 && layer==0 ) newSM = kTRUE; // new SM flag
274 if ( layer==0 ) newStack = kTRUE; // new stack flag
275 AliDebug(15, Form("stack : %d, layer : %d, iDec : %d\n",stack,layer,iDet));
276 // Get the digits array
277 AliTRDarrayADC *digits = (AliTRDarrayADC *) digitsManager->GetDigits(iDet);
278 if (fgDataSuppressionLevel==0 || digits->HasData() ) { // second part is new!! and is for indicating a new event
280 if (digits->HasData()) digits->Expand();
284 // Process A side of the chamber
285 hcwords = ProduceHcData(digits,0,iDet,hcBuffer,kMaxHcWords,newEvent,newSM);
286 if ( newEvent ) newEvent = kFALSE;
287 //AssignLinkMask(hcBuffer, layer); // active link mask for this layer(2*HC)
288 of->WriteBuffer((char *) hcBuffer, hcwords*4);
289 npayloadbyte += hcwords*4;
291 // Process B side of the chamber
292 hcwords = ProduceHcData(digits,1,iDet,hcBuffer,kMaxHcWords,newEvent,newSM);
293 of->WriteBuffer((char *) hcBuffer, hcwords*4);
294 npayloadbyte += hcwords*4;
301 header.fSize = UInt_t(of->Tellp()) - hpos;
302 header.SetAttribute(0); // Valid data
303 of->Seekp(hpos); // Rewind to header position
304 of->WriteBuffer((char *) (& header), sizeof(header));
309 } // loop over sector(SM)
316 //_____________________________________________________________________________
317 void AliTRDrawData::ProduceSMIndexData(UInt_t *buf, Int_t& nw){
319 // This function generates
320 // 1) SM index words : ssssssss ssssssss vvvv rrrr r d t mmmmm
321 // - s : size of SM header (number of header, default = 0x0001)
322 // - v : SM header version (default = 0xa)
323 // - r : reserved for future use (default = 00000)
324 // - d : track data enabled bit (default = 0)
325 // - t : tracklet data enabled bit (default = 1)
326 // - m : stack mask (each bit corresponds a stack, default = 11111)
328 // 2) SM header : rrr c vvvv vvvvvvvv vvvv rrrr bbbbbbbb
329 // - r : reserved for future use (default = 000)
330 // - c : clean check out flag (default = 1)
331 // - v : hardware design revision (default = 0x0404)
332 // - r : reserved for future use (default = 0x0)
333 // - b : physical board ID (default = 0x71)
335 // 3) stack index words : ssssssss ssssssss vvvv mmmm mmmmmmmm
336 // - s : size of stack header (number of header, (default = 0x0007)
337 // - v : header version (default = 0xa)
338 // - m : link mask (default = 0xfff)
340 // 4) stack header : vvvvvvvv vvvvvvvv bbbbbbbb rrrr rrr c
341 // - v : hardware design revision (default = 0x0404)
342 // - b : physical board ID (default = 0x5b)
343 // - r : reserved for future use (default = 0000 000)
344 // - c : clean checkout flag (default = 1)
346 // and 6 dummy words(0x00000000)
349 //buf[nw++] = 0x0001a03f; // SM index words
350 fSMindexPos = nw; // memorize position of the SM index word for re-allocating stack mask
351 buf[nw++] = 0x0001a020; // SM index words
352 buf[nw++] = 0x10404071; // SM header
354 fStackindexPos = nw; // memorize position of the stack index word for future adding
356 for (Int_t istack=0; istack<5; istack++){
357 buf[nw++] = 0x0007afff; // stack index words
358 buf[nw++] = 0x04045b01; // stack header
359 for (Int_t i=0;i<6;i++) buf[nw++] = 0x00000000; // 6 dummy words
360 } // loop over 5 stacks
364 //_____________________________________________________________________________
365 void AliTRDrawData::AssignStackMask(UInt_t *buf, Int_t nStack){
367 // This function re-assign stack mask active(from 0 to 1) in the SM index word
369 buf[fSMindexPos] = buf[fSMindexPos] | ( 1 << nStack );
372 //_____________________________________________________________________________
373 Int_t AliTRDrawData::AddStackIndexWords(UInt_t *buf, Int_t /*nStack*/, Int_t nMax){
375 // This function add stack index words and stack header when there is data for the stack
377 // 1) stack index words : ssssssss ssssssss vvvv mmmm mmmmmmmm
378 // - s : size of stack header (number of header, (default = 0x0007)
379 // - v : header version (default = 0xa)
380 // - m : link mask (default = 0xfff)
381 // - m : link mask (starting value = 0x000)
383 // 2) stack header : vvvvvvvv vvvvvvvv bbbbbbbb rrrr rrr c
384 // - v : hardware design revision (default = 0x0404)
385 // - b : physical board ID (default = 0x5b)
386 // - r : reserved for future use (default = 0000 000)
387 // - c : clean checkout flag (default = 1)
389 // and 6 dummy words(0x00000000)
392 Int_t nAddedWords = 0; // Number of added words
393 if ( ShiftWords(buf, fStackindexPos, 8, nMax)== kFALSE ){
394 AliError("Adding stack header failed.");
398 buf[fStackindexPos++] = 0x0007a000; // stack index words
399 buf[fStackindexPos++] = 0x04045b01; // stack header
400 for (Int_t i=0;i<6;i++) buf[fStackindexPos++] = 0x00000000; // 6 dummy words
406 //_____________________________________________________________________________
407 void AliTRDrawData::AssignLinkMask(UInt_t *buf, Int_t nLayer){
409 // This function re-assign link mask active(from 0 to 1) in the stack index word
411 buf[fStackindexPos-8] = buf[fStackindexPos-8] | ( 3 << (2*nLayer) ); // 3 = 0011
414 //_____________________________________________________________________________
415 Bool_t AliTRDrawData::ShiftWords(UInt_t *buf, Int_t nStart, Int_t nWords, Int_t nMax){
417 // This function shifts n words
419 //if ( nStart+nWords > sizeof(buf)/sizeof(UInt_t) ){
420 // AliError("Words shift failed. No more buffer space.");
424 for ( Int_t iw=nMax; iw>nStart-1; iw--){
425 buf[iw+nWords] = buf[iw];
430 //_____________________________________________________________________________
431 Int_t AliTRDrawData::ProduceHcData(AliTRDarrayADC *digits, Int_t side, Int_t det, UInt_t *buf, Int_t maxSize, Bool_t /*newEvent = kFALSE*/, Bool_t /*newSM = kFALSE*/){
433 // This function produces the raw data for one HC, i.e. tracklets, tracklet endmarkers,
434 // raw data, raw data endmarkers.
435 // This function can be used for both ZS and NZS data
438 Int_t nw = 0; // Number of written words
439 Int_t of = 0; // Number of overflowed words
440 Int_t *tempnw = &nw; // Number of written words for temp. buffer
441 Int_t *tempof = &of; // Number of overflowed words for temp. buffer
442 Int_t layer = fGeo->GetLayer( det ); // Layer
443 Int_t stack = fGeo->GetStack( det ); // Stack
444 Int_t sect = fGeo->GetSector( det ); // Sector (=iDDL)
445 const Int_t kCtype = fGeo->GetStack(det) == 2 ? 0 : 1; // Chamber type (0:C0, 1:C1)
447 Bool_t trackletOn = fFee->GetTracklet(); // tracklet simulation active?
449 AliDebug(1,Form("Producing raw data for sect=%d layer=%d stack=%d side=%d",sect,layer,stack,side));
451 UInt_t *tempBuffer = buf; // tempBuffer used to write ADC data
452 // different in case of tracklet writing
455 tempBuffer = new UInt_t[maxSize];
456 tempnw = new Int_t(0);
457 tempof = new Int_t(0);
460 WriteIntermediateWords(tempBuffer,*tempnw,*tempof,maxSize,det,side);
462 if (digits->HasData()) {
463 // scanning direction such, that tracklet-words are sorted in ascending z and then in ascending y order
464 // ROB numbering on chamber and MCM numbering on ROB increase with decreasing z and increasing y
465 for (Int_t iRobRow = 0; iRobRow <= (kCtype + 3)-1; iRobRow++ ) {
466 // ROB number should be increasing
467 Int_t iRob = iRobRow * 2 + side;
469 for (Int_t iMcmRB = 0; iMcmRB < fGeo->MCMmax(); iMcmRB++ ) {
470 Int_t iMcm = 16 - 4*(iMcmRB/4 + 1) + (iMcmRB%4);
472 fMcmSim->Init(det, iRob, iMcm);
473 fMcmSim->SetData(digits); // no filtering done here (already done in digitizer)
476 Int_t tempNw = fMcmSim->ProduceTrackletStream(&buf[nw], maxSize - nw);
480 AliError(Form("Buffer overflow detected. Please increase the buffer size and recompile."));
485 fMcmSim->ZSMapping(); // Calculate zero suppression mapping
486 // at the moment it has to be rerun here
487 // Write MCM data to temp. buffer
488 Int_t tempNw = fMcmSim->ProduceRawStream( &tempBuffer[*tempnw], maxSize - *tempnw, fEventCounter );
491 *tempnw += maxSize - nw;
492 AliError(Form("Buffer overflow detected. Please increase the buffer size and recompile."));
499 // in case of tracklet writing copy temp data to final buffer
501 if (nw + *tempnw < maxSize) {
502 memcpy(&buf[nw], tempBuffer, *tempnw * sizeof(UInt_t));
506 AliError("Buffer overflow detected");
512 delete [] tempBuffer;
517 // Write end of raw data marker
518 if (nw+3 < maxSize) {
519 buf[nw++] = fgkEndOfDataMarker;
520 buf[nw++] = fgkEndOfDataMarker;
521 buf[nw++] = fgkEndOfDataMarker;
522 buf[nw++] = fgkEndOfDataMarker;
528 AliError("Buffer overflow. Data is truncated. Please increase buffer size and recompile.");
534 //_____________________________________________________________________________
535 AliTRDdigitsManager *AliTRDrawData::Raw2Digits(AliRawReader *rawReader)
538 // Vx of the raw data reading
541 rawReader->Select("TRD"); //[mj]
543 AliTRDarrayADC *digits = 0;
544 AliTRDarrayDictionary *track0 = 0;
545 AliTRDarrayDictionary *track1 = 0;
546 AliTRDarrayDictionary *track2 = 0;
548 //AliTRDSignalIndex *indexes = 0;
549 // Create the digits manager
550 AliTRDdigitsManager* digitsManager = new AliTRDdigitsManager();
551 digitsManager->CreateArrays();
553 AliTRDrawStream input(rawReader);
555 // ----- preparing tracklet output -----
556 AliDataLoader *trklLoader = AliRunLoader::Instance()->GetLoader("TRDLoader")->GetDataLoader("tracklets");
558 trklLoader = new AliDataLoader("TRD.Tracklets.root","tracklets", "tracklets");
559 AliRunLoader::Instance()->GetLoader("TRDLoader")->AddDataLoader(trklLoader);
564 AliTreeLoader *trklTreeLoader = dynamic_cast<AliTreeLoader*> (trklLoader->GetBaseLoader("tracklets-raw"));
565 if (!trklTreeLoader) {
566 trklTreeLoader = new AliTreeLoader("tracklets-raw", trklLoader);
567 trklLoader->AddBaseLoader(trklTreeLoader);
569 if (!trklTreeLoader) {
573 if (!trklTreeLoader->Tree())
574 trklTreeLoader->MakeTree();
576 input.SetTrackletArray(TrackletsArray());
577 input.SetTrackArray(TracksArray());
579 // Loop through the digits
584 det = input.NextChamber(digitsManager);
589 digits = (AliTRDarrayADC *) digitsManager->GetDigits(det);
590 track0 = (AliTRDarrayDictionary *) digitsManager->GetDictionary(det,0);
591 track1 = (AliTRDarrayDictionary *) digitsManager->GetDictionary(det,1);
592 track2 = (AliTRDarrayDictionary *) digitsManager->GetDictionary(det,2);
594 if (digits) digits->Compress();
595 if (track0) track0->Compress();
596 if (track1) track1->Compress();
597 if (track2) track2->Compress();
601 trklTreeLoader->WriteData("OVERWRITE");
602 trklLoader->UnloadAll();
604 return digitsManager;
607 //_____________________________________________________________________________
608 void AliTRDrawData::WriteIntermediateWords(UInt_t* buf, Int_t& nw, Int_t& of, const Int_t& maxSize, const Int_t& det, const Int_t& side) {
610 // write tracklet end marker(0x10001000)
611 // and half chamber headers(H[0] and H[1])
614 Int_t layer = fGeo->GetLayer( det ); // Layer
615 Int_t stack = fGeo->GetStack( det ); // Stack
616 Int_t sect = fGeo->GetSector( det ); // Sector (=iDDL)
617 Int_t rv = fFee->GetRAWversion();
618 const Int_t kNTBin = fDigitsParam->GetNTimeBins(det);
619 Bool_t trackletOn = fFee->GetTracklet();
622 // Write end of tracklet marker
624 buf[nw++] = fgkEndOfTrackletMarker;
625 buf[nw++] = fgkEndOfTrackletMarker; // the number of tracklet end marker should be more than 2
631 // Half Chamber header
632 // h[0] (there are 2 HC headers) xmmm mmmm nnnn nnnq qqss sssp ppcc ci01
633 // , where x : Raw version speacial number (=1)
634 // m : Raw version major number (test pattern, ZS, disable tracklet, 0, options)
635 // n : Raw version minor number
636 // q : number of addtional header words (default = 1)
637 // s : SM sector number (ALICE numbering)
638 // p : plane(layer) number
639 // c : chamber(stack) number
640 // i : side number (0:A, 1:B)
641 Int_t majorv = 0; // The major version number
642 Int_t minorv = 0; // The minor version number
643 Int_t add = 1; // The number of additional header words to follow : now 1, previous 2
644 Int_t tp = 0; // test pattern (default=0)
645 Int_t zs = (rv==3) ? 1 : 0; // zero suppression
646 Int_t dt = (trackletOn) ? 0 : 1; // disable tracklet
648 majorv = (tp<<6) | (zs<<5) | (dt<<4) | 1; // major version
650 x = (1<<31) | (majorv<<24) | (minorv<<17) | (add<<14) | (sect<<9) | (layer<<6) | (stack<<3) | (side<<2) | 1;
651 if (nw < maxSize) buf[nw++] = x; else of++;
653 // h[1] tttt ttbb bbbb bbbb bbbb bbpp pphh hh01
654 // , where t : number of time bins
655 // b : bunch crossing number
656 // p : pretrigger counter
657 // h : pretrigger phase
658 Int_t bcCtr = 99; // bunch crossing counter. Here it is set to 99 always for no reason
659 Int_t ptCtr = 15; // pretrigger counter. Here it is set to 15 always for no reason
660 Int_t ptPhase = 11; // pretrigger phase. Here it is set to 11 always for no reason
661 //x = (bcCtr<<16) | (ptCtr<<12) | (ptPhase<<8) | ((kNTBin-1)<<2) | 1; // old format
662 x = ((kNTBin)<<26) | (bcCtr<<10) | (ptCtr<<6) | (ptPhase<<2) | 1;
663 if (nw < maxSize) buf[nw++] = x; else of++;
666 TClonesArray *AliTRDrawData::TrackletsArray()
668 // Returns the array of on-line tracklets
671 fTracklets = new TClonesArray("AliTRDtrackletWord", 200);
676 TClonesArray* AliTRDrawData::TracksArray()
678 // return array of GTU tracks (create TClonesArray if necessary)
681 fTracks = new TClonesArray("AliESDTrdTrack",100);