2 /**************************************************************************
3 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5 * Author: The ALICE Off-line Project. *
6 * Contributors are mentioned in the code where appropriate. *
8 * Permission to use, copy, modify and distribute this software and its *
9 * documentation strictly for non-commercial purposes is hereby granted *
10 * without fee, provided that the above copyright notice appears in all *
11 * copies and that both the copyright notice and this permission notice *
12 * appear in the supporting documentation. The authors make no claims *
13 * about the suitability of this software for any purpose. It is *
14 * provided "as is" without express or implied warranty. *
15 **************************************************************************/
19 ///////////////////////////////////////////////////////////////////////////////
21 // TRD cluster finder //
23 ///////////////////////////////////////////////////////////////////////////////
30 #include "AliRunLoader.h"
31 #include "AliLoader.h"
32 #include "AliRawReader.h"
35 #include "AliTRDclusterizerV1.h"
36 #include "AliTRDgeometry.h"
37 #include "AliTRDdataArrayF.h"
38 #include "AliTRDdataArrayI.h"
39 #include "AliTRDdigitsManager.h"
40 #include "AliTRDpadPlane.h"
41 #include "AliTRDrawData.h"
42 #include "AliTRDcalibDB.h"
43 #include "AliTRDSimParam.h"
44 #include "AliTRDRecParam.h"
45 #include "AliTRDCommonParam.h"
46 #include "AliTRDcluster.h"
48 #include "Cal/AliTRDCalROC.h"
49 #include "Cal/AliTRDCalDet.h"
51 ClassImp(AliTRDclusterizerV1)
53 //_____________________________________________________________________________
54 AliTRDclusterizerV1::AliTRDclusterizerV1()
59 // AliTRDclusterizerV1 default constructor
64 //_____________________________________________________________________________
65 AliTRDclusterizerV1::AliTRDclusterizerV1(const Text_t *name, const Text_t *title)
66 :AliTRDclusterizer(name,title)
67 ,fDigitsManager(new AliTRDdigitsManager())
70 // AliTRDclusterizerV1 constructor
73 fDigitsManager->CreateArrays();
77 //_____________________________________________________________________________
78 AliTRDclusterizerV1::AliTRDclusterizerV1(const AliTRDclusterizerV1 &c)
83 // AliTRDclusterizerV1 copy constructor
88 //_____________________________________________________________________________
89 AliTRDclusterizerV1::~AliTRDclusterizerV1()
92 // AliTRDclusterizerV1 destructor
96 delete fDigitsManager;
97 fDigitsManager = NULL;
102 //_____________________________________________________________________________
103 AliTRDclusterizerV1 &AliTRDclusterizerV1::operator=(const AliTRDclusterizerV1 &c)
106 // Assignment operator
109 if (this != &c) ((AliTRDclusterizerV1 &) c).Copy(*this);
114 //_____________________________________________________________________________
115 void AliTRDclusterizerV1::Copy(TObject &c) const
121 ((AliTRDclusterizerV1 &) c).fDigitsManager = 0;
123 AliTRDclusterizer::Copy(c);
127 //_____________________________________________________________________________
128 Bool_t AliTRDclusterizerV1::ReadDigits()
131 // Reads the digits arrays from the input aliroot file
135 AliError("No run loader available");
139 AliLoader* loader = fRunLoader->GetLoader("TRDLoader");
140 if (!loader->TreeD()) {
141 loader->LoadDigits();
144 // Read in the digit arrays
145 return (fDigitsManager->ReadDigits(loader->TreeD()));
149 //_____________________________________________________________________________
150 Bool_t AliTRDclusterizerV1::ReadDigits(AliRawReader *rawReader)
153 // Reads the digits arrays from the ddl file
157 fDigitsManager = raw.Raw2Digits(rawReader);
163 //_____________________________________________________________________________
164 Bool_t AliTRDclusterizerV1::MakeClusters()
167 // Generates the cluster.
178 AliTRDdataArrayI *digitsIn;
179 AliTRDdataArrayI *tracksIn;
182 AliTRDgeometry *geo = AliTRDgeometry::GetGeometry(fRunLoader);
184 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
186 AliFatal("No AliTRDcalibDB instance available\n");
190 AliTRDSimParam *simParam = AliTRDSimParam::Instance();
192 AliError("No AliTRDSimParam instance available\n");
196 AliTRDRecParam *recParam = AliTRDRecParam::Instance();
198 AliError("No AliTRDRecParam instance available\n");
202 AliTRDCommonParam *commonParam = AliTRDCommonParam::Instance();
204 AliError("Could not get common parameters\n");
209 Float_t ADCthreshold = simParam->GetADCthreshold();
210 // Threshold value for the maximum
211 Float_t maxThresh = recParam->GetClusMaxThresh();
212 // Threshold value for the digit signal
213 Float_t sigThresh = recParam->GetClusSigThresh();
215 // Detector wise calibration object for t0
216 const AliTRDCalDet *calT0Det = calibration->GetT0Det();
218 // Iteration limit for unfolding procedure
219 const Float_t kEpsilon = 0.01;
220 const Int_t kNclus = 3;
221 const Int_t kNsig = 5;
222 const Int_t kNdict = AliTRDdigitsManager::kNDict;
223 const Int_t kNtrack = kNdict * kNclus;
227 Double_t ratioLeft = 1.0;
228 Double_t ratioRight = 1.0;
230 Int_t iClusterROC = 0;
232 Double_t padSignal[kNsig];
233 Double_t clusterSignal[kNclus];
234 Double_t clusterPads[kNclus];
237 Int_t chamEnd = AliTRDgeometry::Ncham();
239 Int_t planEnd = AliTRDgeometry::Nplan();
241 Int_t sectEnd = AliTRDgeometry::Nsect();
242 Int_t nTimeTotal = calibration->GetNumberOfTimeBins();
244 Int_t dummy[9] = { 0, 0, 0, 0, 0, 0, 0, 0, 0 };
246 AliDebug(1,Form("Number of Time Bins = %d.\n",nTimeTotal));
248 // Start clustering in every chamber
249 for (icham = chamBeg; icham < chamEnd; icham++) {
250 for (iplan = planBeg; iplan < planEnd; iplan++) {
251 for (isect = sectBeg; isect < sectEnd; isect++) {
253 Int_t idet = geo->GetDetector(iplan,icham,isect);
256 digitsIn = fDigitsManager->GetDigits(idet);
257 // This is to take care of switched off super modules
258 if (digitsIn->GetNtime() == 0) {
262 AliTRDdataArrayI *tracksTmp = fDigitsManager->GetDictionary(idet,0);
265 Int_t nRowMax = commonParam->GetRowMax(iplan,icham,isect);
266 Int_t nColMax = commonParam->GetColMax(iplan);
268 AliTRDpadPlane *padPlane = commonParam->GetPadPlane(iplan,icham);
270 // Calibration object with pad wise values for t0
271 AliTRDCalROC *calT0ROC = calibration->GetT0ROC(idet);
272 // Calibration value for chamber wise t0
273 Float_t calT0DetValue = calT0Det->GetValue(idet);
276 Int_t nClusters2pad = 0;
277 Int_t nClusters3pad = 0;
278 Int_t nClusters4pad = 0;
279 Int_t nClusters5pad = 0;
280 Int_t nClustersLarge = 0;
282 // Apply the gain and the tail cancelation via digital filter
283 AliTRDdataArrayF *digitsOut = new AliTRDdataArrayF(digitsIn->GetNrow()
285 ,digitsIn->GetNtime());
286 Transform(digitsIn,digitsOut,idet,nRowMax,nColMax,nTimeTotal,ADCthreshold);
288 // Input digits are not needed any more
289 digitsIn->Compress(1,0);
291 // Loop through the chamber and find the maxima
292 for ( row = 0; row < nRowMax; row++) {
293 for ( col = 2; col < nColMax; col++) {
294 for (time = 0; time < nTimeTotal; time++) {
296 Float_t signalL = TMath::Abs(digitsOut->GetDataUnchecked(row,col ,time));
297 Float_t signalM = TMath::Abs(digitsOut->GetDataUnchecked(row,col-1,time));
298 Float_t signalR = TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time));
300 // Look for the maximum
301 if (signalM >= maxThresh) {
302 if ((TMath::Abs(signalL) <= signalM) &&
303 (TMath::Abs(signalR) < signalM)) {
304 if ((TMath::Abs(signalL) >= sigThresh) ||
305 (TMath::Abs(signalR) >= sigThresh)) {
306 // Maximum found, mark the position by a negative signal
307 digitsOut->SetDataUnchecked(row,col-1,time,-signalM);
315 tracksTmp->Compress(1,0);
317 // The index to the first cluster of a given ROC
318 Int_t firstClusterROC = -1;
319 // The number of cluster in a given ROC
320 Int_t nClusterROC = 0;
322 // Now check the maxima and calculate the cluster position
323 for ( row = 0; row < nRowMax ; row++) {
324 for (time = 0; time < nTimeTotal; time++) {
325 for ( col = 1; col < nColMax-1; col++) {
328 if (digitsOut->GetDataUnchecked(row,col,time) < 0.0) {
330 for (iPad = 0; iPad < kNclus; iPad++) {
331 Int_t iPadCol = col - 1 + iPad;
332 clusterSignal[iPad] =
333 TMath::Abs(digitsOut->GetDataUnchecked(row,iPadCol,time));
336 // Count the number of pads in the cluster
341 while (TMath::Abs(digitsOut->GetDataUnchecked(row,col-ii ,time)) >= sigThresh) {
344 if (col-ii < 0) break;
348 while (TMath::Abs(digitsOut->GetDataUnchecked(row,col+ii+1,time)) >= sigThresh) {
351 if (col+ii+1 >= nColMax) break;
377 // Look for 5 pad cluster with minimum in the middle
378 Bool_t fivePadCluster = kFALSE;
379 if (col < (nColMax - 3)) {
380 if (digitsOut->GetDataUnchecked(row,col+2,time) < 0) {
381 fivePadCluster = kTRUE;
383 if ((fivePadCluster) && (col < (nColMax - 5))) {
384 if (digitsOut->GetDataUnchecked(row,col+4,time) >= sigThresh) {
385 fivePadCluster = kFALSE;
388 if ((fivePadCluster) && (col > 1)) {
389 if (digitsOut->GetDataUnchecked(row,col-2,time) >= sigThresh) {
390 fivePadCluster = kFALSE;
396 // Modify the signal of the overlapping pad for the left part
397 // of the cluster which remains from a previous unfolding
399 clusterSignal[0] *= ratioLeft;
404 // Unfold the 5 pad cluster
405 if (fivePadCluster) {
406 for (iPad = 0; iPad < kNsig; iPad++) {
407 padSignal[iPad] = TMath::Abs(digitsOut->GetDataUnchecked(row
411 // Unfold the two maxima and set the signal on
412 // the overlapping pad to the ratio
413 ratioRight = Unfold(kEpsilon,iplan,padSignal);
414 ratioLeft = 1.0 - ratioRight;
415 clusterSignal[2] *= ratioRight;
420 Double_t clusterCharge = clusterSignal[0]
424 // The position of the cluster
425 clusterPads[0] = row + 0.5;
426 // Take the shift of the additional time bins into account
427 clusterPads[2] = time + 0.5;
429 if (recParam->LUTOn()) {
430 // Calculate the position of the cluster by using the
431 // lookup table method
432 clusterPads[1] = recParam->LUTposition(iplan,clusterSignal[0]
437 // Calculate the position of the cluster by using the
438 // center of gravity method
439 for (Int_t i = 0; i < kNsig; i++) {
442 padSignal[2] = TMath::Abs(digitsOut->GetDataUnchecked(row,col ,time)); // Central pad
443 padSignal[1] = TMath::Abs(digitsOut->GetDataUnchecked(row,col-1,time)); // Left pad
444 padSignal[3] = TMath::Abs(digitsOut->GetDataUnchecked(row,col+1,time)); // Right pad
446 (TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time)) < padSignal[1])) {
447 padSignal[0] = TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time));
449 if ((col < nColMax - 3) &&
450 (TMath::Abs(digitsOut->GetDataUnchecked(row,col+2,time)) < padSignal[3])) {
451 padSignal[4] = TMath::Abs(digitsOut->GetDataUnchecked(row,col+2,time));
453 clusterPads[1] = GetCOG(padSignal);
456 Double_t q0 = clusterSignal[0];
457 Double_t q1 = clusterSignal[1];
458 Double_t q2 = clusterSignal[2];
459 Double_t clusterSigmaY2 = (q1 * (q0 + q2) + 4.0 * q0 * q2)
460 / (clusterCharge*clusterCharge);
463 // Calculate the position and the error
466 // Correct for t0 (sum of chamber and pad wise values !!!)
467 Float_t calT0ROCValue = calT0ROC->GetValue(col,row);
468 Int_t clusterTimeBin = TMath::Nint(time - (calT0DetValue + calT0ROCValue));
469 Double_t colSize = padPlane->GetColSize(col);
470 Double_t rowSize = padPlane->GetRowSize(row);
472 Double_t clusterPos[3];
473 clusterPos[0] = padPlane->GetColPos(col) - (clusterPads[1] + 0.5) * colSize;
474 clusterPos[1] = padPlane->GetRowPos(row) - 0.5 * rowSize;
475 clusterPos[2] = CalcXposFromTimebin(clusterPads[2],idet,col,row);
476 Double_t clusterSig[2];
477 clusterSig[0] = (clusterSigmaY2 + 1.0/12.0) * colSize*colSize;
478 clusterSig[1] = rowSize * rowSize / 12.0;
480 // Add the cluster to the output array
481 // The track indices will be stored later
482 AliTRDcluster *cluster = AddCluster(clusterPos
491 // Store the amplitudes of the pads in the cluster for later analysis
492 Short_t signals[7] = { 0, 0, 0, 0, 0, 0, 0 };
493 for (Int_t jPad = col-3; jPad <= col+3; jPad++) {
495 (jPad >= nColMax-1)) {
498 signals[jPad-col+3] = TMath::Nint(TMath::Abs(digitsOut->GetDataUnchecked(row,jPad,time)));
500 cluster->SetSignals(signals);
502 // Temporarily store the row, column and time bin of the center pad
503 // Used to later on assign the track indices
504 cluster->SetLabel( row,0);
505 cluster->SetLabel( col,1);
506 cluster->SetLabel(time,2);
508 // Store the index of the first cluster in the current ROC
509 if (firstClusterROC < 0) {
510 firstClusterROC = RecPoints()->GetEntriesFast() - 1;
512 // Count the number of cluster in the current ROC
515 } // if: Maximum found ?
517 } // loop: pad columns
524 // Add the track indices to the found clusters
527 // Temporary array to collect the track indices
528 Int_t *idxTracks = new Int_t[kNtrack*nClusterROC];
530 // Loop through the dictionary arrays one-by-one
531 // to keep memory consumption low
532 for (Int_t iDict = 0; iDict < kNdict; iDict++) {
534 tracksIn = fDigitsManager->GetDictionary(idet,iDict);
537 // Loop though the clusters found in this ROC
538 for (iClusterROC = 0; iClusterROC < nClusterROC; iClusterROC++) {
540 AliTRDcluster *cluster = (AliTRDcluster *)
541 RecPoints()->UncheckedAt(firstClusterROC+iClusterROC);
542 row = cluster->GetLabel(0);
543 col = cluster->GetLabel(1);
544 time = cluster->GetLabel(2);
546 for (iPad = 0; iPad < kNclus; iPad++) {
547 Int_t iPadCol = col - 1 + iPad;
548 Int_t index = tracksIn->GetDataUnchecked(row,iPadCol,time) - 1;
549 idxTracks[3*iPad+iDict + iClusterROC*kNtrack] = index;
554 // Compress the arrays
555 tracksIn->Compress(1,0);
559 // Copy the track indices into the cluster
560 // Loop though the clusters found in this ROC
561 for (iClusterROC = 0; iClusterROC < nClusterROC; iClusterROC++) {
563 AliTRDcluster *cluster = (AliTRDcluster *)
564 RecPoints()->UncheckedAt(firstClusterROC+iClusterROC);
565 cluster->SetLabel(-9999,0);
566 cluster->SetLabel(-9999,1);
567 cluster->SetLabel(-9999,2);
569 cluster->AddTrackIndex(&idxTracks[iClusterROC*kNtrack]);
575 // Write the cluster and reset the array
587 //_____________________________________________________________________________
588 Double_t AliTRDclusterizerV1::GetCOG(Double_t signal[5])
592 // Used for clusters with more than 3 pads - where LUT not applicable
595 Double_t sum = signal[0]
601 Double_t res = (0.0 * (-signal[0] + signal[4])
602 + (-signal[1] + signal[3])) / sum;
608 //_____________________________________________________________________________
609 Double_t AliTRDclusterizerV1::Unfold(Double_t eps, Int_t plane, Double_t *padSignal)
612 // Method to unfold neighbouring maxima.
613 // The charge ratio on the overlapping pad is calculated
614 // until there is no more change within the range given by eps.
615 // The resulting ratio is then returned to the calling method.
618 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
620 AliError("No AliTRDcalibDB instance available\n");
625 Int_t itStep = 0; // Count iteration steps
627 Double_t ratio = 0.5; // Start value for ratio
628 Double_t prevRatio = 0.0; // Store previous ratio
630 Double_t newLeftSignal[3] = { 0.0, 0.0, 0.0 }; // Array to store left cluster signal
631 Double_t newRightSignal[3] = { 0.0, 0.0, 0.0 }; // Array to store right cluster signal
632 Double_t newSignal[3] = { 0.0, 0.0, 0.0 };
634 // Start the iteration
635 while ((TMath::Abs(prevRatio - ratio) > eps) && (itStep < 10)) {
640 // Cluster position according to charge ratio
641 Double_t maxLeft = (ratio*padSignal[2] - padSignal[0])
642 / (padSignal[0] + padSignal[1] + ratio*padSignal[2]);
643 Double_t maxRight = (padSignal[4] - (1-ratio)*padSignal[2])
644 / ((1.0 - ratio)*padSignal[2] + padSignal[3] + padSignal[4]);
646 // Set cluster charge ratio
647 irc = calibration->PadResponse(1.0,maxLeft ,plane,newSignal);
648 Double_t ampLeft = padSignal[1] / newSignal[1];
649 irc = calibration->PadResponse(1.0,maxRight,plane,newSignal);
650 Double_t ampRight = padSignal[3] / newSignal[1];
652 // Apply pad response to parameters
653 irc = calibration->PadResponse(ampLeft ,maxLeft ,plane,newLeftSignal );
654 irc = calibration->PadResponse(ampRight,maxRight,plane,newRightSignal);
656 // Calculate new overlapping ratio
657 ratio = TMath::Min((Double_t)1.0,newLeftSignal[2] /
658 (newLeftSignal[2] + newRightSignal[0]));
666 //_____________________________________________________________________________
667 void AliTRDclusterizerV1::Transform(AliTRDdataArrayI *digitsIn
668 , AliTRDdataArrayF *digitsOut
669 , Int_t idet, Int_t nRowMax
670 , Int_t nColMax, Int_t nTimeTotal
671 , Float_t ADCthreshold)
675 // Apply tail cancelation: Transform digitsIn to digitsOut
682 AliTRDRecParam *recParam = AliTRDRecParam::Instance();
684 AliError("No AliTRDRecParam instance available\n");
687 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
689 AliError("No AliTRDcalibDB instance available\n");
693 Double_t *inADC = new Double_t[nTimeTotal]; // ADC data before tail cancellation
694 Double_t *outADC = new Double_t[nTimeTotal]; // ADC data after tail cancellation
696 AliDebug(1,Form("Tail cancellation (nExp = %d) for detector %d.\n"
697 ,recParam->GetTCnexp(),idet));
699 // Calibration object with chamber wise values for the gain factor
700 const AliTRDCalDet *calGainFactorDet = calibration->GetGainFactorDet();
701 // Calibration object with pad wise values for the gain factor
702 AliTRDCalROC *calGainFactorROC = calibration->GetGainFactorROC(idet);
703 // Calibration value for chamber wise gain factors
704 Float_t calGainFactorDetValue = calGainFactorDet->GetValue(idet);
706 for (iRow = 0; iRow < nRowMax; iRow++ ) {
707 for (iCol = 0; iCol < nColMax; iCol++ ) {
709 Float_t calGainFactorROCValue = calGainFactorROC->GetValue(iCol,iRow);
710 Double_t gain = calGainFactorDetValue
711 * calGainFactorROCValue;
713 for (iTime = 0; iTime < nTimeTotal; iTime++) {
718 inADC[iTime] = digitsIn->GetDataUnchecked(iRow,iCol,iTime);
719 inADC[iTime] /= gain;
720 outADC[iTime] = inADC[iTime];
724 // Apply the tail cancelation via the digital filter
725 if (recParam->TCOn()) {
726 DeConvExp(inADC,outADC,nTimeTotal,recParam->GetTCnexp());
729 for (iTime = 0; iTime < nTimeTotal; iTime++) {
731 // Store the amplitude of the digit if above threshold
732 if (outADC[iTime] > ADCthreshold) {
733 digitsOut->SetDataUnchecked(iRow,iCol,iTime,outADC[iTime]);
748 //_____________________________________________________________________________
749 void AliTRDclusterizerV1::DeConvExp(Double_t *source, Double_t *target
750 , Int_t n, Int_t nexp)
753 // Tail cancellation by deconvolution for PASA v4 TRF
757 Double_t coefficients[2];
759 // Initialization (coefficient = alpha, rates = lambda)
765 if (nexp == 1) { // 1 Exponentials
771 if (nexp == 2) { // 2 Exponentials
778 coefficients[0] = C1;
779 coefficients[1] = C2;
783 rates[0] = TMath::Exp(-Dt/(R1));
784 rates[1] = TMath::Exp(-Dt/(R2));
789 Double_t reminder[2];
793 // Attention: computation order is important
795 for (k = 0; k < nexp; k++) {
798 for (i = 0; i < n; i++) {
799 result = (source[i] - correction); // No rescaling
802 for (k = 0; k < nexp; k++) {
803 reminder[k] = rates[k] * (reminder[k] + coefficients[k] * result);
806 for (k = 0; k < nexp; k++) {
807 correction += reminder[k];