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 **************************************************************************/
21 #include "AliRunDigitizer.h"
22 #include "AliRunLoader.h"
24 #include "AliMUONDigitizer.h"
25 #include "AliMUONConstants.h"
26 #include "AliMUONChamber.h"
27 #include "AliMUONHitMapA1.h"
29 #include "AliMUONLoader.h"
30 #include "AliMUONConstants.h"
31 #include "AliMUONTransientDigit.h"
32 #include "AliMUONTriggerDecision.h"
34 #include "AliMUONGeometryModule.h"
35 #include "AliMUONGeometryStore.h"
37 /////////////////////////////////////////////////////////////////////////////////////
39 // AliMUONDigitizer should be base abstract class of all digitisers in the MUON
40 // module. It implements the common functionality of looping over input streams
41 // filling the fTDList and writing the fTDList to the output stream.
42 // Inheriting digitizers need to override certain methods to choose and initialize
43 // the correct input and output trees, apply the correct detector response if any
44 // and implement how the transient digits are generated from the input stream.
46 /////////////////////////////////////////////////////////////////////////////////////
48 ClassImp(AliMUONDigitizer)
50 //___________________________________________
51 AliMUONDigitizer::AliMUONDigitizer() :
60 // Default constructor.
61 // Initializes all pointers to NULL.
70 //___________________________________________
71 AliMUONDigitizer::AliMUONDigitizer(AliRunDigitizer* manager) :
72 AliDigitizer(manager),
80 // Constructor which should be used rather than the default constructor.
81 // Initializes all pointers to NULL.
90 //___________________________________________
91 AliMUONDigitizer::AliMUONDigitizer(const AliMUONDigitizer& rhs)
94 // Protected copy constructor
96 AliFatal("Not implemented.");
99 //___________________________________________
100 AliMUONDigitizer::~AliMUONDigitizer()
110 //-------------------------------------------------------------------
112 AliMUONDigitizer::operator=(const AliMUONDigitizer& rhs)
114 // Protected assignement operator
116 if (this == &rhs) return *this;
118 AliFatal("Not implemented.");
123 //------------------------------------------------------------------------
124 void AliMUONDigitizer::CheckSegmentation()
126 if (fMUON->WhichSegmentation()==1) {
127 AliFatal("Old Segmentation no more supported.");
133 //------------------------------------------------------------------------
134 Bool_t AliMUONDigitizer::Init()
140 //------------------------------------------------------------------------
141 void AliMUONDigitizer::Exec(Option_t* option)
143 // The main work loop starts here.
144 // The digitization process is broken up into two steps:
145 // 1) Loop over input streams and create transient digits from the input.
146 // Done in GenerateTransientDigits()
147 // 2) Loop over the generated transient digits and write them to the output
148 // stream. Done in CreateDigits()
150 AliDebug(1, "Running digitiser.");
151 ParseOptions(option);
153 if (fManager->GetNinputs() == 0)
155 AliWarning("No inputs set, nothing to do.");
159 if (!FetchLoaders(fManager->GetInputFolderName(0), fRunLoader, fGime) ) return;
160 if (! FetchGlobalPointers(fRunLoader) ) return;
161 if (! FetchTriggerPointer(fGime) ) return;
165 AliDebug(2, Form("Event Number is %d.", fManager->GetOutputEventNr()));
167 // Loop over files to merge and to digitize
169 for (Int_t inputFile = 0; inputFile < fManager->GetNinputs(); inputFile++)
171 fMask = fManager->GetMask(inputFile);
172 AliDebug(2, Form("Digitising folder %d, with fMask = %d: %s", inputFile, fMask,
173 (const char*)fManager->GetInputFolderName(inputFile)));
176 // If this is the first file then we already have the loaders loaded.
177 if (! FetchLoaders(fManager->GetInputFolderName(inputFile), fRunLoader, fGime) )
180 // If this is not the first file then it is assumed to be background.
183 if (! InitInputData(fGime) ) continue;
184 GenerateTransientDigits();
185 CleanupInputData(fGime);
188 Bool_t ok = FetchLoaders(fManager->GetOutputFolderName(), fRunLoader, fGime);
189 if (ok) ok = InitOutputData(fGime);
190 if (ok) CreateDigits();
191 if (ok) CreateTrigger();
192 if (ok) CleanupOutputData(fGime);
195 CleanupTriggerArrays();
198 //--------------------------------------------------------------------------
199 void AliMUONDigitizer::AddOrUpdateTransientDigit(AliMUONTransientDigit* mTD)
201 // Checks to see if the transient digit exists in the corresponding fHitMap.
202 // If it does then the digit is updated otherwise it is added.
204 if (ExistTransientDigit(mTD))
206 UpdateTransientDigit(mTD);
207 delete mTD; // The new digit can be deleted because it was not added.
210 AddTransientDigit(mTD);
213 //------------------------------------------------------------------------
214 void AliMUONDigitizer::UpdateTransientDigit(AliMUONTransientDigit* mTD)
216 // Update the transient digit that is already in the fTDList by adding the new
217 // transient digits charges and track lists to the existing one.
219 AliDebug(4,Form( "Updating transient digit 0x%X", (void*)mTD));
220 // Choosing the maping of the cathode plane of the chamber:
221 Int_t detElemId = mTD->DetElemId();
223 Int_t iNchCpl= fNDetElemId[detElemId] + (mTD->Cathode()-1) * AliMUONConstants::NDetElem();
225 AliMUONTransientDigit *pdigit =
226 static_cast<AliMUONTransientDigit*>( fHitMap[iNchCpl]->GetHit(mTD->PadX(),mTD->PadY()) );
229 pdigit->AddSignal( mTD->Signal() );
230 pdigit->AddPhysicsSignal( mTD->Physics() );
232 // update list of tracks
233 Int_t ntracks = mTD->GetNTracks();
234 if (ntracks > kMAXTRACKS) // Truncate the number of tracks to kMAXTRACKS if we have to.
237 "TransientDigit returned the number of tracks to be %d, which is bigger than kMAXTRACKS.",
239 AliDebug(1,Form( "Reseting the number of tracks to be %d.", kMAXTRACKS));
240 ntracks = kMAXTRACKS;
243 for (Int_t i = 0; i < ntracks; i++)
245 pdigit->UpdateTrackList( mTD->GetTrack(i), mTD->GetCharge(i) );
249 //------------------------------------------------------------------------
250 void AliMUONDigitizer::AddTransientDigit(AliMUONTransientDigit* mTD)
252 // Adds the transient digit to the fTDList and sets the appropriate entry
253 // in the fHitMap arrays.
255 AliDebug(4,Form( "Adding transient digit 0x%X", (void*)mTD));
256 // Choosing the maping of the cathode plane of the chamber:
258 Int_t detElemId = mTD->DetElemId();
259 Int_t iNchCpl= fNDetElemId[detElemId] + (mTD->Cathode()-1) * AliMUONConstants::NDetElem();
261 fTDList->AddAtAndExpand(mTD, fTDCounter);
262 fHitMap[iNchCpl]->SetHit( mTD->PadX(), mTD->PadY(), fTDCounter);
266 //------------------------------------------------------------------------
267 Bool_t AliMUONDigitizer::ExistTransientDigit(AliMUONTransientDigit* mTD)
269 // Checks if the transient digit already exists on the corresponding fHitMap.
270 // i.e. is there a transient digit on the same chamber, cathode and pad position
271 // as mTD. If yes then kTRUE is returned else kFASLE is returned.
273 // Choosing the maping of the cathode plane of the chamber:
274 Int_t detElemId = mTD->DetElemId();
276 Int_t iNchCpl= fNDetElemId[detElemId] + (mTD->Cathode()-1) *AliMUONConstants::NDetElem() ;
278 // Int_t iNchCpl= mTD->Chamber() + (mTD->Cathode()-1) * AliMUONConstants::NCh();
279 return( fHitMap[iNchCpl]->TestHit(mTD->PadX(), mTD->PadY()) );
282 //-----------------------------------------------------------------------
283 void AliMUONDigitizer::CreateDigits()
285 // Loops over the fTDList for each cathode, gets the correct signal for the
286 // digit and adds the new digit to the output stream.
288 fTDList->Sort(); // sort by idDE
289 AliDebug(2, "Creating digits...");
290 // for (Int_t icat = 0; icat < 2; icat++) {
292 Int_t digitindex[14] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
295 // Filling Digit List
296 Int_t nentries = fTDList->GetEntriesFast();
297 for (Int_t nent = 0; nent < nentries; nent++) {
299 AliMUONTransientDigit* td = (AliMUONTransientDigit*)fTDList->At(nent);
300 if (td == NULL) continue;
302 // Must be the same cathode, otherwise we will fill a mixture
303 // of digits from both cathodes.
304 //if (icat != td->Cathode() - 1) continue;
306 AliDebug(3,Form( "Creating digit from transient digit 0x%X", (void*)td));
308 Int_t q = GetSignalFrom(td);
309 assert( 0 <= td->Chamber() && td->Chamber() <= 13 );
310 if (q > 0) AddDigit(td, q, digitindex[td->Chamber()]++);
317 //------------------------------------------------------------------------
318 void AliMUONDigitizer::AddDigit(
319 AliMUONTransientDigit* td, Int_t responseCharge,
323 // Prepares the digits, track and charge arrays in preparation for a call to
324 // AddDigit(Int_t, Int_t[kMAXTRACKS], Int_t[kMAXTRACKS], Int_t[6])
325 // This method is called by CreateDigits() whenever a new digit needs to be added
326 // to the output stream trees.
327 // The responseCharge value is used as the Signal of the new digit.
328 // The OnWriteTransientDigit method is also called just before the adding the
329 // digit to allow inheriting digitizers to be able to do some specific processing
332 Int_t tracks[kMAXTRACKS];
333 Int_t charges[kMAXTRACKS];
336 digits[0] = td->PadX();
337 digits[1] = td->PadY();
338 digits[2] = td->Cathode() - 1;
339 digits[3] = responseCharge;
340 digits[4] = td->Physics();
341 digits[5] = td->Hit();
342 digits[6] = td->DetElemId();
344 Int_t nptracks = td->GetNTracks();
345 if (nptracks > kMAXTRACKS) {
348 "TransientDigit returned the number of tracks to be %d, which is bigger than kMAXTRACKS.",
350 AliDebug(1, Form("Reseting the number of tracks to be %d.", kMAXTRACKS));
351 nptracks = kMAXTRACKS;
354 for (Int_t i = 0; i < nptracks; i++) {
356 tracks[i] = td->GetTrack(i);
357 charges[i] = td->GetCharge(i);
360 // Sort list of tracks according to charge
361 SortTracks(tracks,charges,nptracks);
363 if (nptracks < kMAXTRACKS ) {
365 for (Int_t i = nptracks; i < kMAXTRACKS; i++) {
371 AliDebug(4,Form( "Adding digit with charge %d.", responseCharge));
373 OnWriteTransientDigit(td);
374 AddDigit(td->Chamber(), tracks, charges, digits);
375 AddDigitTrigger(td->Chamber(), tracks, charges, digits, digitindex);
378 //------------------------------------------------------------------------
379 void AliMUONDigitizer::OnCreateTransientDigit(AliMUONTransientDigit* /*digit*/, TObject* /*source_object*/)
383 // This is derived by Digitisers that want to trace which digits were made from
387 //------------------------------------------------------------------------
388 void AliMUONDigitizer::OnWriteTransientDigit(AliMUONTransientDigit* /*digit*/)
392 // This is derived by Digitisers that want to trace which digits were made from
396 //------------------------------------------------------------------------
397 Bool_t AliMUONDigitizer::FetchLoaders(const char* foldername, AliRunLoader*& runloader, AliMUONLoader*& muonloader)
399 // Fetches the run loader from the current folder, specified by 'foldername'.
400 // The muon loader is then loaded from the fetched run loader.
401 // kTRUE is returned if no error occurred otherwise kFALSE is returned.
403 AliDebug(3, Form("Fetching run loader and muon loader from folder: %s", foldername));
405 runloader = AliRunLoader::GetRunLoader(foldername);
406 if (runloader == NULL)
408 AliError(Form("RunLoader not found in folder: %s", foldername));
411 muonloader = (AliMUONLoader*) runloader->GetLoader("MUONLoader");
412 if (muonloader == NULL)
414 AliError(Form("MUONLoader not found in folder: %s", foldername));
421 //------------------------------------------------------------------------
422 Bool_t AliMUONDigitizer::FetchGlobalPointers(AliRunLoader* runloader)
424 // Fetches the AliRun object into the global gAlice pointer from the specified
425 // run loader. The AliRun object is loaded into memory using the run loader if
426 // not yet loaded. The MUON module object is then loaded from gAlice and
427 // AliMUONData fetched from the MUON module.
428 // kTRUE is returned if no error occurred otherwise kFALSE is returned.
430 AliDebug(3, Form("Fetching gAlice, MUON module and AliMUONData from runloader 0x%X.",
434 if (runloader->GetAliRun() == NULL) runloader->LoadgAlice();
435 gAlice = runloader->GetAliRun();
438 AliError(Form("Could not find the AliRun object in runloader 0x%X.", (void*)runloader));
441 fMUON = (AliMUON*) gAlice->GetDetector("MUON");
444 AliError(Form("Could not find the MUON module in runloader 0x%X.", (void*)runloader));
448 AliMUONLoader *muonloader = (AliMUONLoader*) runloader->GetLoader("MUONLoader");
449 if (muonloader == NULL)
451 AliError( "MUONLoader not found ");
456 if (fMUONData == NULL) fMUONData = new AliMUONData(muonloader,"MUON","MUON");
457 if (fMUONData == NULL)
459 AliError(Form("Could not find AliMUONData object in runloader 0x%X.", (void*)runloader));
465 //-----------------------------------------------------------------------
466 Bool_t AliMUONDigitizer::FetchTriggerPointer(AliMUONLoader* loader)
468 if (fMUONData == NULL) {
469 AliError("MUONData not found");
473 if (fTrigDec == NULL)
474 fTrigDec = new AliMUONTriggerDecision(loader,0,fMUONData);
478 //------------------------------------------------------------------------
479 void AliMUONDigitizer::ParseOptions(Option_t* options)
481 // Called by the Exec method. ParseOptions should parse the option string given to the Exec method.
483 // The following options are defined:
484 // "debug" - Sets the debug level to 99, which will show all debug messages.
485 // "deb" - Same as "debug", implemented for backward comparability.
487 // If an invalid option is specified it is simply ignored.
489 TString optionString = options;
490 if (optionString.Data() == "debug" ||
491 optionString.Data() == "deb" // maintained for compatability.
494 AliInfo("Called with option \"debug\".");
499 //------------------------------------------------------------------------
500 void AliMUONDigitizer::InitArrays()
502 // Creates a new fTDList object.
503 // Also creates an array of 2 * chamber_number AliMUONHitMapA1 objects
504 // in the fHitMaps array. Each one is set to a chamber and cathode
505 // specific segmentation model.
507 // Note: the fTDList and fHitMap arrays must be NULL before calling this method.
509 AliDebug(2, "Initialising internal arrays.");
510 AliDebug(4, "Creating transient digits list.");
511 fTDList = new TObjArray;
513 // Array of pointer of the AliMUONHitMapA1:
514 // two HitMaps per chamber, or one HitMap per cahtode plane
515 fHitMap = new AliMUONHitMapA1* [2*AliMUONConstants::NDetElem()];
516 CheckSegmentation(); // check it one for all
521 for (Int_t i = 0; i < AliMUONConstants::NCh(); i++) {
524 AliDebug(4,Form( "Creating hit map for chamber %d, cathode 1.", i+1));
525 AliMUONChamber* chamber = &(fMUON->Chamber(i));
526 AliMUONGeometrySegmentation* c1Segmentation = chamber->SegmentationModel2(1); // Cathode plane 1
527 AliDebug(4,Form( "Creating hit map for chamber %d, cathode 2.", i+1));
528 AliMUONGeometrySegmentation* c2Segmentation = chamber->SegmentationModel2(2); // Cathode plane 2
530 AliMUONGeometryModule* geometry = fMUON->Chamber(i).GetGeometry();
531 AliMUONGeometryStore* detElements = geometry->GetDetElementStore();
534 // Loop over detection elements
535 for (Int_t j=0; j<detElements->GetNofEntries(); j++) {
537 idDE = detElements->GetEntry(j)->GetUniqueID();
538 fNDetElemId[idDE] = k;
540 fHitMap[k] = new AliMUONHitMapA1(idDE,c1Segmentation, fTDList);
542 fHitMap[k+AliMUONConstants::NDetElem()] = new AliMUONHitMapA1(idDE,c2Segmentation, fTDList);
547 //------------------------------------------------------------------------
548 void AliMUONDigitizer::CleanupArrays()
550 // The arrays fTDList and fHitMap are deleted and the pointers set to NULL.
552 AliDebug(2, "Deleting internal arrays.");
553 for(Int_t i = 0; i < 2*AliMUONConstants::NDetElem(); i++) {
559 AliDebug(4, "Deleting transient digits list.");
566 //------------------------------------------------------------------------
567 void AliMUONDigitizer::SortTracks(Int_t *tracks, Int_t *charges, Int_t ntr) const
570 // Sort the list of tracks contributing to a given digit
571 // Only the 3 most significant tracks are actually sorted
574 if (ntr <= 1) return;
577 // Loop over signals, only 3 times
582 Int_t idx[3] = {-2,-2,-2};
583 Int_t jch[3] = {-2,-2,-2};
584 Int_t jtr[3] = {-2,-2,-2};
587 if (ntr < 3) imax = ntr;
590 for(i = 0; i < imax; i++)
595 for(j = 0; j < ntr; j++)
597 if ( (i == 1 && j == idx[i-1]) ||
598 (i == 2 && (j == idx[i-1] || j == idx[i-2]))
602 if(charges[j] > qmax)
612 jch[i] = charges[jmax];
613 jtr[i] = tracks[jmax];
618 for(i = 0; i < 3; i++)