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 kMaxStreamsToMerge 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 //_______________________________________________________________________
93 #include <Riostream.h>
103 #include "AliDigitizer.h"
104 #include "AliMergeCombi.h"
105 #include "AliRunLoader.h"
106 #include "AliLoader.h"
108 #include "AliRunDigitizer.h"
109 #include "AliStream.h"
110 #include "AliHeader.h"
112 ClassImp(AliRunDigitizer)
114 const TString AliRunDigitizer::fgkDefOutFolderName("Output");
115 const TString AliRunDigitizer::fgkBaseInFolderName("Input");
118 //_______________________________________________________________________
119 AliRunDigitizer::AliRunDigitizer():
124 fNrOfEventsToWrite(0),
125 fNrOfEventsWritten(0),
126 fCopyTreesFromInput(0),
131 fOutputInitialized(kFALSE),
134 fCombinationFileName(0),
137 // root requires default ctor, where no new objects can be created
138 // do not use this ctor, it is supplied only for root needs
140 // fOutputStream = 0x0;
143 //_______________________________________________________________________
144 AliRunDigitizer::AliRunDigitizer(Int_t nInputStreams, Int_t sperb):
145 TTask("AliRunDigitizer","The manager for Merging"),
146 fkMASKSTEP(10000000),
150 fNrOfEventsToWrite(-1),
151 fNrOfEventsWritten(0),
152 fCopyTreesFromInput(-1),
153 fNinputs(nInputStreams),
155 fInputStreams(new TClonesArray("AliStream",nInputStreams)),
157 fOutputInitialized(kFALSE),
158 fCombi(new AliMergeCombi(nInputStreams,sperb)),
159 fCombination(kMaxStreamsToMerge),
160 fCombinationFileName(0),
164 // ctor which should be used to create a manager for merging/digitization
165 if (nInputStreams == 0)
167 Fatal("AliRunDigitizer","Specify nr of input streams");
174 for (i=1;i<kMaxStreamsToMerge;i++)
176 fkMASK[i] = fkMASK[i-1] + fkMASKSTEP;
179 TClonesArray &lInputStreams = *fInputStreams;
181 // the first Input is open RW to be output as well
182 new(lInputStreams[0]) AliStream(fgkBaseInFolderName + "0","UPDATE");
183 //fOutputStream = (AliStream*)lInputStreams.At(0);//redirects output to first input
186 for (i=1;i<nInputStreams;i++) {
187 new(lInputStreams[i]) AliStream(fgkBaseInFolderName+(Long_t)i,"READ");
190 //_______________________________________________________________________
192 AliRunDigitizer::AliRunDigitizer(const AliRunDigitizer& dig):
197 fNrOfEventsToWrite(0),
198 fNrOfEventsWritten(0),
199 fCopyTreesFromInput(0),
204 fOutputInitialized(kFALSE),
207 fCombinationFileName(0),
215 //_______________________________________________________________________
217 void AliRunDigitizer::Copy(AliRunDigitizer&) const
219 Fatal("Copy","Not installed\n");
222 //_______________________________________________________________________
224 AliRunDigitizer::~AliRunDigitizer() {
226 if (GetListOfTasks())
227 GetListOfTasks()->Clear("nodelete");
228 delete fInputStreams;
230 delete fOutRunLoader;
232 //_______________________________________________________________________
233 void AliRunDigitizer::AddDigitizer(AliDigitizer *digitizer)
235 // add digitizer to the list of active digitizers
236 this->Add(digitizer);
238 //_______________________________________________________________________
239 void AliRunDigitizer::SetInputStream(Int_t i, const char *inputFile, TString foldername)
242 // Sets the name of the input file
244 if (i > fInputStreams->GetLast()) {
245 Error("SetInputStream","Input stream number too high");
248 AliStream * stream = static_cast<AliStream*>(fInputStreams->At(i)) ;
249 if ( !foldername.IsNull() ) {
251 foldername += i ; // foldername should stay unchanged for the default output
252 stream->SetFolderName(foldername) ;
254 stream->AddFile(inputFile);
257 //_______________________________________________________________________
258 void AliRunDigitizer::Digitize(Option_t* option)
260 // get a new combination of inputs, loads events to folders
262 // take gAlice from the first input file. It is needed to access
264 // If gAlice is already in memory, use it
269 if (!static_cast<AliStream*>(fInputStreams->At(0))->ImportgAlice())
271 Error("Digitize","Error occured while getting gAlice from Input 0");
276 if (!InitGlobal()) //calls Init() for all (sub)digitizers
278 Error("Digitize","InitGlobal returned error");
282 Int_t eventsCreated = 0;
283 // loop until there is anything on the input in case fNrOfEventsToWrite < 0
284 while ((eventsCreated++ < fNrOfEventsToWrite) || (fNrOfEventsToWrite < 0))
286 if (!ConnectInputTrees()) break;
287 InitEvent();//this must be after call of Connect Input tress.
290 fOutRunLoader->SetEventNumber(eventsCreated-1);
292 ExecuteTasks(option);// loop over all registered digitizers and let them do the work
299 //_______________________________________________________________________
300 Bool_t AliRunDigitizer::ConnectInputTrees()
303 Int_t eventNr[kMaxStreamsToMerge], delta[kMaxStreamsToMerge];
304 fCombi->Combination(eventNr, delta);
305 for (Int_t i=0;i<fNinputs;i++)
309 AliStream *iStream = static_cast<AliStream*>(fInputStreams->At(i));//gets the "i" defined in combination
310 if (!iStream->NextEventInStream()) return kFALSE; //sets serial number
312 else if (delta[i] != 0)
314 Error("ConnectInputTrees","Only delta 0 or 1 is implemented");
322 //_______________________________________________________________________
323 Bool_t AliRunDigitizer::InitGlobal()
325 // called once before Digitize() is called, initialize digitizers and output
326 fOutputInitialized = kFALSE;
327 TList* subTasks = this->GetListOfTasks();
329 TIter next(subTasks);
330 while (AliDigitizer * dig = (AliDigitizer *) next())
336 //_______________________________________________________________________
338 void AliRunDigitizer::SetOutputFile(TString fn)
340 // the output will be to separate file, not to the signal file
341 //here should be protection to avoid setting the same file as any input
342 Info("SetOutputFile","Setting Output File Name %s ",fn.Data());
343 fOutputFileName = fn;
344 // InitOutputGlobal();
347 //_______________________________________________________________________
348 Bool_t AliRunDigitizer::InitOutputGlobal()
350 // Creates the output file, called by InitEvent()
351 //Needs to be called after all inputs are opened
352 if (fOutputInitialized) return kTRUE;
354 if ( !fOutputFileName.IsNull())
356 fOutRunLoader = AliRunLoader::Open(fOutputFileName,fgkDefOutFolderName,"recreate");
358 if (fOutRunLoader == 0x0)
360 Error("InitOutputGlobal","Can not open ooutput");
363 Info("InitOutputGlobal", " 1 %s = ", GetInputFolderName(0).Data()) ;
364 AliRunLoader* inrl = AliRunLoader::GetRunLoader(GetInputFolderName(0));
367 Error("InitOutputGlobal","Can not get Run Loader Input 0. Maybe yet not initialized?");
370 Info("InitOutputGlobal", " 2 %#x = ", inrl) ;
372 //Copy all detector loaders from input 0 to output
373 const TObjArray* inloaders = inrl->GetArrayOfLoaders();
374 TIter next(inloaders);
376 while((loader = (AliLoader*)next()))
378 AliLoader* cloneloader = (AliLoader*)loader->Clone();
379 cloneloader->Register(fOutRunLoader->GetEventFolder());//creates folders for this loader in Output Folder Structure
380 GetOutRunLoader()->AddLoader(cloneloader);//adds a loader for output
383 fOutRunLoader->MakeTree("E");
385 if (GetDebug()>2) Info("InitOutputGlobal","file %s was opened.",fOutputFileName.Data());
387 fOutputInitialized = kTRUE;
390 //_______________________________________________________________________
392 void AliRunDigitizer::InitEvent()
394 //redirects output properly
397 Info("InitEvent","fEvent = %d",fEvent);
398 Info("InitEvent","fOutputFileName \"%s\"",fOutputFileName.Data());
400 if (fOutputInitialized == kFALSE) InitOutputGlobal();
402 // if fOutputFileName was not given, write output to signal directory
404 //_______________________________________________________________________
406 void AliRunDigitizer::FinishEvent()
408 // called at the end of loop over digitizers
411 if (GetOutRunLoader() == 0x0)
413 Error("FinishEvent","fOutRunLoader is null");
418 fNrOfEventsWritten++;
422 AliRunLoader* inrl = AliRunLoader::GetRunLoader(GetInputFolderName(0));
423 AliHeader* outheader = fOutRunLoader->GetHeader();
424 AliHeader* inheader = inrl->GetHeader();
428 inheader = inrl->GetHeader();
429 if (inheader == 0x0) Fatal("FinishEvent","Can not get header from input 0");
432 outheader->SetNprimary(inheader->GetNprimary());
433 outheader->SetNtrack(inheader->GetNtrack());
434 outheader->SetEvent(inheader->GetEvent());
435 outheader->SetEventNrInRun(inheader->GetEventNrInRun());
436 outheader->SetNvertex(inheader->GetNvertex());
437 fOutRunLoader->TreeE()->Fill();
440 if (fCopyTreesFromInput > -1)
442 //this is sensless since no information would be coherent in case of merging
444 cout<<"Copy trees from input: Copy or link files manually"<<endl;
448 //_______________________________________________________________________
450 void AliRunDigitizer::FinishGlobal()
452 // called at the end of Exec
453 // save unique objects to the output file
455 if (GetOutRunLoader() == 0x0)
457 Error("FinishGlobal","Can not get RunLoader from Output Stream folder");
460 GetOutRunLoader()->CdGAFile();
461 this->Write(0,TObject::kOverwrite);
464 fOutRunLoader->WriteHeader("OVERWRITE");
465 fOutRunLoader->WriteRunLoader("OVERWRITE");
466 TFolder* outfolder = fOutRunLoader->GetEventFolder();
467 if (outfolder == 0x0)
469 Error("FinishEvent","Can not get Event Folder");
473 AliRunLoader* inRN = AliRunLoader::GetRunLoader(GetInputFolderName(0));
474 outfolder->Add(inRN->GetAliRun());
475 fOutRunLoader->WriteAliRun("OVERWRITE");
478 if (fCopyTreesFromInput > -1)
480 //copy files manually
483 //_______________________________________________________________________
485 Int_t AliRunDigitizer::GetNParticles(Int_t event) const
487 // return number of particles in all input files for a given
488 // event (as numbered in the output file)
489 // return -1 if some file cannot be accessed
493 for (Int_t i = 0; i < fNinputs; i++) {
494 sumI = GetNParticles(GetInputEventNumber(event,i), i);
495 if (sumI < 0) return -1;
500 //_______________________________________________________________________
502 Int_t AliRunDigitizer::GetNParticles(Int_t event, Int_t input) const
504 // return number of particles in input file input for a given
505 // event (as numbered in this input file)
506 // return -1 if some error
508 // Must be revised in the version with AliStream
514 //_______________________________________________________________________
515 Int_t* AliRunDigitizer::GetInputEventNumbers(Int_t event) const
517 // return pointer to an int array with input event numbers which were
518 // merged in the output event event
520 // simplified for now, implement later
521 Int_t * a = new Int_t[kMaxStreamsToMerge];
522 for (Int_t i = 0; i < fNinputs; i++) {
527 //_______________________________________________________________________
528 Int_t AliRunDigitizer::GetInputEventNumber(Int_t event, Int_t input) const
530 // return an event number of an eventInput from input file input
531 // which was merged to create output event event
533 // simplified for now, implement later
536 //_______________________________________________________________________
537 TParticle* AliRunDigitizer::GetParticle(Int_t i, Int_t event) const
539 // return pointer to particle with index i (index with mask)
542 Int_t input = i/fkMASKSTEP;
543 return GetParticle(i,input,GetInputEventNumber(event,input));
546 //_______________________________________________________________________
547 TParticle* AliRunDigitizer::GetParticle(Int_t i, Int_t input, Int_t event) const
549 // return pointer to particle with index i in the input file input
550 // (index without mask)
551 // event is the event number in the file input
552 // return 0 i fit does not exist
554 // Must be revised in the version with AliStream
559 //_______________________________________________________________________
560 void AliRunDigitizer::ExecuteTask(Option_t* option)
562 // overwrite ExecuteTask to do Digitize only
564 if (!IsActive()) return;
566 fHasExecuted = kTRUE;
570 //_______________________________________________________________________
571 const TString& AliRunDigitizer::GetInputFolderName(Int_t i) const
573 AliStream* stream = dynamic_cast<AliStream*>(fInputStreams->At(i));
576 Fatal("GetInputFolderName","Can not get the input stream. Index = %d. Exiting",i);
578 return stream->GetFolderName();
580 //_______________________________________________________________________
582 const char* AliRunDigitizer::GetOutputFolderName()
584 return GetOutRunLoader()->GetEventFolder()->GetName();
586 //_______________________________________________________________________
588 AliRunLoader* AliRunDigitizer::GetOutRunLoader()
590 if (fOutRunLoader) return fOutRunLoader;
592 if ( fOutputFileName.IsNull() )
593 {//guard that sombody calls it without settting file name
594 cout<<"Output file name is empty. Using Input 0 for output\n";
595 return AliRunLoader::GetRunLoader(GetInputFolderName(0));
597 // InitOutputGlobal();
598 return fOutRunLoader;
600 //_______________________________________________________________________
602 TString AliRunDigitizer::GetInputFileName(const Int_t input, const Int_t order) const
604 // returns file name of the order-th file in the input stream input
605 // returns empty string if such file does not exist
606 // first input stream is 0
607 // first file in the input stream is 0
608 TString fileName("");
609 if (input >= fNinputs) return fileName;
610 AliStream * stream = static_cast<AliStream*>(fInputStreams->At(input));
611 if (order > stream->GetNInputFiles()) return fileName;
612 fileName = stream->GetFileName(order);