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 ClassImp(AliTRDclusterizerV1)
50 //_____________________________________________________________________________
51 AliTRDclusterizerV1::AliTRDclusterizerV1()
56 // AliTRDclusterizerV1 default constructor
61 //_____________________________________________________________________________
62 AliTRDclusterizerV1::AliTRDclusterizerV1(const Text_t *name, const Text_t *title)
63 :AliTRDclusterizer(name,title)
64 ,fDigitsManager(new AliTRDdigitsManager())
67 // AliTRDclusterizerV1 constructor
70 fDigitsManager->CreateArrays();
74 //_____________________________________________________________________________
75 AliTRDclusterizerV1::AliTRDclusterizerV1(const AliTRDclusterizerV1 &c)
80 // AliTRDclusterizerV1 copy constructor
85 //_____________________________________________________________________________
86 AliTRDclusterizerV1::~AliTRDclusterizerV1()
89 // AliTRDclusterizerV1 destructor
93 delete fDigitsManager;
94 fDigitsManager = NULL;
99 //_____________________________________________________________________________
100 AliTRDclusterizerV1 &AliTRDclusterizerV1::operator=(const AliTRDclusterizerV1 &c)
103 // Assignment operator
106 if (this != &c) ((AliTRDclusterizerV1 &) c).Copy(*this);
111 //_____________________________________________________________________________
112 void AliTRDclusterizerV1::Copy(TObject &c) const
118 ((AliTRDclusterizerV1 &) c).fDigitsManager = 0;
120 AliTRDclusterizer::Copy(c);
124 //_____________________________________________________________________________
125 Bool_t AliTRDclusterizerV1::ReadDigits()
128 // Reads the digits arrays from the input aliroot file
132 AliError("No run loader available");
136 AliLoader* loader = fRunLoader->GetLoader("TRDLoader");
137 if (!loader->TreeD()) {
138 loader->LoadDigits();
141 // Read in the digit arrays
142 return (fDigitsManager->ReadDigits(loader->TreeD()));
146 //_____________________________________________________________________________
147 Bool_t AliTRDclusterizerV1::ReadDigits(AliRawReader *rawReader)
150 // Reads the digits arrays from the ddl file
154 fDigitsManager = raw.Raw2Digits(rawReader);
160 //_____________________________________________________________________________
161 Bool_t AliTRDclusterizerV1::MakeClusters()
164 // Generates the cluster.
175 AliTRDdataArrayI *digitsIn;
176 AliTRDdataArrayI *tracksIn;
179 AliTRDgeometry *geo = AliTRDgeometry::GetGeometry(fRunLoader);
181 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
183 AliError("No AliTRDcalibDB instance available\n");
187 AliTRDSimParam *simParam = AliTRDSimParam::Instance();
189 AliError("No AliTRDSimParam instance available\n");
193 AliTRDRecParam *recParam = AliTRDRecParam::Instance();
195 AliError("No AliTRDRecParam instance available\n");
199 AliTRDCommonParam *commonParam = AliTRDCommonParam::Instance();
201 AliError("Could not get common parameters\n");
206 Float_t ADCthreshold = simParam->GetADCthreshold();
207 // Threshold value for the maximum
208 Float_t maxThresh = recParam->GetClusMaxThresh();
209 // Threshold value for the digit signal
210 Float_t sigThresh = recParam->GetClusSigThresh();
212 // Iteration limit for unfolding procedure
213 const Float_t kEpsilon = 0.01;
214 const Int_t kNclus = 3;
215 const Int_t kNsig = 5;
216 const Int_t kNdict = AliTRDdigitsManager::kNDict;
217 const Int_t kNtrack = kNdict * kNclus;
221 Double_t ratioLeft = 1.0;
222 Double_t ratioRight = 1.0;
224 Int_t iClusterROC = 0;
226 Double_t padSignal[kNsig];
227 Double_t clusterSignal[kNclus];
228 Double_t clusterPads[kNclus];
231 Int_t chamEnd = AliTRDgeometry::Ncham();
233 Int_t planEnd = AliTRDgeometry::Nplan();
235 Int_t sectEnd = AliTRDgeometry::Nsect();
236 Int_t nTimeTotal = calibration->GetNumberOfTimeBins();
238 Int_t dummy[9] = { 0, 0, 0, 0, 0, 0, 0, 0, 0 };
240 AliDebug(1,Form("Number of Time Bins = %d.\n",nTimeTotal));
242 // Start clustering in every chamber
243 for (icham = chamBeg; icham < chamEnd; icham++) {
244 for (iplan = planBeg; iplan < planEnd; iplan++) {
245 for (isect = sectBeg; isect < sectEnd; isect++) {
247 Int_t idet = geo->GetDetector(iplan,icham,isect);
250 digitsIn = fDigitsManager->GetDigits(idet);
251 // This is to take care of switched off super modules
252 if (digitsIn->GetNtime() == 0) {
256 AliTRDdataArrayI *tracksTmp = fDigitsManager->GetDictionary(idet,0);
259 AliDebug(1,Form("Analyzing chamber %d, plane %d, sector %d.\n"
260 ,icham,iplan,isect));
262 Int_t nRowMax = commonParam->GetRowMax(iplan,icham,isect);
263 Int_t nColMax = commonParam->GetColMax(iplan);
265 AliTRDpadPlane *padPlane = commonParam->GetPadPlane(iplan,icham);
268 Int_t nClusters2pad = 0;
269 Int_t nClusters3pad = 0;
270 Int_t nClusters4pad = 0;
271 Int_t nClusters5pad = 0;
272 Int_t nClustersLarge = 0;
274 // Apply the gain and the tail cancelation via digital filter
275 AliTRDdataArrayF *digitsOut = new AliTRDdataArrayF(digitsIn->GetNrow()
277 ,digitsIn->GetNtime());
278 Transform(digitsIn,digitsOut,idet,nRowMax,nColMax,nTimeTotal,ADCthreshold);
280 // Input digits are not needed any more
281 digitsIn->Compress(1,0);
283 // Loop through the chamber and find the maxima
284 for ( row = 0; row < nRowMax; row++) {
285 for ( col = 2; col < nColMax; col++) {
286 for (time = 0; time < nTimeTotal; time++) {
288 Float_t signalL = TMath::Abs(digitsOut->GetDataUnchecked(row,col ,time));
289 Float_t signalM = TMath::Abs(digitsOut->GetDataUnchecked(row,col-1,time));
290 Float_t signalR = TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time));
292 // Look for the maximum
293 if (signalM >= maxThresh) {
294 if ((TMath::Abs(signalL) <= signalM) &&
295 (TMath::Abs(signalR) <= signalM)) {
296 if ((TMath::Abs(signalL) + TMath::Abs(signalR)) > sigThresh) {
297 // Maximum found, mark the position by a negative signal
298 digitsOut->SetDataUnchecked(row,col-1,time,-signalM);
306 tracksTmp->Compress(1,0);
308 // The index to the first cluster of a given ROC
309 Int_t firstClusterROC = -1;
310 // The number of cluster in a given ROC
311 Int_t nClusterROC = 0;
313 // Now check the maxima and calculate the cluster position
314 for ( row = 0; row < nRowMax ; row++) {
315 for (time = 0; time < nTimeTotal; time++) {
316 for ( col = 1; col < nColMax-1; col++) {
319 if (digitsOut->GetDataUnchecked(row,col,time) < 0.0) {
321 for (iPad = 0; iPad < kNclus; iPad++) {
322 Int_t iPadCol = col - 1 + iPad;
323 clusterSignal[iPad] =
324 TMath::Abs(digitsOut->GetDataUnchecked(row,iPadCol,time));
327 // Count the number of pads in the cluster
332 while (TMath::Abs(digitsOut->GetDataUnchecked(row,col-ii ,time)) >= sigThresh) {
335 if (col-ii < 0) break;
339 while (TMath::Abs(digitsOut->GetDataUnchecked(row,col+ii+1,time)) >= sigThresh) {
342 if (col+ii+1 >= nColMax) break;
368 // Look for 5 pad cluster with minimum in the middle
369 Bool_t fivePadCluster = kFALSE;
370 if (col < (nColMax - 3)) {
371 if (digitsOut->GetDataUnchecked(row,col+2,time) < 0) {
372 fivePadCluster = kTRUE;
374 if ((fivePadCluster) && (col < (nColMax - 5))) {
375 if (digitsOut->GetDataUnchecked(row,col+4,time) >= sigThresh) {
376 fivePadCluster = kFALSE;
379 if ((fivePadCluster) && (col > 1)) {
380 if (digitsOut->GetDataUnchecked(row,col-2,time) >= sigThresh) {
381 fivePadCluster = kFALSE;
387 // Modify the signal of the overlapping pad for the left part
388 // of the cluster which remains from a previous unfolding
390 clusterSignal[0] *= ratioLeft;
395 // Unfold the 5 pad cluster
396 if (fivePadCluster) {
397 for (iPad = 0; iPad < kNsig; iPad++) {
398 padSignal[iPad] = TMath::Abs(digitsOut->GetDataUnchecked(row
402 // Unfold the two maxima and set the signal on
403 // the overlapping pad to the ratio
404 ratioRight = Unfold(kEpsilon,iplan,padSignal);
405 ratioLeft = 1.0 - ratioRight;
406 clusterSignal[2] *= ratioRight;
411 Double_t clusterCharge = clusterSignal[0]
415 // The position of the cluster
416 clusterPads[0] = row + 0.5;
417 // Take the shift of the additional time bins into account
418 clusterPads[2] = time + 0.5;
420 if (recParam->LUTOn()) {
421 // Calculate the position of the cluster by using the
422 // lookup table method
423 clusterPads[1] = recParam->LUTposition(iplan,clusterSignal[0]
428 // Calculate the position of the cluster by using the
429 // center of gravity method
430 for (Int_t i = 0; i < kNsig; i++) {
433 padSignal[2] = TMath::Abs(digitsOut->GetDataUnchecked(row,col ,time)); // Central pad
434 padSignal[1] = TMath::Abs(digitsOut->GetDataUnchecked(row,col-1,time)); // Left pad
435 padSignal[3] = TMath::Abs(digitsOut->GetDataUnchecked(row,col+1,time)); // Right pad
437 (TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time)) < padSignal[1])) {
438 padSignal[0] = TMath::Abs(digitsOut->GetDataUnchecked(row,col-2,time));
440 if ((col < nColMax - 3) &&
441 (TMath::Abs(digitsOut->GetDataUnchecked(row,col+2,time)) < padSignal[3])) {
442 padSignal[4] = TMath::Abs(digitsOut->GetDataUnchecked(row,col+2,time));
444 clusterPads[1] = GetCOG(padSignal);
447 Double_t q0 = clusterSignal[0];
448 Double_t q1 = clusterSignal[1];
449 Double_t q2 = clusterSignal[2];
450 Double_t clusterSigmaY2 = (q1 * (q0 + q2) + 4.0 * q0 * q2)
451 / (clusterCharge*clusterCharge);
454 // Calculate the position and the error
458 Int_t clusterTimeBin = TMath::Nint(time - calibration->GetT0(idet,col,row));
459 Double_t colSize = padPlane->GetColSize(col);
460 Double_t rowSize = padPlane->GetRowSize(row);
462 Double_t clusterPos[3];
463 clusterPos[0] = padPlane->GetColPos(col) - (clusterPads[1] + 0.5) * colSize;
464 clusterPos[1] = padPlane->GetRowPos(row) - 0.5 * rowSize;
465 clusterPos[2] = CalcXposFromTimebin(clusterPads[2],idet,col,row);
466 Double_t clusterSig[2];
467 clusterSig[0] = (clusterSigmaY2 + 1.0/12.0) * colSize*colSize;
468 clusterSig[1] = rowSize * rowSize / 12.0;
470 // Add the cluster to the output array
471 // The track indices will be stored later
472 AliTRDcluster *cluster = AddCluster(clusterPos
481 // Store the amplitudes of the pads in the cluster for later analysis
482 Short_t signals[7] = { 0, 0, 0, 0, 0, 0, 0 };
483 for (Int_t jPad = col-3; jPad <= col+3; jPad++) {
485 (jPad >= nColMax-1)) {
488 signals[jPad-col+3] = TMath::Nint(TMath::Abs(digitsOut->GetDataUnchecked(row,jPad,time)));
490 cluster->SetSignals(signals);
492 // Temporarily store the row, column and time bin of the center pad
493 // Used to later on assign the track indices
494 cluster->SetLabel( row,0);
495 cluster->SetLabel( col,1);
496 cluster->SetLabel(time,2);
498 // Store the index of the first cluster in the current ROC
499 if (firstClusterROC < 0) {
500 firstClusterROC = RecPoints()->GetEntriesFast() - 1;
502 // Count the number of cluster in the current ROC
505 } // if: Maximum found ?
507 } // loop: pad columns
514 // Add the track indices to the found clusters
517 // Temporary array to collect the track indices
518 Int_t *idxTracks = new Int_t[kNtrack*nClusterROC];
520 // Loop through the dictionary arrays one-by-one
521 // to keep memory consumption low
522 for (Int_t iDict = 0; iDict < kNdict; iDict++) {
524 tracksIn = fDigitsManager->GetDictionary(idet,iDict);
527 // Loop though the clusters found in this ROC
528 for (iClusterROC = 0; iClusterROC < nClusterROC; iClusterROC++) {
530 AliTRDcluster *cluster = (AliTRDcluster *)
531 RecPoints()->UncheckedAt(firstClusterROC+iClusterROC);
532 row = cluster->GetLabel(0);
533 col = cluster->GetLabel(1);
534 time = cluster->GetLabel(2);
536 for (iPad = 0; iPad < kNclus; iPad++) {
537 Int_t iPadCol = col - 1 + iPad;
538 Int_t index = tracksIn->GetDataUnchecked(row,iPadCol,time) - 1;
539 idxTracks[3*iPad+iDict + iClusterROC*kNtrack] = index;
544 // Compress the arrays
545 tracksIn->Compress(1,0);
549 // Copy the track indices into the cluster
550 // Loop though the clusters found in this ROC
551 for (iClusterROC = 0; iClusterROC < nClusterROC; iClusterROC++) {
553 AliTRDcluster *cluster = (AliTRDcluster *)
554 RecPoints()->UncheckedAt(firstClusterROC+iClusterROC);
555 cluster->SetLabel(-9999,0);
556 cluster->SetLabel(-9999,1);
557 cluster->SetLabel(-9999,2);
559 cluster->AddTrackIndex(&idxTracks[iClusterROC*kNtrack]);
565 // Write the cluster and reset the array
577 //_____________________________________________________________________________
578 Double_t AliTRDclusterizerV1::GetCOG(Double_t signal[5])
582 // Used for clusters with more than 3 pads - where LUT not applicable
585 Double_t sum = signal[0]
591 Double_t res = (0.0 * (-signal[0] + signal[4])
592 + (-signal[1] + signal[3])) / sum;
598 //_____________________________________________________________________________
599 Double_t AliTRDclusterizerV1::Unfold(Double_t eps, Int_t plane, Double_t *padSignal)
602 // Method to unfold neighbouring maxima.
603 // The charge ratio on the overlapping pad is calculated
604 // until there is no more change within the range given by eps.
605 // The resulting ratio is then returned to the calling method.
608 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
610 AliError("No AliTRDcalibDB instance available\n");
615 Int_t itStep = 0; // Count iteration steps
617 Double_t ratio = 0.5; // Start value for ratio
618 Double_t prevRatio = 0.0; // Store previous ratio
620 Double_t newLeftSignal[3] = { 0.0, 0.0, 0.0 }; // Array to store left cluster signal
621 Double_t newRightSignal[3] = { 0.0, 0.0, 0.0 }; // Array to store right cluster signal
622 Double_t newSignal[3] = { 0.0, 0.0, 0.0 };
624 // Start the iteration
625 while ((TMath::Abs(prevRatio - ratio) > eps) && (itStep < 10)) {
630 // Cluster position according to charge ratio
631 Double_t maxLeft = (ratio*padSignal[2] - padSignal[0])
632 / (padSignal[0] + padSignal[1] + ratio*padSignal[2]);
633 Double_t maxRight = (padSignal[4] - (1-ratio)*padSignal[2])
634 / ((1.0 - ratio)*padSignal[2] + padSignal[3] + padSignal[4]);
636 // Set cluster charge ratio
637 irc = calibration->PadResponse(1.0,maxLeft ,plane,newSignal);
638 Double_t ampLeft = padSignal[1] / newSignal[1];
639 irc = calibration->PadResponse(1.0,maxRight,plane,newSignal);
640 Double_t ampRight = padSignal[3] / newSignal[1];
642 // Apply pad response to parameters
643 irc = calibration->PadResponse(ampLeft ,maxLeft ,plane,newLeftSignal );
644 irc = calibration->PadResponse(ampRight,maxRight,plane,newRightSignal);
646 // Calculate new overlapping ratio
647 ratio = TMath::Min((Double_t)1.0,newLeftSignal[2] /
648 (newLeftSignal[2] + newRightSignal[0]));
656 //_____________________________________________________________________________
657 void AliTRDclusterizerV1::Transform(AliTRDdataArrayI *digitsIn
658 , AliTRDdataArrayF *digitsOut
659 , Int_t idet, Int_t nRowMax
660 , Int_t nColMax, Int_t nTimeTotal
661 , Float_t ADCthreshold)
665 // Apply tail cancelation: Transform digitsIn to digitsOut
672 AliTRDRecParam *recParam = AliTRDRecParam::Instance();
674 AliError("No AliTRDRecParam instance available\n");
677 AliTRDcalibDB *calibration = AliTRDcalibDB::Instance();
679 AliError("No AliTRDcalibDB instance available\n");
683 Double_t *inADC = new Double_t[nTimeTotal]; // ADC data before tail cancellation
684 Double_t *outADC = new Double_t[nTimeTotal]; // ADC data after tail cancellation
686 AliDebug(1,Form("Tail cancellation (nExp = %d) for detector %d.\n"
687 ,recParam->GetTCnexp(),idet));
689 for (iRow = 0; iRow < nRowMax; iRow++ ) {
690 for (iCol = 0; iCol < nColMax; iCol++ ) {
692 for (iTime = 0; iTime < nTimeTotal; iTime++) {
697 Double_t gain = calibration->GetGainFactor(idet,iCol,iRow);
699 AliError("Not a valid gain\n");
701 inADC[iTime] = digitsIn->GetDataUnchecked(iRow,iCol,iTime);
702 inADC[iTime] /= gain;
703 outADC[iTime] = inADC[iTime];
707 // Apply the tail cancelation via the digital filter
708 if (recParam->TCOn()) {
709 DeConvExp(inADC,outADC,nTimeTotal,recParam->GetTCnexp());
712 for (iTime = 0; iTime < nTimeTotal; iTime++) {
714 // Store the amplitude of the digit if above threshold
715 if (outADC[iTime] > ADCthreshold) {
716 AliDebug(2,Form(" iRow = %d, iCol = %d, iTime = %d, adc = %f\n"
717 ,iRow,iCol,iTime,outADC[iTime]));
718 digitsOut->SetDataUnchecked(iRow,iCol,iTime,outADC[iTime]);
733 //_____________________________________________________________________________
734 void AliTRDclusterizerV1::DeConvExp(Double_t *source, Double_t *target
735 , Int_t n, Int_t nexp)
738 // Tail cancellation by deconvolution for PASA v4 TRF
742 Double_t coefficients[2];
744 // Initialization (coefficient = alpha, rates = lambda)
750 if (nexp == 1) { // 1 Exponentials
756 if (nexp == 2) { // 2 Exponentials
763 coefficients[0] = C1;
764 coefficients[1] = C2;
768 rates[0] = TMath::Exp(-Dt/(R1));
769 rates[1] = TMath::Exp(-Dt/(R2));
774 Double_t reminder[2];
778 // Attention: computation order is important
780 for (k = 0; k < nexp; k++) {
783 for (i = 0; i < n; i++) {
784 result = (source[i] - correction); // No rescaling
787 for (k = 0; k < nexp; k++) {
788 reminder[k] = rates[k] * (reminder[k] + coefficients[k] * result);
791 for (k = 0; k < nexp; k++) {
792 correction += reminder[k];