1 /**************************************************************************
2 * Copyright(c) 2008, Christian Holm Christensen *
4 * Author: Christian Holm Christensen. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation for any purposes is hereby granted without fee, *
9 * provided that the above copyright notice appears in all copies and *
10 * that both the copyright notice and this permission notice remains *
11 * intact. The authors make no claims about the suitability of this *
12 * software for any purpose. It is provided "as is" without express or *
14 **************************************************************************/
16 /** @file AliEveFMDLoader.cxx
17 @author Christian Holm Christensen <cholm@nbi.dk>
18 @date Sun Mar 26 17:59:18 2006
19 @brief Implementation of AliEveFMDLoader singleton class
21 //____________________________________________________________________
23 // Forward Multiplicity Detector based on Silicon wafers. This class
24 // is the loader for the event display.
26 // This class is a singleton, meaning that there's only one instance
27 // of this. This is done to speed up the processing by putting all
28 // things that are needed every time into the constructor.
30 #include "AliRunLoader.h"
31 #include "AliEveEventManager.h"
32 #include "AliEveFMDLoader.h"
33 #include "AliFMDUShortMap.h"
34 #include "AliFMDBoolMap.h"
35 #include "AliFMDGeometry.h"
36 #include "AliFMDParameters.h"
37 #include "AliFMDDetector.h"
38 #include "AliFMDRing.h"
39 #include "AliFMDBaseDigit.h"
40 #include "AliFMDDigit.h"
41 #include "AliFMDRawReader.h"
42 #include "AliFMDHit.h"
43 #include "AliESDEvent.h"
44 #include "AliESDFMD.h"
46 #include "AliRawReader.h"
47 #include <TClonesArray.h>
49 #include <TGeoShape.h>
50 #include <TGeoManager.h>
51 #include <TEveGeoNode.h>
52 #include <TEveBoxSet.h>
53 #include <TEveQuadSet.h>
54 #include <TEveManager.h>
60 // Some very private variables.
63 const Char_t* kDetector = "FMD%d";
64 const Char_t* kRing = "FMD%d%c";
65 const Char_t* kModule = "FMD%d%c[%02d-%02d]";
66 const Char_t* kSector = "FMD%d%c[%02d] %s";
68 const Char_t* kHits = "Hits";
69 const Char_t* kDigits = "Digits";
70 const Char_t* kRaw = "Raw";
71 const Char_t* kESD = "ESD";
75 //____________________________________________________________________
76 AliEveFMDLoader* AliEveFMDLoader::fgInstance = 0;
78 //____________________________________________________________________
79 AliEveFMDLoader* AliEveFMDLoader::Instance()
81 // Get the singleton instance. If the instance has not been
82 // instantised yet, it will be after this call.
84 fgInstance = new AliEveFMDLoader();
88 //____________________________________________________________________
89 AliEveFMDLoader::AliEveFMDLoader(const char* name, Bool_t useBoxes,
91 : TEveElementList(name, 0),
93 fDigitPalette(0, 1023),
95 fUseBoxDigits(useBoxes),
96 fHitCache("AliFMDHit",0),
97 fDigitCache("AliFMDDigit", 0),
98 fRawCache("AliFMDDigit", 0)
102 // @param name Name of the folder.
103 // @param useBoxes Whether to use boxes or Quads for the signals
104 // @param old Whether to enable reading old RCU data format
106 // increase reference count
109 // Increase reference counts on palettes
110 fHitPalette.IncRefCount();
111 fDigitPalette.IncRefCount();
112 fMultPalette.IncRefCount();
115 // Initialize the FMD geometry manager
116 TGeoManager* geoMan = AliEveEventManager::AssertGeometry();
118 geoMan->GetTopVolume()->cd(0);
120 AliFMDGeometry* geom = AliFMDGeometry::Instance();
122 geom->InitTransformations();
124 AliFMDParameters* pars = AliFMDParameters::Instance();
125 // pars->UseRcuTrailer(!old);
126 // pars->UseCompleteHeader(old);
127 // pars->SetSampleRate(4);
128 pars->Init(kFALSE, 0);
131 TGeoShape* inner = static_cast<TGeoShape*>(gGeoManager->GetListOfShapes()
132 ->FindObject("FMDI_physical_sensor"));
133 if (!inner) throw TEveException("Shape of inner type sensors not found");
134 TGeoShape* outer = static_cast<TGeoShape*>(gGeoManager->GetListOfShapes()
135 ->FindObject("FMDO_physical_sensor"));
136 if (!outer) throw TEveException("Shape of outer type sensors not found");
138 // Emulate reference counting
139 inner->SetUniqueID(1000);
140 outer->SetUniqueID(1000);
142 // Loop over detectors
143 for (UShort_t d = 1; d <= 3; d++) {
144 AliFMDDetector* detector = geom->GetDetector(d);
145 if (!detector) continue;
146 TEveElementList* ed = new TEveElementList(Form(kDetector,
149 ed->IncDenyDestroy();
150 ed->SetUserData(detector);
153 Char_t rings[] = { 'I', 'O', 0 };
154 Char_t* pr = &(rings[0]);
156 AliFMDRing* ring = detector->GetRing(*pr);
159 TEveElementList* er = new TEveElementList(Form(kRing,
163 er->IncDenyDestroy();
164 er->SetUserData(ring);
166 // UShort_t nsec = ring->GetNSectors();
167 // UShort_t nstr = ring->GetNStrips();
168 UShort_t nmod = ring->GetNModules();
170 for (UShort_t m = 0; m < nmod; m++) {
171 TEveGeoShape* em = new TEveGeoShape(Form(kModule,
176 em->SetTransMatrix(*(detector->FindTransform(ring->GetId(), 2*m)));
177 em->SetShape(ring->GetId() == 'I' ? inner : outer);
178 em->SetMainColor(Color_t(kGray));
179 em->SetMainTransparency(32);
180 em->IncDenyDestroy();
181 ModuleData* data = new ModuleData;
182 data->fScaledSum = 0;
183 em->SetUserData(data);
186 for (UShort_t s = 2*m; s < 2*m+2 && s < nsec; s++) {
187 TEveDigitSet* eb = MakeDigitSet(Form(kSector,
189 ring->GetId(), s), nstr);
191 eb->SetEmitSignals(kFALSE);
192 eb->SetPickable(kTRUE);
193 // eb->SetOwnIds(kTRUE);
194 } // for (UShort_t s ...)
196 } // for (UShort_t m ...)
198 } // for (UShort_t d ...)
201 //____________________________________________________________________
202 AliEveFMDLoader::~AliEveFMDLoader()
205 AliWarning("AliEveFMDLoader being destroyed!");
208 //____________________________________________________________________
210 AliEveFMDLoader::RemoveFromListTrees(TEveElement* el)
212 // Called when the element should be removed from the list. We
213 // overload this to allow clearing of signals.
215 // @param el Tree to remove from.
217 // Since we're most likely setting up for a new event, we clear all
218 // signals here - a little tricky, but it works(tm).
219 ClearDigitSets("All");
221 // Do normal TEveElement::RemoveElement
222 return TEveElementList::RemoveFromListTrees(el);
224 //____________________________________________________________________
226 AliEveFMDLoader::RemoveParent(TEveElement* el)
228 // Called when the element should be removed from the list. We
229 // overload this to allow clearing of signals.
231 // @param el Parent to remove from.
232 TEveElementList::RemoveParent(el);
235 //____________________________________________________________________
237 AliEveFMDLoader::MakeDigitSet(const char* name, UShort_t nstr)
239 // Make a digit set. The type of digit set depends on the setting
240 // of fUseBoxDigits. If this is true, we return a TEveBoxSet,
241 // otherwise a TEveQuadSet
244 // nstr The number of strips
246 // newly allocated digit set
247 TEveDigitSet* ret = 0;
249 TEveBoxSet* boxes = new TEveBoxSet(name);
250 // boxes->Reset(TEveBoxSet::kBT_AABox, kFALSE, nstr);
251 boxes->Reset(TEveBoxSet::kBT_FreeBox, kFALSE, nstr);
255 TEveQuadSet* quads = new TEveQuadSet(name);
256 quads->Reset(TEveQuadSet::kQT_RectangleXY, kFALSE, nstr);
262 //____________________________________________________________________
264 AliEveFMDLoader::ClearDigitSets(const char* type)
266 // Clear signals of some type.
268 // @param type Type of signals to clear
269 // Type can be one of
277 for (TEveElement::List_i di = BeginChildren();
278 di != EndChildren(); ++di) {
279 for (TEveElement::List_i ri = (*di)->BeginChildren();
280 ri != (*di)->EndChildren(); ++ri) {
281 for (TEveElement::List_i mi = (*ri)->BeginChildren();
282 mi != (*ri)->EndChildren(); ++mi) {
283 ModuleData* data = static_cast<ModuleData*>((*mi)->GetUserData());
284 data->fScaledSum = 0;
285 (*mi)->SetMainColor(Color_t(kGray));
286 if (stype == "All") {
287 (*mi)->RemoveElements();
290 for (TEveElement::List_i si = (*mi)->BeginChildren();
291 si != (*mi)->EndChildren(); ++si) {
292 TEveDigitSet* signals = static_cast<TEveDigitSet*>((*si));
293 if (!signals) continue;
294 TString s(signals->GetName());
295 if (!s.Contains(type)) continue;
296 (*mi)->RemoveElement(signals);
303 //____________________________________________________________________
305 AliEveFMDLoader::FindDigitSet(const char* t, UShort_t d, Char_t r, UShort_t s)
307 // Find a digit set corresponding to the passed parameters. If it
308 // is not found, one is created
310 // @param type Type of data
314 // @return a digit set
315 TEveElement* detector = FindChild(Form(kDetector, d));
317 AliError(Form("Detector %s not found", Form(kDetector, d)));
321 TEveElement* ring = detector->FindChild(Form(kRing, d, r));
323 AliError(Form("Ring %s not found", Form(kRing, d, r)));
328 TEveElement* module = ring->FindChild(Form(kModule, d, r, mod, mod+1));
330 AliError(Form("Module %s not found", Form(kModule, d, r, s, s+1)));
334 TEveElement* sector = module->FindChild(Form(kSector, d, r, s, t));
335 TEveDigitSet* signal = static_cast<TEveDigitSet*>(sector);
337 AliFMDRing* rng = AliFMDGeometry::Instance()->GetRing(r);
338 signal = MakeDigitSet(Form(kSector, d, r, s, t), rng->GetNStrips());
339 module->AddElement(signal);
340 signal->SetEmitSignals(kFALSE);
341 signal->SetPickable(kTRUE);
343 if (t == kHits) signal->SetPalette(&fHitPalette);
344 else if (t == kDigits) signal->SetPalette(&fDigitPalette);
345 else if (t == kRaw) signal->SetPalette(&fDigitPalette);
346 else if (t == kESD) {
347 signal->SetPalette(&fMultPalette);
348 signal->SetOwnIds(kTRUE);
354 //____________________________________________________________________
356 AliEveFMDLoader::AddSignal(const char* t,
357 UShort_t det, Char_t rng, UShort_t sec,
358 UShort_t str, Float_t signal, Float_t min,
359 Float_t max, TObject* ref)
361 // Add a signal to a digit set
363 // @param type Type of data
364 // @param det Detector
368 // @param signal Signal value
369 // @param min Minimum of this kind of signal
370 // @param max Maximum of this kind of signal
371 // @param ref Reference object
372 AliFMDGeometry* geom = AliFMDGeometry::Instance();
374 geom->Detector2XYZ(det, rng, sec, str, x, y, z);
375 AddSignal(t, det, rng, sec, str, x, y, z, signal, min, max, ref);
378 //____________________________________________________________________
380 AliEveFMDLoader::AddSignal(const char* t,
381 UShort_t det, Char_t rng, UShort_t sec,
382 UShort_t str, Double_t x, Double_t y, Double_t z,
383 Float_t signal, Float_t min, Float_t max,
386 // Add a signal to a digit set, with known (x,y,z) coordinates
387 // (this is for hits)
389 // @param type Type of data
390 // @param det Detector
394 // @param x X coordinate
395 // @param y Y coordinate
396 // @param z Z coordinate
397 // @param signal Signal value
398 // @param min Minimum of this kind of signal
399 // @param max Maximum of this kind of signal
400 // @param ref Reference object
401 AliFMDGeometry* geom = AliFMDGeometry::Instance();
402 AliFMDRing* ring = geom->GetRing(rng);
405 TEveDigitSet* signals = FindDigitSet(t, det, rng, sec);
407 AliWarning(Form("No signal (%s) found for FMD%d%c[%02d,%03d]",
408 t, det, rng, sec, str));
412 Float_t scaled = TMath::Min((signal - min) / (max - min) * 10., 10.);
413 if ((scaled - min) < 1e-6) {
414 // Very small (scalled) signals are ignored
415 AliDebug(10, Form("Skipping small %s signal at FMD%d%c[%02d,%03d]=%f (s-min=%f<1e-6)",
416 t, det, rng, sec, str, signal, scaled-min));
419 Double_t w = 2*ring->GetPitch();
420 Int_t value = int(TMath::Nint(signal));
421 AliDebug(5, Form("New %s signal at FMD%d%c[%02d,%03d]=%f (v=%d, s=%f)",
422 t, det, rng, sec, str, signal, value, scaled));
423 AddDigit(signals, x, y, z, w, scaled, value, ref);
426 //____________________________________________________________________
428 AliEveFMDLoader::AddDigit(TEveDigitSet* signals,
429 Double_t x, Double_t y, Double_t z,
430 Double_t w, Float_t scaled, Int_t value,
433 // Add a digit to a digit set.
435 // @param signals Digit set.
436 // @param x X coordinate
437 // @param y Y coordinate
438 // @param z Z coordinate
439 // @param w strip pitch
440 // @param scaled Scaled value
441 // @param value Signal value
442 // @param ref Reference object
444 TEveBoxSet* boxes = static_cast<TEveBoxSet*>(signals);
446 Float_t zc = (z > 0 ? -1 : 1) * scaled + z;
447 Float_t vs[] = { -fw, -5*fw, zc-scaled, // Lower back left
448 +fw, -5*fw, zc-scaled, // Lower back right
449 +fw, +5*fw, zc-scaled, // Lower front right
450 -fw, +5*fw, zc-scaled, // Lower front left
451 -fw, -5*fw, zc+scaled, // Upper back left
452 +fw, -5*fw, zc+scaled, // Upper back right
453 +fw, +5*fw, zc+scaled, // Upper front right
454 -fw, +5*fw, zc+scaled }; // Upper front left
455 Float_t ang = TMath::ATan2(y,x);
456 for (size_t i = 0; i < 8; i++) {
457 Float_t bx = vs[3*i+0];
458 Float_t by = vs[3*i+1];
459 Float_t ca = TMath::Cos(ang);
460 Float_t sa = TMath::Sin(ang);
461 vs[3*i+0] = bx * ca - by * sa + x;
462 vs[3*i+1] = bx * sa + by * ca + y;
464 // boxes->AddBox(x, y, (z > 0 ? -scaled : 0) + z , 5*w, w, scaled);
466 boxes->DigitValue(value);
467 if (ref) boxes->DigitId(ref);
470 TEveQuadSet* quads = static_cast<TEveQuadSet*>(signals);
471 quads->AddQuad(x,y,z,w,w);
472 quads->QuadValue(value);
473 if (ref) quads->QuadId(ref);
475 TEveElement* par = *(signals->BeginParents());
476 ModuleData* data = static_cast<ModuleData*>(par->GetUserData());
478 switch (signals->GetName()[4]) {
479 case 'I': case 'i': maxD = 2 * 512; break;
480 case 'O': case 'o': maxD = 2 * 256; break;
483 data->fScaledSum += scaled / maxD;
485 //____________________________________________________________________
487 AliEveFMDLoader::SummarizeModule(TEveElement* module)
489 // Modify color of module according to the summed signal
490 ModuleData* data = static_cast<ModuleData*>(module->GetUserData());
491 Float_t sum = data->fScaledSum / module->NumChildren();
493 module->SetMainColor(Color_t(kGray));
494 module->SetMainAlpha(0);
501 * 1/N 1/M_max S_i^N S_j^M_i x_ij
503 * where i runs over the number (N) of digit sets in the module
504 * (zero or more of Hits, Digits, Raw, ESD, i.e., in the range from
505 * 0 to 4), j runs over the number of digits (M_i) in a single digit
506 * set, M_max is the possible number of digits sets in each module
507 * (2*256 for outer rings, 2*512 for inner rings), and x_ij is the
508 * scaled signal (according to the colour palette for the signal in
509 * question) multiplied by 10 i.e.,
511 * x_ij = 10 * (s_ij - s_min,i) / (s_max,i - s_min,i)
513 * Here, s_ij is the basic signal (E-loss, ADC, or multiplicity),
514 * and s_min,i and s_max,i are the corresponding limits.
516 * Hence, the scaled sum above is in the range from 0 to 10.
518 * To use one of the palettes, we need to scale this number to the
519 * range set in the palette and cast it to an integer.
521 int min = fMultPalette.GetMinVal();
522 int max = fMultPalette.GetMaxVal();
523 int cidx = int(sum/10 * (max-min) + min);
525 fMultPalette.ColorFromValue(cidx, pix, false);
526 module->SetMainColorRGB(pix[0], pix[1], pix[2]);
527 module->SetMainAlpha(0.33);
530 //____________________________________________________________________
532 AliEveFMDLoader::SummarizeModules()
534 // Summarize the signals in the all the modules, and modify
535 // the module colour accordingly
537 for (TEveElement::List_i di = BeginChildren();
538 di != EndChildren(); ++di) {
539 for (TEveElement::List_i ri = (*di)->BeginChildren();
540 ri != (*di)->EndChildren(); ++ri) {
541 for (TEveElement::List_i mi = (*ri)->BeginChildren();
542 mi != (*ri)->EndChildren(); ++mi) {
544 TEveElement* module = *mi;
545 SummarizeModule(module);
550 //____________________________________________________________________
552 AliEveFMDLoader::CheckAdd()
554 // check if we shoul re-add ourselves to the current event node
555 TEveElement* event = gEve->GetCurrentEvent();
557 if (event && event->FindChild(GetName())) return;
558 gEve->AddElement(this);
562 //____________________________________________________________________
564 AliEveFMDLoader::LoadHits()
566 // Load and display hits
567 ClearDigitSets(kHits);
569 AliRunLoader* rl = AliEveEventManager::AssertRunLoader();
571 AliError("No run loader");
576 TTree* ht = rl->GetTreeH("FMD", false);
578 AliError("No FMD tree");
582 TClonesArray* hits = &fHitCache;
584 ht->SetBranchAddress("FMD", &hits);
586 Float_t min = fHitPalette.GetMinVal();
587 Float_t max = fHitPalette.GetMaxVal();
589 Int_t nTracks = ht->GetEntriesFast();
590 for (Int_t i = 0; i < nTracks; i++) {
591 Int_t hitRead = ht->GetEntry(i);
592 if (hitRead <= 0) continue;
594 Int_t nHit = hits->GetEntriesFast();
595 if (nHit <= 0) continue;
597 for (Int_t j = 0; j < nHit; j++) {
598 AliFMDHit* hit = static_cast<AliFMDHit*>(hits->At(j));
602 hit->Detector(), hit->Ring(), hit->Sector(), hit->Strip(),
603 hit->X(), hit->Y(), hit->Z(), int(hit->Edep()*1000),
610 //____________________________________________________________________
612 AliEveFMDLoader::DoLoadDigits(const char* t, TClonesArray* digits)
614 // Do the actual display of digits
616 // @param type What to show
617 // @param digits The digits
618 Float_t min = fDigitPalette.GetMinVal();
619 Float_t max = fDigitPalette.GetMaxVal();
621 Int_t n = digits->GetEntriesFast();
622 for (Int_t i = 0; i < n; i++) {
623 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
625 AddSignal(t, digit->Detector(), digit->Ring(), digit->Sector(),
626 digit->Strip(), digit->Counts(), min, max, digit);
631 //____________________________________________________________________
633 AliEveFMDLoader::LoadDigits()
635 // Load and display simulated digits
636 ClearDigitSets(kDigits);
638 AliRunLoader* rl = AliEveEventManager::AssertRunLoader();
640 AliError("No run-loader");
644 rl->LoadDigits("FMD");
645 TTree* dt = rl->GetTreeD("FMD", false);
647 AliError("No FMD tree");
651 TClonesArray* digits = &fDigitCache;
653 dt->SetBranchAddress("FMD", &digits);
655 Int_t read = dt->GetEntry(0);
657 AliWarning("Nothing read");
660 DoLoadDigits(kDigits, digits);
664 //____________________________________________________________________
666 AliEveFMDLoader::LoadRaw()
668 // Load and display raw digits
669 ClearDigitSets(kRaw);
671 AliRawReader* rr = AliEveEventManager::AssertRawReader();
673 AliError("No raw-reader");
677 AliFMDRawReader* fr = new AliFMDRawReader(rr, 0);
678 TClonesArray* digits = &fRawCache;
681 fr->ReadAdcs(digits);
683 DoLoadDigits(kRaw, digits);
686 //____________________________________________________________________
688 AliEveFMDLoader::LoadESD()
690 // Load and display ESD information
692 ClearDigitSets(kESD);
694 AliESDEvent* esd = AliEveEventManager::AssertESD();
700 AliESDFMD* fmd = esd->GetFMDData();
702 AliError("No FMD ESD data");
706 Float_t min = fMultPalette.GetMinVal();
707 Float_t max = fMultPalette.GetMaxVal();
709 for (UShort_t det = 1; det <= 3; det++) {
710 Char_t rings[] = { 'I', (det == 1 ? '\0' : 'O'), '\0' };
711 for (Char_t* rng = rings; *rng != '\0'; rng++) {
712 UShort_t nsec = (*rng == 'I' ? 20 : 40);
713 UShort_t nstr = (*rng == 'I' ? 512 : 256);
714 for (UShort_t sec = 0; sec < nsec; sec++) {
715 for (UShort_t str = 0; str < nstr; str++) {
716 Float_t mult = fmd->Multiplicity(det,*rng,sec,str);
717 if (mult == AliESDFMD::kInvalidMult) continue;
718 Float_t eta = fmd->Eta(det,*rng,sec,str);
720 // As it was before, it causes big memory leak:
721 // AddSignal(kESD, det, *rng, sec, str, mult, min, max,
722 // new TNamed(Form("FMD%d%c[%02d,%03d]", det, *rng, sec, str),
723 // Form("Mch=%f, eta=%f", mult, eta)));
725 // I propose to replace it with:
726 TNamed *tmpNamed = new TNamed(Form("FMD%d%c[%02d,%03d]", det, *rng, sec, str),Form("Mch=%f, eta=%f", mult, eta));
727 AddSignal(kESD, det, *rng, sec, str, mult, min, max,tmpNamed);
728 if(tmpNamed)delete tmpNamed;
738 //____________________________________________________________________