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 **************************************************************************/
18 //_______________________________________________________________________
20 // AliRunDigitizer.cxx
22 // Manager object for merging/digitization
24 // Instance of this class manages the digitization and/or merging of
25 // Sdigits into Digits.
27 // Only one instance of this class is created in the macro:
28 // AliRunDigitizer * manager =
29 // new AliRunDigitizer(nInputStreams,SPERB);
30 // where nInputStreams is number of input streams and SPERB is
31 // signals per background variable, which determines how combinations
32 // of signal and background events are generated.
33 // Then instances of specific detector digitizers are created:
34 // AliMUONDigitizer *dMUON = new AliMUONDigitizer(manager)
35 // and the I/O configured (you have to specify input files
36 // and an output file). The manager connects appropriate trees from
37 // the input files according a combination returned by AliMergeCombi
38 // class. It creates TreeD in the output and runs once per
39 // event Digitize method of all existing AliDetDigitizers
40 // (without any option). AliDetDigitizers ask manager
41 // for a TTree with input (manager->GetInputTreeS(Int_t i),
42 // merge all inputs, digitize it, and save it in the TreeD
43 // obtained by manager->GetTreeD(). Output events are stored with
44 // numbers from 0, this default can be changed by
45 // manager->SetFirstOutputEventNr(Int_t) method. The particle numbers
46 // in the output are shifted by MASK, which is taken from manager.
48 // The default output is to the signal file (stream 0). This can be
49 // changed with the SetOutputFile(TString fn) method.
51 // Single input file is permitted. Maximum MAXSTREAMSTOMERGE can be merged.
52 // Input from the memory (on-the-fly merging) is not yet
53 // supported, as well as access to the input data by invoking methods
54 // on the output data.
56 // Access to the some data is via gAlice for now (supposing the
57 // same geometry in all input files), gAlice is taken from the first
58 // input file on the first stream.
60 // Example with MUON digitizer, no merging, just digitization
62 // AliRunDigitizer * manager = new AliRunDigitizer(1,1);
63 // manager->SetInputStream(0,"galice.root");
64 // AliMUONDigitizer *dMUON = new AliMUONDigitizer(manager);
67 // Example with MUON digitizer, merge all events from
68 // galice.root (signal) file with events from bgr.root
69 // (background) file. Number of merged events is
70 // min(number of events in galice.root, number of events in bgr.root)
72 // AliRunDigitizer * manager = new AliRunDigitizer(2,1);
73 // manager->SetInputStream(0,"galice.root");
74 // manager->SetInputStream(1,"bgr.root");
75 // AliMUONDigitizer *dMUON = new AliMUONDigitizer(manager);
78 // Example with MUON digitizer, save digits in a new file digits.root,
79 // process only 1 event
81 // AliRunDigitizer * manager = new AliRunDigitizer(2,1);
82 // manager->SetInputStream(0,"galice.root");
83 // manager->SetInputStream(1,"bgr.root");
84 // manager->SetOutputFile("digits.root");
85 // AliMUONDigitizer *dMUON = new AliMUONDigitizer(manager);
86 // manager->SetNrOfEventsToWrite(1);
89 //_______________________________________________________________________
95 #include <Riostream.h>
101 #include "AliDigitizer.h"
102 #include "AliHeader.h"
103 #include "AliLoader.h"
104 #include "AliMergeCombi.h"
106 #include "AliRunDigitizer.h"
107 #include "AliRunLoader.h"
109 ClassImp(AliRunDigitizer)
111 const TString AliRunDigitizer::fgkDefOutFolderName("Output");
112 const TString AliRunDigitizer::fgkBaseInFolderName("Input");
115 //_______________________________________________________________________
116 AliRunDigitizer::AliRunDigitizer(): TTask("AliRunDigitizer","The manager for Merging"),
121 fNrOfEventsToWrite(0),
122 fNrOfEventsWritten(0),
123 fCopyTreesFromInput(0),
128 fOutputInitialized(kFALSE),
131 fCombinationFileName(0)
134 // root requires default ctor, where no new objects can be created
135 // do not use this ctor, it is supplied only for root needs
138 //_______________________________________________________________________
139 AliRunDigitizer::AliRunDigitizer(Int_t nInputStreams, Int_t sperb):
140 TTask("AliRunDigitizer","The manager for Merging"),
141 fkMASKSTEP(10000000),
145 fNrOfEventsToWrite(-1),
146 fNrOfEventsWritten(0),
147 fCopyTreesFromInput(-1),
148 fNinputs(nInputStreams),
150 fInputStreams(new TClonesArray("AliStream",nInputStreams)),
152 fOutputInitialized(kFALSE),
153 fCombi(new AliMergeCombi(nInputStreams,sperb)),
154 fCombination(MAXSTREAMSTOMERGE),
155 fCombinationFileName(0)
159 // ctor which should be used to create
160 // a manager for merging/digitization
162 if (nInputStreams == 0)
164 AliFatal("Specify nr of input streams");
171 for (i=1;i<MAXSTREAMSTOMERGE;i++)
173 fkMASK[i] = fkMASK[i-1] + fkMASKSTEP;
176 TClonesArray &lInputStreams = *fInputStreams;
178 new(lInputStreams[0]) AliStream(fgkBaseInFolderName+(Long_t)0,"UPDATE");
179 for (i=1;i<nInputStreams;i++) {
180 new(lInputStreams[i]) AliStream(fgkBaseInFolderName+(Long_t)i,"READ");
183 //_______________________________________________________________________
185 AliRunDigitizer::AliRunDigitizer(const AliRunDigitizer& dig):
191 fNrOfEventsToWrite(0),
192 fNrOfEventsWritten(0),
193 fCopyTreesFromInput(0),
198 fOutputInitialized(kFALSE),
201 fCombinationFileName(0)
208 //_______________________________________________________________________
210 void AliRunDigitizer::Copy(TObject&) const
213 // Non implemented copy function
215 AliFatal("Not installed");
218 //_______________________________________________________________________
220 AliRunDigitizer::~AliRunDigitizer()
225 delete fInputStreams;
227 delete fOutRunLoader;
229 //_______________________________________________________________________
230 void AliRunDigitizer::AddDigitizer(AliDigitizer *digitizer)
233 // add digitizer to the list of active digitizers
235 this->Add(digitizer);
237 //_______________________________________________________________________
238 void AliRunDigitizer::SetInputStream(Int_t i, const char *inputFile, TString foldername)
241 // Sets the name of the input file
243 if (i > fInputStreams->GetLast()) {
244 AliError("Input stream number too high");
247 AliStream * stream = static_cast<AliStream*>(fInputStreams->At(i)) ;
248 if ( !foldername.IsNull() ) {
250 foldername += i ; // foldername should stay unchanged for the default output
251 stream->SetFolderName(foldername) ;
253 stream->AddFile(inputFile);
256 //_______________________________________________________________________
257 void AliRunDigitizer::Digitize(Option_t* option)
259 // get a new combination of inputs, loads events to folders
261 // take gAlice from the first input file. It is needed to access
263 // If gAlice is already in memory, use it
265 if (!static_cast<AliStream*>(fInputStreams->At(0))->ImportgAlice())
267 AliError("Error occured while getting gAlice from Input 0");
271 if (!InitGlobal()) //calls Init() for all (sub)digitizers
273 AliError("InitGlobal returned error");
277 Int_t eventsCreated = 0;
278 // loop until there is anything on the input in case fNrOfEventsToWrite < 0
279 while ((eventsCreated++ < fNrOfEventsToWrite) || (fNrOfEventsToWrite < 0))
281 if (!ConnectInputTrees()) break;
282 InitEvent();//this must be after call of Connect Input tress.
285 fOutRunLoader->SetEventNumber(eventsCreated-1);
287 static_cast<AliStream*>(fInputStreams->At(0))->ImportgAlice(); // use gAlice of the first input stream
288 ExecuteTasks(option);// loop over all registered digitizers and let them do the work
295 //_______________________________________________________________________
296 Bool_t AliRunDigitizer::ConnectInputTrees()
301 Int_t eventNr[MAXSTREAMSTOMERGE], delta[MAXSTREAMSTOMERGE];
302 fCombi->Combination(eventNr, delta);
303 for (Int_t i=0;i<fNinputs;i++)
307 AliStream *iStream = static_cast<AliStream*>(fInputStreams->At(i));//gets the "i" defined in combination
308 if (!iStream->NextEventInStream()) return kFALSE; //sets serial number
310 else if (delta[i] != 0)
312 AliError("Only delta 0 or 1 is implemented");
320 //_______________________________________________________________________
321 Bool_t AliRunDigitizer::InitGlobal()
324 // Method called once before Digitize() is called
325 // initialize digitizers and output
327 fOutputInitialized = kFALSE;
328 TList* subTasks = this->GetListOfTasks();
330 TIter next(subTasks);
331 while (AliDigitizer * dig = (AliDigitizer *) next())
337 //_______________________________________________________________________
339 void AliRunDigitizer::SetOutputFile(TString fn)
342 // The output will be to separate file,
343 // not to the signal file here should be protection
344 //to avoid setting the same file as any input
346 AliInfo(Form("Setting Output File Name %s ",fn.Data()));
347 fOutputFileName = fn;
348 // InitOutputGlobal();
351 //_______________________________________________________________________
352 Bool_t AliRunDigitizer::InitOutputGlobal()
355 // Creates the output file, called by InitEvent()
356 // Needs to be called after all inputs are opened
358 if (fOutputInitialized) return kTRUE;
360 if ( !fOutputFileName.IsNull())
362 fOutRunLoader = AliRunLoader::Open(fOutputFileName,fgkDefOutFolderName,"recreate");
364 if (fOutRunLoader == 0x0)
366 AliError("Can not open output");
369 Info("InitOutputGlobal", " 1 %s = ", GetInputFolderName(0).Data()) ;
370 AliRunLoader* inrl = AliRunLoader::GetRunLoader(GetInputFolderName(0));
373 AliError("Can not get Run Loader Input 0. Maybe yet not initialized?");
376 AliDebug(2, Form(" 2 %#x = ", inrl)) ;
378 //Copy all detector loaders from input 0 to output
379 const TObjArray* inloaders = inrl->GetArrayOfLoaders();
380 TIter next(inloaders);
382 while((loader = (AliLoader*)next()))
384 AliLoader* cloneloader = (AliLoader*)loader->Clone();
385 cloneloader->Register(fOutRunLoader->GetEventFolder());//creates folders for this loader in Output Folder Structure
386 GetOutRunLoader()->AddLoader(cloneloader);//adds a loader for output
389 fOutRunLoader->MakeTree("E");
391 AliDebug(3,Form("file %s was opened.",fOutputFileName.Data()));
393 fOutputInitialized = kTRUE;
396 //_______________________________________________________________________
398 void AliRunDigitizer::InitEvent()
401 // redirects output properly
403 AliDebug(3,Form("fEvent = %d",fEvent));
404 AliDebug(3,Form("fOutputFileName \"%s\"",fOutputFileName.Data()));
405 if (fOutputInitialized == kFALSE) InitOutputGlobal();
407 // if fOutputFileName was not given, write output to signal directory
409 //_______________________________________________________________________
411 void AliRunDigitizer::FinishEvent()
414 // called at the end of loop over digitizers
417 if (GetOutRunLoader() == 0x0)
419 AliError("fOutRunLoader is null");
424 fNrOfEventsWritten++;
428 AliRunLoader* inrl = AliRunLoader::GetRunLoader(GetInputFolderName(0));
429 AliHeader* outheader = fOutRunLoader->GetHeader();
430 AliHeader* inheader = inrl->GetHeader();
434 inheader = inrl->GetHeader();
435 if (inheader == 0x0) AliFatal("Can not get header from input 0");
438 outheader->SetNprimary(inheader->GetNprimary());
439 outheader->SetNtrack(inheader->GetNtrack());
440 outheader->SetEvent(inheader->GetEvent());
441 outheader->SetEventNrInRun(inheader->GetEventNrInRun());
442 outheader->SetNvertex(inheader->GetNvertex());
443 fOutRunLoader->TreeE()->Fill();
446 if (fCopyTreesFromInput > -1)
448 //this is sensless since no information would be coherent in case of merging
450 AliWarning("Copy trees from input: Copy or link files manually");
454 //_______________________________________________________________________
456 void AliRunDigitizer::FinishGlobal()
459 // called at the end of Exec
460 // save unique objects to the output file
462 if (GetOutRunLoader() == 0x0)
464 AliError("Can not get RunLoader from Output Stream folder");
467 GetOutRunLoader()->CdGAFile();
468 this->Write(NULL, TObject::kOverwrite);
471 fOutRunLoader->WriteHeader("OVERWRITE");
472 fOutRunLoader->WriteRunLoader("OVERWRITE");
473 TFolder* outfolder = fOutRunLoader->GetEventFolder();
474 if (outfolder == 0x0)
476 AliError("Can not get Event Folder");
480 AliRunLoader* inRN = AliRunLoader::GetRunLoader(GetInputFolderName(0));
481 outfolder->Add(inRN->GetAliRun());
482 fOutRunLoader->WriteAliRun("OVERWRITE");
485 if (fCopyTreesFromInput > -1)
487 //copy files manually
490 //_______________________________________________________________________
492 Int_t AliRunDigitizer::GetNParticles(Int_t event) const
494 // return number of particles in all input files for a given
495 // event (as numbered in the output file)
496 // return -1 if some file cannot be accessed
500 for (Int_t i = 0; i < fNinputs; i++) {
501 sumI = GetNParticles(GetInputEventNumber(event,i), i);
502 if (sumI < 0) return -1;
507 //_______________________________________________________________________
509 Int_t AliRunDigitizer::GetNParticles(Int_t /*event*/, Int_t /*input*/) const
511 // return number of particles in input file input for a given
512 // event (as numbered in this input file)
513 // return -1 if some error
515 // Must be revised in the version with AliStream
521 //_______________________________________________________________________
522 Int_t* AliRunDigitizer::GetInputEventNumbers(Int_t event) const
524 // return pointer to an int array with input event numbers which were
525 // merged in the output event event
527 // simplified for now, implement later
528 Int_t * a = new Int_t[MAXSTREAMSTOMERGE];
529 for (Int_t i = 0; i < fNinputs; i++) {
534 //_______________________________________________________________________
535 Int_t AliRunDigitizer::GetInputEventNumber(Int_t event, Int_t /*input*/) const
537 // return an event number of an eventInput from input file input
538 // which was merged to create output event event
540 // simplified for now, implement later
543 //_______________________________________________________________________
544 TParticle* AliRunDigitizer::GetParticle(Int_t i, Int_t event) const
546 // return pointer to particle with index i (index with mask)
549 Int_t input = i/fkMASKSTEP;
550 return GetParticle(i,input,GetInputEventNumber(event,input));
553 //_______________________________________________________________________
554 TParticle* AliRunDigitizer::GetParticle(Int_t /*i*/, Int_t /*input*/, Int_t /*event*/) const
556 // return pointer to particle with index i in the input file input
557 // (index without mask)
558 // event is the event number in the file input
559 // return 0 i fit does not exist
561 // Must be revised in the version with AliStream
566 //_______________________________________________________________________
567 void AliRunDigitizer::ExecuteTask(Option_t* option)
570 // overwrite ExecuteTask to do Digitize only
572 if (!IsActive()) return;
574 fHasExecuted = kTRUE;
578 //_______________________________________________________________________
579 const TString& AliRunDigitizer::GetInputFolderName(Int_t i) const
582 // Get the input Folder Name
584 AliStream* stream = dynamic_cast<AliStream*>(fInputStreams->At(i));
586 AliFatal(Form("Can not get the input stream. Index = %d. Exiting",i));
587 return stream->GetFolderName();
589 //_______________________________________________________________________
591 const char* AliRunDigitizer::GetOutputFolderName()
594 // Get output folder name
596 return GetOutRunLoader()->GetEventFolder()->GetName();
598 //_______________________________________________________________________
600 AliRunLoader* AliRunDigitizer::GetOutRunLoader()
603 // Returns Run Loader
605 if (fOutRunLoader) return fOutRunLoader;
607 if ( fOutputFileName.IsNull() )
608 {//guard that sombody calls it without settting file name
609 AliDebug(1,"Output file name is empty. Using Input 0 for output");
610 return AliRunLoader::GetRunLoader(GetInputFolderName(0));
612 // InitOutputGlobal();
613 return fOutRunLoader;
615 //_______________________________________________________________________
617 TString AliRunDigitizer::GetInputFileName(Int_t input, Int_t order) const
619 // returns file name of the order-th file in the input stream input
620 // returns empty string if such file does not exist
621 // first input stream is 0
622 // first file in the input stream is 0
623 TString fileName("");
624 if (input >= fNinputs) return fileName;
625 AliStream * stream = static_cast<AliStream*>(fInputStreams->At(input));
626 if (order > stream->GetNInputFiles()) return fileName;
627 fileName = stream->GetFileName(order);