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 **************************************************************************/
16 /** @file AliFMDReconstructor.cxx
17 @author Christian Holm Christensen <cholm@nbi.dk>
18 @date Mon Mar 27 12:47:09 2006
19 @brief FMD reconstruction
21 //____________________________________________________________________
23 // This is a class that constructs AliFMDRecPoint objects from of Digits
24 // This class reads either digits from a TClonesArray or raw data from
25 // a DDL file (or similar), and stores the read ADC counts in an
26 // internal cache (fAdcs). The rec-points are made via the naiive
29 //-- Authors: Evgeny Karpechev(INR) and Alla Maevsksia
30 // Latest changes by Christian Holm Christensen <cholm@nbi.dk>
33 //____________________________________________________________________
35 // #include <AliLog.h> // ALILOG_H
36 // #include <AliRun.h> // ALIRUN_H
37 #include "AliFMDDebug.h"
38 #include "AliFMDGeometry.h" // ALIFMDGEOMETRY_H
39 #include "AliFMDParameters.h" // ALIFMDPARAMETERS_H
40 #include "AliFMDAltroMapping.h" // ALIFMDALTROMAPPING_H
41 #include "AliFMDDigit.h" // ALIFMDDIGIT_H
42 #include "AliFMDSDigit.h" // ALIFMDDIGIT_H
43 #include "AliFMDReconstructor.h" // ALIFMDRECONSTRUCTOR_H
44 #include "AliFMDRecoParam.h" // ALIFMDRECOPARAM_H
45 #include "AliFMDRawReader.h" // ALIFMDRAWREADER_H
46 #include "AliFMDRecPoint.h" // ALIFMDMULTNAIIVE_H
47 #include "AliESDEvent.h" // ALIESDEVENT_H
48 #include "AliESDVertex.h" // ALIESDVERTEX_H
49 #include "AliESDTZERO.h" // ALIESDVERTEX_H
50 #include <AliESDFMD.h> // ALIESDFMD_H
56 #include "AliFMDESDRevertexer.h"
61 //____________________________________________________________________
62 ClassImp(AliFMDReconstructor)
64 ; // This is here to keep Emacs for indenting the next line
67 //____________________________________________________________________
68 AliFMDReconstructor::AliFMDReconstructor()
77 fVertexType(kNoVertex),
86 // Make a new FMD reconstructor object - default CTOR.
89 if (AliDebugLevel() > 0) fDiagnostics = kTRUE;
90 for(Int_t det = 1; det<=3; det++) {
96 //____________________________________________________________________
97 AliFMDReconstructor::~AliFMDReconstructor()
100 if (fMult) fMult->Delete();
101 if (fMult) delete fMult;
102 if (fESDObj) delete fESDObj;
105 //____________________________________________________________________
107 AliFMDReconstructor::Init()
109 // Initialize the reconstructor
111 // Initialize the geometry
112 AliFMDGeometry* geom = AliFMDGeometry::Instance();
114 geom->InitTransformations();
116 // Initialize the parameters
117 AliFMDParameters* param = AliFMDParameters::Instance();
120 // Current vertex position
122 // Create array of reconstructed strip multiplicities
123 fMult = new TClonesArray("AliFMDRecPoint", 51200);
124 // Create ESD output object
125 fESDObj = new AliESDFMD;
127 // Check if we need diagnostics histograms
128 if (!fDiagnostics) return;
129 AliInfo("Making diagnostics histograms");
130 fDiagStep1 = new TH2I("diagStep1", "Read ADC vs. Noise surpressed ADC",
131 1024, -.5, 1023.5, 1024, -.5, 1023.5);
132 fDiagStep1->SetDirectory(0);
133 fDiagStep1->GetXaxis()->SetTitle("ADC (read)");
134 fDiagStep1->GetYaxis()->SetTitle(Form("ADC (noise surpressed %4.f)",
136 fDiagStep2 = new TH2F("diagStep2", "ADC vs Edep deduced",
137 1024, -.5, 1023.5, 100, 0, 2);
138 fDiagStep2->SetDirectory(0);
139 fDiagStep2->GetXaxis()->SetTitle("ADC (noise surpressed)");
140 fDiagStep2->GetYaxis()->SetTitle("#Delta E [GeV]");
141 fDiagStep3 = new TH2F("diagStep3", "Edep vs Edep path corrected",
142 100, 0., 2., 100, 0., 2.);
143 fDiagStep3->SetDirectory(0);
144 fDiagStep3->GetXaxis()->SetTitle("#Delta E [GeV]");
145 fDiagStep3->GetYaxis()->SetTitle("#Delta E/#Delta x #times #delta x [GeV]");
146 fDiagStep4 = new TH2F("diagStep4", "Edep vs Multiplicity deduced",
147 100, 0., 2., 100, -.1, 19.9);
148 fDiagStep4->SetDirectory(0);
149 fDiagStep4->GetXaxis()->SetTitle("#Delta E/#Delta x #times #delta x [GeV]");
150 fDiagStep4->GetYaxis()->SetTitle("Multiplicity");
151 fDiagAll = new TH2F("diagAll", "Read ADC vs Multiplicity deduced",
152 1024, -.5, 1023.5, 100, -.1, 19.9);
153 fDiagAll->SetDirectory(0);
154 fDiagAll->GetXaxis()->SetTitle("ADC (read)");
155 fDiagAll->GetYaxis()->SetTitle("Multiplicity");
158 //____________________________________________________________________
160 AliFMDReconstructor::ConvertDigits(AliRawReader* reader,
161 TTree* digitsTree) const
163 // Convert Raw digits to AliFMDDigit's in a tree
164 AliFMDDebug(1, ("Reading raw data into digits tree"));
165 AliFMDRawReader rawRead(reader, digitsTree);
166 // rawRead.SetSampleRate(fFMD->GetSampleRate());
168 AliFMDAltroMapping* map = AliFMDParameters::Instance()->GetAltroMap();
169 for (size_t i = 1; i <= 3; i++) {
170 fZS[i] = rawRead.IsZeroSuppressed(map->Detector2DDL(i));
171 fZSFactor[i] = rawRead.NoiseFactor(map->Detector2DDL(i));
175 //____________________________________________________________________
177 AliFMDReconstructor::GetVertex(AliESDEvent* esd) const
179 // Return the vertex to use.
180 // This is obtained from the ESD object.
181 // If not found, a warning is issued.
182 fVertexType = kNoVertex;
186 const AliESDVertex* vertex = esd->GetPrimaryVertex();
187 if (!vertex) vertex = esd->GetPrimaryVertexSPD();
188 if (!vertex) vertex = esd->GetPrimaryVertexTPC();
189 if (!vertex) vertex = esd->GetVertex();
192 AliFMDDebug(2, ("Got %s (%s) from ESD: %f",
193 vertex->GetName(), vertex->GetTitle(), vertex->GetZv()));
194 fCurrentVertex = vertex->GetZv();
195 fVertexType = kESDVertex;
198 else if (esd->GetESDTZERO()) {
199 AliFMDDebug(2, ("Got primary vertex from T0: %f", esd->GetT0zVertex()));
200 fCurrentVertex = esd->GetT0zVertex();
201 fVertexType = kESDVertex;
204 AliWarning("Didn't get any vertex from ESD or generator");
207 //____________________________________________________________________
209 AliFMDReconstructor::GetIdentifier() const
211 return AliReconstruction::GetDetIndex(GetDetectorName());
214 //____________________________________________________________________
215 const AliFMDRecoParam*
216 AliFMDReconstructor::GetParameters() const
218 Int_t iDet = 12; // GetIdentifier();
219 const AliDetectorRecoParam* params = AliReconstructor::GetRecoParam(iDet);
220 if (!params || params->IsA() != AliFMDRecoParam::Class()) return 0;
221 return static_cast<const AliFMDRecoParam*>(params);
224 //____________________________________________________________________
226 AliFMDReconstructor::UseRecoParam(Bool_t set) const
228 static Float_t savedNoiseFactor = fNoiseFactor;
229 static Bool_t savedAngleCorrect = fAngleCorrect;
231 const AliFMDRecoParam* params = GetParameters();
233 fNoiseFactor = params->NoiseFactor();
234 fAngleCorrect = params->AngleCorrect();
238 fNoiseFactor = savedNoiseFactor;
239 fAngleCorrect = savedAngleCorrect;
244 //____________________________________________________________________
246 AliFMDReconstructor::Reconstruct(AliRawReader* reader, TTree*) const
248 // Reconstruct directly from raw data (no intermediate output on
249 // digit tree or rec point tree).
252 // reader Raw event reader
254 AliFMDDebug(1, ("Reconstructing from raw reader"));
255 AliFMDRawReader rawReader(reader, 0);
257 UShort_t det, sec, str, fac;
258 Short_t adc, oldDet = -1;
263 while (rawReader.NextSignal(det, rng, sec, str, adc, zs, fac)) {
266 fZSFactor[det-1] = fac;
269 ProcessSignal(det, rng, sec, str, adc);
271 UseRecoParam(kFALSE);
275 //____________________________________________________________________
277 AliFMDReconstructor::Digitize(AliRawReader* reader, TClonesArray* sdigits) const
279 // Reconstruct directly from raw data (no intermediate output on
280 // digit tree or rec point tree).
283 // reader Raw event reader
285 AliFMDRawReader rawReader(reader, 0);
287 UShort_t det, sec, str, sam, rat, fac;
288 Short_t adc, oldDet = -1;
293 while (rawReader.NextSample(det, rng, sec, str, sam, rat, adc, zs, fac)) {
294 if (!rawReader.SelectSample(sam, rat)) continue;
297 fZSFactor[det-1] = fac;
300 DigitizeSignal(sdigits, det, rng, sec, str, sam, adc);
302 UseRecoParam(kFALSE);
305 //____________________________________________________________________
307 AliFMDReconstructor::Reconstruct(TTree* digitsTree,
308 TTree* clusterTree) const
310 // Reconstruct event from digits in tree
311 // Get the FMD branch holding the digits.
312 // FIXME: The vertex may not be known yet, so we may have to move
313 // some of this to FillESD.
316 // digitsTree Pointer to a tree containing digits
317 // clusterTree Pointer to output tree
319 AliFMDDebug(1, ("Reconstructing from digits in a tree"));
322 static TClonesArray* digits = new TClonesArray("AliFMDDigit");
323 TBranch *digitBranch = digitsTree->GetBranch("FMD");
325 Error("Exec", "No digit branch for the FMD found");
328 // TClonesArray* digits = new TClonesArray("AliFMDDigit");
329 digitBranch->SetAddress(&digits);
331 if (fMult) fMult->Clear();
332 if (fESDObj) fESDObj->Clear();
335 fTreeR = clusterTree;
336 fTreeR->Branch("FMD", &fMult);
338 AliFMDDebug(5, ("Getting entry 0 from digit branch"));
339 digitBranch->GetEntry(0);
341 AliFMDDebug(5, ("Processing digits"));
343 ProcessDigits(digits);
344 UseRecoParam(kFALSE);
346 Int_t written = clusterTree->Fill();
347 AliFMDDebug(10, ("Filled %d bytes into cluster tree", written));
353 //____________________________________________________________________
355 AliFMDReconstructor::ProcessDigits(TClonesArray* digits) const
357 // For each digit, find the pseudo rapdity, azimuthal angle, and
358 // number of corrected ADC counts, and pass it on to the algorithms
362 // digits Array of digits
364 Int_t nDigits = digits->GetEntries();
365 AliFMDDebug(2, ("Got %d digits", nDigits));
366 fESDObj->SetNoiseFactor(fNoiseFactor);
367 fESDObj->SetAngleCorrected(fAngleCorrect);
368 for (Int_t i = 0; i < nDigits; i++) {
369 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
370 if (!digit) continue;
375 //____________________________________________________________________
377 AliFMDReconstructor::ProcessDigit(AliFMDDigit* digit) const
379 UShort_t det = digit->Detector();
380 Char_t rng = digit->Ring();
381 UShort_t sec = digit->Sector();
382 UShort_t str = digit->Strip();
383 Short_t adc = digit->Counts();
386 ProcessSignal(det, rng, sec, str, adc);
389 //____________________________________________________________________
391 AliFMDReconstructor::ProcessSignal(UShort_t det,
397 // Process the signal from a single strip
406 AliFMDParameters* param = AliFMDParameters::Instance();
407 // Check that the strip is not marked as dead
408 if (param->IsDead(det, rng, sec, str)) {
409 AliFMDDebug(1, ("FMD%d%c[%2d,%3d] is dead", det, rng, sec, str));
416 PhysicalCoordinates(det, rng, sec, str, eta, phi);
418 // Substract pedestal.
419 UShort_t counts = SubtractPedestal(det, rng, sec, str, adc);
420 if(counts == USHRT_MAX) return;
422 // Gain match digits.
423 Double_t edep = Adc2Energy(det, rng, sec, str, eta, counts);
424 // Get rid of nonsense energy
427 // Make rough multiplicity
428 Double_t mult = Energy2Multiplicity(det, rng, sec, str, edep);
429 // Get rid of nonsense mult
431 AliWarning(Form("The mutliplicity in FMD%d%c[%2d,%3d]=%f > 20 "
432 "(ADC: %d, Energy: %f)", det, rng, sec, str, mult,
435 if (mult < 0) return;
436 AliFMDDebug(10, ("FMD%d%c[%2d,%3d]: "
437 "ADC: %d, Counts: %d, Energy: %f, Mult: %f",
438 det, rng, sec, str, adc, counts, edep, mult));
440 // Create a `RecPoint' on the output branch.
443 new ((*fMult)[fNMult]) AliFMDRecPoint(det, rng, sec, str,
444 eta, phi, edep, mult);
445 (void)m; // Suppress warnings about unused variables.
449 fESDObj->SetMultiplicity(det, rng, sec, str, mult);
450 fESDObj->SetEta(det, rng, sec, str, eta);
452 if (fDiagAll) fDiagAll->Fill(adc, mult);
456 //____________________________________________________________________
458 AliFMDReconstructor::DigitizeSignal(TClonesArray* sdigits,
466 // Process the signal from a single strip
475 AliFMDParameters* param = AliFMDParameters::Instance();
476 // Check that the strip is not marked as dead
477 if (param->IsDead(det, rng, sec, str)) {
478 AliFMDDebug(10, ("FMD%d%c[%2d,%3d] is dead", det, rng, sec, str));
482 // Substract pedestal.
483 UShort_t counts = SubtractPedestal(det, rng, sec, str, adc);
484 if(counts == USHRT_MAX || counts == 0) return;
486 // Gain match digits.
487 Double_t edep = Adc2Energy(det, rng, sec, str, counts);
488 // Get rid of nonsense energy
491 Int_t n = sdigits->GetEntriesFast();
492 // AliFMDSDigit* sdigit =
494 AliFMDSDigit(det, rng, sec, str, edep, counts, counts, counts, counts);
495 // sdigit->SetCount(sam, counts);
498 //____________________________________________________________________
500 AliFMDReconstructor::SubtractPedestal(UShort_t det,
507 UShort_t zsNoiseFactor) const
509 AliFMDParameters* param = AliFMDParameters::Instance();
510 Float_t ped = (zsEnabled ? 0 :
511 param->GetPedestal(det, rng, sec, str));
512 Float_t noise = param->GetPedestalWidth(det, rng, sec, str);
513 if(ped < 0 || noise < 0) {
514 AliWarningClass(Form("Invalid pedestal (%f) or noise (%f) "
515 "for FMD%d%c[%02d,%03d]",
516 ped, noise, det, rng, sec, str));
519 AliDebugClass(15, Form("Subtracting pedestal for FMD%d%c[%2d,%3d]=%4d "
520 "(%s w/factor %d, noise factor %f, "
521 "pedestal %8.2f+/-%8.2f)",
522 det, rng, sec, str, adc,
523 (zsEnabled ? "zs'ed" : "straight"),
524 zsNoiseFactor, noiseFactor, ped, noise));
526 Int_t counts = adc + Int_t(zsEnabled ? zsNoiseFactor * noise : - ped);
527 counts = TMath::Max(Int_t(counts), 0);
528 // Calculate the noise factor for suppressing remenants of the noise
529 // peak. If we have done on-line zero suppression, we only check
530 // for noise signals that are larger than the suppressed noise. If
531 // the noise factor used on line is larger than the factor used
532 // here, we do not do this check at all.
535 // Online factor | Read factor | Result
536 // ---------------+--------------+-------------------------------
537 // 2 | 3 | Check if signal > 1 * noise
538 // 3 | 3 | Check if signal > 0
539 // 3 | 2 | Check if signal > 0
541 // In this way, we make sure that we do not suppress away too much
542 // data, and that the read-factor is the most stringent cut.
543 Float_t nf = TMath::Max(0.F, noiseFactor - (zsEnabled ? zsNoiseFactor : 0));
544 if (counts < noise * nf) counts = 0;
545 if (counts > 0) AliDebugClass(15, "Got a hit strip");
547 UShort_t ret = counts < 0 ? 0 : counts;
552 //____________________________________________________________________
554 AliFMDReconstructor::SubtractPedestal(UShort_t det,
560 // Member function to subtract the pedestal from a digit
567 // adc # of ADC counts
569 // Pedestal subtracted signal or USHRT_MAX in case of problems
571 UShort_t counts = SubtractPedestal(det, rng, sec, str, adc,
572 fNoiseFactor, fZS[det-1],
574 if (fDiagStep1) fDiagStep1->Fill(adc, counts);
579 //____________________________________________________________________
581 AliFMDReconstructor::Adc2Energy(UShort_t det,
585 UShort_t count) const
587 // Converts number of ADC counts to energy deposited.
588 // Note, that this member function can be overloaded by derived
589 // classes to do strip-specific look-ups in databases or the like,
590 // to find the proper gain for a strip.
592 // In the first simple version, we calculate the energy deposited as
594 // EnergyDeposited = cos(theta) * gain * count
599 // gain = ----------------- * Energy_deposited_per_MIP
602 // is constant and the same for all strips.
604 // For the production we use the conversion measured in the NBI lab.
605 // The total conversion is then:
610 // => energy = ----------------
618 // counts Number of ADC counts over pedestal
620 // The energy deposited in a single strip, or -1 in case of problems
622 if (count <= 0) return 0;
623 AliFMDParameters* param = AliFMDParameters::Instance();
624 Float_t gain = param->GetPulseGain(det, rng, sec, str);
625 // 'Tagging' bad gains as bad energy
627 AliWarning(Form("Invalid gain (%f) for FMD%d%c[%02d,%03d]",
628 gain, det, rng, sec, str));
631 AliFMDDebug(5, ("Converting counts %d to energy (factor=%f, DAC2MIP=%f)",
632 count, gain,param->GetDACPerMIP()));
634 Double_t edep = ((count * param->GetEdepMip())
635 / (gain * param->GetDACPerMIP()));
639 //____________________________________________________________________
641 AliFMDReconstructor::Adc2Energy(UShort_t det,
646 UShort_t count) const
648 // Converts number of ADC counts to energy deposited.
649 // Note, that this member function can be overloaded by derived
650 // classes to do strip-specific look-ups in databases or the like,
651 // to find the proper gain for a strip.
653 // In the first simple version, we calculate the energy deposited as
655 // EnergyDeposited = cos(theta) * gain * count
660 // gain = ----------------- * Energy_deposited_per_MIP
663 // is constant and the same for all strips.
665 // For the production we use the conversion measured in the NBI lab.
666 // The total conversion is then:
671 // => energy = ----------------
679 // eta Psuedo-rapidity
680 // counts Number of ADC counts over pedestal
682 // The energy deposited in a single strip, or -1 in case of problems
684 Double_t edep = Adc2Energy(det, rng, sec, str, count);
686 if (fDiagStep2) fDiagStep2->Fill(count, edep);
688 Double_t theta = 2 * TMath::ATan(TMath::Exp(-eta));
689 Double_t corr = TMath::Abs(TMath::Cos(theta));
690 Double_t cedep = corr * edep;
691 AliFMDDebug(10, ("correcting for path %f * %f = %f (eta=%f, theta=%f)",
692 edep, corr, cedep, eta, theta));
693 if (fDiagStep3) fDiagStep3->Fill(edep, cedep);
699 //____________________________________________________________________
701 AliFMDReconstructor::Energy2Multiplicity(UShort_t /*det*/,
707 // Converts an energy signal to number of particles.
708 // Note, that this member function can be overloaded by derived
709 // classes to do strip-specific look-ups in databases or the like,
710 // to find the proper gain for a strip.
712 // In this simple version, we calculate the multiplicity as
714 // multiplicity = Energy_deposited / Energy_deposited_per_MIP
718 // Energy_deposited_per_MIP = 1.664 * SI_density * SI_thickness
720 // is constant and the same for all strips
727 // edep Energy deposited in a single strip
729 // The "bare" multiplicity corresponding to the energy deposited
730 AliFMDParameters* param = AliFMDParameters::Instance();
731 Double_t edepMIP = param->GetEdepMip();
732 Float_t mult = edep / edepMIP;
735 AliFMDDebug(15, ("Translating energy %f to multiplicity via "
736 "divider %f->%f", edep, edepMIP, mult));
738 if (fDiagStep4) fDiagStep4->Fill(edep, mult);
742 //____________________________________________________________________
744 AliFMDReconstructor::PhysicalCoordinates(UShort_t det,
751 // Get the eta and phi of a digit
758 // eta On return, contains the psuedo-rapidity of the strip
759 // phi On return, contains the azimuthal angle of the strip
761 AliFMDGeometry* geom = AliFMDGeometry::Instance();
762 Double_t x, y, z, r, theta;
763 geom->Detector2XYZ(det, rng, sec, str, x, y, z);
764 // Correct for vertex offset.
766 phi = TMath::ATan2(y, x);
767 r = TMath::Sqrt(y * y + x * x);
768 theta = TMath::ATan2(r, z);
769 eta = -TMath::Log(TMath::Tan(theta / 2));
774 //____________________________________________________________________
776 AliFMDReconstructor::FillESD(TTree* /* digitsTree */,
777 TTree* /* clusterTree */,
778 AliESDEvent* esd) const
780 // nothing to be done
781 // FIXME: The vertex may not be known when Reconstruct is executed,
782 // so we may have to move some of that member function here.
783 AliFMDDebug(2, ("Calling FillESD with two trees and one ESD"));
786 Double_t oldVz = fCurrentVertex;
788 if (fVertexType != kNoVertex) {
789 AliFMDDebug(2, ("Revertexing the ESD data to vz=%f (was %f)",
790 fCurrentVertex, oldVz));
791 AliFMDESDRevertexer revertexer;
792 revertexer.Revertex(fESDObj, fCurrentVertex);
796 AliFMDDebug(2, ("Writing FMD data to ESD tree"));
797 esd->SetFMDData(fESDObj);
800 if (!fDiagnostics || !esd) return;
801 static bool first = true;
802 // This is most likely NOT the event number you'd like to use. It
803 // has nothing to do with the 'real' event number.
804 // - That's OK. We just use it for the name of the directory -
805 // nothing else. Christian
806 Int_t evno = esd->GetEventNumberInFile();
807 AliFMDDebug(3, ("Writing diagnostics histograms to FMD.Diag.root/%03d",evno));
808 TFile f("FMD.Diag.root", (first ? "RECREATE" : "UPDATE"));
811 TDirectory* d = f.mkdir(Form("%03d", evno),
812 Form("Diagnostics histograms for event # %d", evno));
814 if (fDiagStep1) fDiagStep1->Write();
815 if (fDiagStep2) fDiagStep2->Write();
816 if (fDiagStep3) fDiagStep3->Write();
817 if (fDiagStep4) fDiagStep4->Write();
818 if (fDiagAll) fDiagAll->Write();
823 if (fDiagStep1) fDiagStep1->Reset();
824 if (fDiagStep2) fDiagStep2->Reset();
825 if (fDiagStep3) fDiagStep3->Reset();
826 if (fDiagStep4) fDiagStep4->Reset();
827 if (fDiagAll) fDiagAll->Reset();
830 //____________________________________________________________________
832 AliFMDReconstructor::FillESD(AliRawReader*, TTree* clusterTree,
833 AliESDEvent* esd) const
836 FillESD(dummy, clusterTree, esd);
838 //____________________________________________________________________