1 /**************************************************************************
2 * Copyright(c) 1998-2000, 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 #include <Riostream.h>
19 #include <TDirectory.h>
23 #include "AliRunDigitizer.h"
24 #include "AliRunLoader.h"
25 #include "AliLoader.h"
27 #include "AliMUONDigitizer.h"
28 #include "AliMUONConstants.h"
29 #include "AliMUONChamber.h"
30 #include "AliMUONHitMapA1.h"
32 #include "AliMUONChamber.h"
33 #include "AliMUONConstants.h"
34 #include "AliMUONDigit.h"
35 #include "AliMUONDigitizer.h"
36 #include "AliMUONHit.h"
37 #include "AliMUONHitMapA1.h"
38 #include "AliMUONPadHit.h"
39 #include "AliMUONTransientDigit.h"
41 /////////////////////////////////////////////////////////////////////////////////////
43 // AliMUONDigitizer should be base abstract class of all digitisers in the MUON
44 // module. It implements the common functionality of looping over input streams
45 // filling the fTDList and writing the fTDList to the output stream.
46 // Inheriting digitizers need to override certain methods to choose and initialize
47 // the correct input and output trees, apply the correct detector response if any
48 // and implement how the transient digits are generated from the input stream.
50 /////////////////////////////////////////////////////////////////////////////////////
52 ClassImp(AliMUONDigitizer)
54 //___________________________________________
55 AliMUONDigitizer::AliMUONDigitizer() :
64 // Default constructor.
65 // Initializes all pointers to NULL.
73 //___________________________________________
74 AliMUONDigitizer::AliMUONDigitizer(AliRunDigitizer* manager) :
75 AliDigitizer(manager),
83 // Constructor which should be used rather than the default constructor.
84 // Initializes all pointers to NULL.
92 //------------------------------------------------------------------------
93 Bool_t AliMUONDigitizer::Init()
99 //------------------------------------------------------------------------
100 void AliMUONDigitizer::Exec(Option_t* option)
102 // The main work loop starts here.
103 // The digitization process is broken up into two steps:
104 // 1) Loop over input streams and create transient digits from the input.
105 // Done in GenerateTransientDigits()
106 // 2) Loop over the generated transient digits and write them to the output
107 // stream. Done in CreateDigits()
109 if (GetDebug() > 0) Info("Exec", "Running digitiser.");
110 ParseOptions(option);
112 if (fManager->GetNinputs() == 0)
114 Warning("Exec", "No inputs set, nothing to do.");
118 if (! FetchLoaders(fManager->GetInputFolderName(0), runloader, gime) ) return;
119 if (! FetchGlobalPointers(runloader) ) return;
123 if (GetDebug() > 1) Info("Exec", "Event Number is %d.", fManager->GetOutputEventNr());
125 // Loop over files to merge and to digitize
127 for (Int_t inputFile = 0; inputFile < fManager->GetNinputs(); inputFile++)
129 fMask = fManager->GetMask(inputFile);
131 Info("Exec", "Digitising folder %d, with fMask = %d: %s", inputFile, fMask,
132 (const char*)fManager->GetInputFolderName(inputFile));
135 // If this is the first file then we already have the loaders loaded.
136 if (! FetchLoaders(fManager->GetInputFolderName(inputFile), runloader, gime) )
139 // If this is not the first file then it is assumed to be background.
142 if (! InitInputData(gime) ) continue;
143 GenerateTransientDigits();
144 CleanupInputData(gime);
147 Bool_t ok = FetchLoaders(fManager->GetOutputFolderName(), runloader, gime);
148 if (ok) ok = InitOutputData(gime);
149 if (ok) CreateDigits();
150 if (ok) CleanupOutputData(gime);
155 //--------------------------------------------------------------------------
156 void AliMUONDigitizer::AddOrUpdateTransientDigit(AliMUONTransientDigit* mTD)
158 // Checks to see if the transient digit exists in the corresponding fHitMap.
159 // If it does then the digit is updated otherwise it is added.
161 if (ExistTransientDigit(mTD))
163 UpdateTransientDigit(mTD);
164 delete mTD; // The new digit can be deleted because it was not added.
167 AddTransientDigit(mTD);
170 //------------------------------------------------------------------------
171 void AliMUONDigitizer::UpdateTransientDigit(AliMUONTransientDigit* mTD)
173 // Update the transient digit that is already in the fTDList by adding the new
174 // transient digits charges and track lists to the existing one.
177 Info("UpdateTransientDigit", "Updating transient digit 0x%X", (void*)mTD);
178 // Choosing the maping of the cathode plane of the chamber:
179 Int_t iNchCpl= mTD->Chamber() + (mTD->Cathode()-1) * AliMUONConstants::NCh();
180 AliMUONTransientDigit *pdigit =
181 static_cast<AliMUONTransientDigit*>( fHitMap[iNchCpl]->GetHit(mTD->PadX(),mTD->PadY()) );
184 pdigit->AddSignal( mTD->Signal() );
185 pdigit->AddPhysicsSignal( mTD->Physics() );
187 // update list of tracks
188 Int_t ntracks = mTD->GetNTracks();
189 if (ntracks > kMAXTRACKS) // Truncate the number of tracks to kMAXTRACKS if we have to.
193 Warning("UpdateTransientDigit",
194 "TransientDigit returned the number of tracks to be %d, which is bigger than kMAXTRACKS.",
196 Warning("UpdateTransientDigit", "Reseting the number of tracks to be %d.", kMAXTRACKS);
198 ntracks = kMAXTRACKS;
201 for (Int_t i = 0; i < ntracks; i++)
203 pdigit->UpdateTrackList( mTD->GetTrack(i), mTD->GetCharge(i) );
207 //------------------------------------------------------------------------
208 void AliMUONDigitizer::AddTransientDigit(AliMUONTransientDigit* mTD)
210 // Adds the transient digit to the fTDList and sets the appropriate entry
211 // in the fHitMap arrays.
214 Info("AddTransientDigit", "Adding transient digit 0x%X", (void*)mTD);
215 // Choosing the maping of the cathode plane of the chamber:
216 Int_t iNchCpl= mTD->Chamber() + (mTD->Cathode()-1) * AliMUONConstants::NCh();
217 fTDList->AddAtAndExpand(mTD, fTDCounter);
218 fHitMap[iNchCpl]->SetHit( mTD->PadX(), mTD->PadY(), fTDCounter);
222 //------------------------------------------------------------------------
223 Bool_t AliMUONDigitizer::ExistTransientDigit(AliMUONTransientDigit* mTD)
225 // Checks if the transient digit already exists on the corresponding fHitMap.
226 // i.e. is there a transient digit on the same chamber, cathode and pad position
227 // as mTD. If yes then kTRUE is returned else kFASLE is returned.
229 // Choosing the maping of the cathode plane of the chamber:
230 Int_t iNchCpl= mTD->Chamber() + (mTD->Cathode()-1) * AliMUONConstants::NCh();
231 return( fHitMap[iNchCpl]->TestHit(mTD->PadX(), mTD->PadY()) );
234 //-----------------------------------------------------------------------
235 void AliMUONDigitizer::CreateDigits()
237 // Loops over the fTDList for each cathode, gets the correct signal for the
238 // digit and adds the new digit to the output stream.
240 if (GetDebug() > 1) Info("CreateDigits", "Creating digits...");
241 for (Int_t icat = 0; icat < 2; icat++)
244 // Filling Digit List
245 Int_t nentries = fTDList->GetEntriesFast();
246 for (Int_t nent = 0; nent < nentries; nent++)
248 AliMUONTransientDigit* td = (AliMUONTransientDigit*)fTDList->At(nent);
249 if (td == NULL) continue;
251 // Must be the same cathode, otherwise we will fill a mixture
252 // of digits from both cathodes.
253 if (icat != td->Cathode() - 1) continue;
256 Info("CreateDigits", "Creating digit from transient digit 0x%X", (void*)td);
258 Int_t q = GetSignalFrom(td);
259 if (q > 0) AddDigit(td, q);
265 //------------------------------------------------------------------------
266 void AliMUONDigitizer::AddDigit(AliMUONTransientDigit* td, Int_t response_charge)
268 // Prepares the digits, track and charge arrays in preparation for a call to
269 // AddDigit(Int_t, Int_t[kMAXTRACKS], Int_t[kMAXTRACKS], Int_t[6])
270 // This method is called by CreateDigits() whenever a new digit needs to be added
271 // to the output stream trees.
272 // The response_charge value is used as the Signal of the new digit.
273 // The OnWriteTransientDigit method is also called just before the adding the
274 // digit to allow inheriting digitizers to be able to do some specific processing
277 Int_t tracks[kMAXTRACKS];
278 Int_t charges[kMAXTRACKS];
281 digits[0] = td->PadX();
282 digits[1] = td->PadY();
283 digits[2] = td->Cathode() - 1;
284 digits[3] = response_charge;
285 digits[4] = td->Physics();
286 digits[5] = td->Hit();
288 Int_t nptracks = td->GetNTracks();
289 if (nptracks > kMAXTRACKS)
294 "TransientDigit returned the number of tracks to be %d, which is bigger than kMAXTRACKS.",
296 Warning("AddDigit", "Reseting the number of tracks to be %d.", kMAXTRACKS);
298 nptracks = kMAXTRACKS;
301 for (Int_t i = 0; i < nptracks; i++)
303 tracks[i] = td->GetTrack(i);
304 charges[i] = td->GetCharge(i);
307 // Sort list of tracks according to charge
308 SortTracks(tracks,charges,nptracks);
310 if (nptracks < kMAXTRACKS )
312 for (Int_t i = nptracks; i < kMAXTRACKS; i++)
319 if (GetDebug() > 3) Info("AddDigit", "Adding digit with charge %d.", response_charge);
321 OnWriteTransientDigit(td);
322 AddDigit(td->Chamber(), tracks, charges, digits);
325 //------------------------------------------------------------------------
326 void AliMUONDigitizer::OnCreateTransientDigit(AliMUONTransientDigit* /*digit*/, TObject* /*source_object*/)
330 // This is derived by Digitisers that want to trace which digits were made from
334 //------------------------------------------------------------------------
335 void AliMUONDigitizer::OnWriteTransientDigit(AliMUONTransientDigit* /*digit*/)
339 // This is derived by Digitisers that want to trace which digits were made from
343 //------------------------------------------------------------------------
344 Bool_t AliMUONDigitizer::FetchLoaders(const char* foldername, AliRunLoader*& runloader, AliMUONLoader*& muonloader)
346 // Fetches the run loader from the current folder, specified by 'foldername'.
347 // The muon loader is then loaded from the fetched run loader.
348 // kTRUE is returned if no error occurred otherwise kFALSE is returned.
351 Info("FetchLoaders", "Fetching run loader and muon loader from folder: %s", foldername);
353 runloader = AliRunLoader::GetRunLoader(foldername);
354 if (runloader == NULL)
356 Error("FetchLoaders", "RunLoader not found in folder: %s", foldername);
359 muonloader = (AliMUONLoader*) runloader->GetLoader("MUONLoader");
360 if (muonloader == NULL)
362 Error("FetchLoaders", "MUONLoader not found in folder: %s", foldername);
368 //------------------------------------------------------------------------
369 Bool_t AliMUONDigitizer::FetchGlobalPointers(AliRunLoader* runloader)
371 // Fetches the AliRun object into the global gAlice pointer from the specified
372 // run loader. The AliRun object is loaded into memory using the run loader if
373 // not yet loaded. The MUON module object is then loaded from gAlice and
374 // AliMUONData fetched from the MUON module.
375 // kTRUE is returned if no error occurred otherwise kFALSE is returned.
378 Info("FetchGlobalPointers", "Fetching gAlice, MUON module and AliMUONData from runloader 0x%X.",
382 if (runloader->GetAliRun() == NULL) runloader->LoadgAlice();
383 gAlice = runloader->GetAliRun();
386 Error("FetchGlobalPointers", "Could not find the AliRun object in runloader 0x%X.", (void*)runloader);
389 pMUON = (AliMUON*) gAlice->GetDetector("MUON");
392 Error("FetchGlobalPointers", "Could not find the MUON module in runloader 0x%X.", (void*)runloader);
395 muondata = pMUON->GetMUONData();
396 if (muondata == NULL)
398 Error("FetchGlobalPointers", "Could not find AliMUONData object in runloader 0x%X.", (void*)runloader);
404 //------------------------------------------------------------------------
405 void AliMUONDigitizer::ParseOptions(Option_t* options)
407 // Called by the Exec method. ParseOptions should parse the option string given to the Exec method.
409 // The following options are defined:
410 // "debug" - Sets the debug level to 99, which will show all debug messages.
411 // "deb" - Same as "debug", implemented for backward comparability.
413 // If an invalid option is specified it is simply ignored.
415 TString optionString = options;
416 if (optionString.Data() == "debug" ||
417 optionString.Data() == "deb" // maintained for compatability.
420 Info("ParseOptions", "Called with option \"debug\".");
425 //------------------------------------------------------------------------
426 void AliMUONDigitizer::InitArrays()
428 // Creates a new fTDList object.
429 // Also creates an array of 2 * chamber_number AliMUONHitMapA1 objects
430 // in the fHitMaps array. Each one is set to a chamber and cathode
431 // specific segmentation model.
433 // Note: the fTDList and fHitMap arrays must be NULL before calling this method.
435 if (GetDebug() > 1) Info("InitArrays", "Initialising internal arrays.");
436 if (GetDebug() > 3) Info("InitArrays", "Creating transient digits list.");
437 fTDList = new TObjArray;
439 // Array of pointer of the AliMUONHitMapA1:
440 // two HitMaps per chamber, or one HitMap per cahtode plane
441 fHitMap = new AliMUONHitMapA1* [2*AliMUONConstants::NCh()];
443 // Loop over chambers for the definition AliMUONHitMap
444 for (Int_t i = 0; i < AliMUONConstants::NCh(); i++)
446 if (GetDebug() > 3) Info("InitArrays", "Creating hit map for chamber %d, cathode 1.", i+1);
447 AliMUONChamber* chamber = &(pMUON->Chamber(i));
448 AliSegmentation* c1Segmentation = chamber->SegmentationModel(1); // Cathode plane 1
449 fHitMap[i] = new AliMUONHitMapA1(c1Segmentation, fTDList);
450 if (GetDebug() > 3) Info("InitArrays", "Creating hit map for chamber %d, cathode 2.", i+1);
451 AliSegmentation* c2Segmentation = chamber->SegmentationModel(2); // Cathode plane 2
452 fHitMap[i+AliMUONConstants::NCh()] = new AliMUONHitMapA1(c2Segmentation, fTDList);
456 //------------------------------------------------------------------------
457 void AliMUONDigitizer::CleanupArrays()
459 // The arrays fTDList and fHitMap are deleted and the pointers set to NULL.
461 if (GetDebug() > 1) Info("CleanupArrays", "Deleting internal arrays.");
462 for(Int_t i = 0; i < 2*AliMUONConstants::NCh(); i++)
464 if (GetDebug() > 3) Info("CleanupArrays", "Deleting hit map for chamber %d, cathode %d.",
465 i%AliMUONConstants::NCh()+1, i/AliMUONConstants::NCh()+1);
471 if (GetDebug() > 3) Info("CleanupArrays", "Deleting transient digits list.");
477 //------------------------------------------------------------------------
478 void AliMUONDigitizer::SortTracks(Int_t *tracks, Int_t *charges, Int_t ntr)
481 // Sort the list of tracks contributing to a given digit
482 // Only the 3 most significant tracks are actually sorted
485 if (ntr <= 1) return;
488 // Loop over signals, only 3 times
493 Int_t idx[3] = {-2,-2,-2};
494 Int_t jch[3] = {-2,-2,-2};
495 Int_t jtr[3] = {-2,-2,-2};
498 if (ntr < 3) imax = ntr;
501 for(i = 0; i < imax; i++)
506 for(j = 0; j < ntr; j++)
508 if ( (i == 1 && j == idx[i-1]) ||
509 (i == 2 && (j == idx[i-1] || j == idx[i-2]))
513 if(charges[j] > qmax)
523 jch[i] = charges[jmax];
524 jtr[i] = tracks[jmax];
529 for(i = 0; i < 3; i++)