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 **************************************************************************/
17 // Author: Andrei Gheata, 31/05/2006
19 //==============================================================================
20 // AliAnalysysManager - Manager analysis class. Allows creation of several
21 // analysis tasks and data containers storing their input/output. Allows
22 // connecting/chaining tasks via shared data containers. Serializes the current
23 // event for all tasks depending only on initial input data.
24 //==============================================================================
26 //==============================================================================
28 #include <Riostream.h>
32 #include <TMethodCall.h>
37 #include "AliAnalysisTask.h"
38 #include "AliAnalysisDataContainer.h"
39 #include "AliAnalysisDataSlot.h"
40 #include "AliVEventHandler.h"
41 #include "AliAnalysisManager.h"
43 ClassImp(AliAnalysisManager)
45 AliAnalysisManager *AliAnalysisManager::fgAnalysisManager = NULL;
47 //______________________________________________________________________________
48 AliAnalysisManager::AliAnalysisManager()
51 fOutputEventHandler(NULL),
52 fMCtruthEventHandler(NULL),
54 fMode(kLocalAnalysis),
65 fgAnalysisManager = this;
69 //______________________________________________________________________________
70 AliAnalysisManager::AliAnalysisManager(const char *name, const char *title)
73 fOutputEventHandler(NULL),
74 fMCtruthEventHandler(NULL),
76 fMode(kLocalAnalysis),
86 // Default constructor.
87 fgAnalysisManager = this;
88 fTasks = new TObjArray();
89 fTopTasks = new TObjArray();
90 fZombies = new TObjArray();
91 fContainers = new TObjArray();
92 fInputs = new TObjArray();
93 fOutputs = new TObjArray();
97 //______________________________________________________________________________
98 AliAnalysisManager::AliAnalysisManager(const AliAnalysisManager& other)
101 fOutputEventHandler(NULL),
102 fMCtruthEventHandler(NULL),
105 fInitOK(other.fInitOK),
106 fDebug(other.fDebug),
115 fTasks = new TObjArray(*other.fTasks);
116 fTopTasks = new TObjArray(*other.fTopTasks);
117 fZombies = new TObjArray(*other.fZombies);
118 fContainers = new TObjArray(*other.fContainers);
119 fInputs = new TObjArray(*other.fInputs);
120 fOutputs = new TObjArray(*other.fOutputs);
121 fgAnalysisManager = this;
124 //______________________________________________________________________________
125 AliAnalysisManager& AliAnalysisManager::operator=(const AliAnalysisManager& other)
128 if (&other != this) {
129 TNamed::operator=(other);
130 fOutputEventHandler = other.fOutputEventHandler;
131 fMCtruthEventHandler = other.fMCtruthEventHandler;
135 fInitOK = other.fInitOK;
136 fDebug = other.fDebug;
137 fTasks = new TObjArray(*other.fTasks);
138 fTopTasks = new TObjArray(*other.fTopTasks);
139 fZombies = new TObjArray(*other.fZombies);
140 fContainers = new TObjArray(*other.fContainers);
141 fInputs = new TObjArray(*other.fInputs);
142 fOutputs = new TObjArray(*other.fOutputs);
143 fgAnalysisManager = this;
148 //______________________________________________________________________________
149 AliAnalysisManager::~AliAnalysisManager()
152 if (fTasks) {fTasks->Delete(); delete fTasks;}
153 if (fTopTasks) delete fTopTasks;
154 if (fZombies) delete fZombies;
155 if (fContainers) {fContainers->Delete(); delete fContainers;}
156 if (fInputs) delete fInputs;
157 if (fOutputs) delete fOutputs;
158 if (fgAnalysisManager==this) fgAnalysisManager = NULL;
161 //______________________________________________________________________________
162 Int_t AliAnalysisManager::GetEntry(Long64_t entry, Int_t getall)
164 // Read one entry of the tree or a whole branch.
166 cout << "== AliAnalysisManager::GetEntry()" << endl;
168 fCurrentEntry = entry;
169 return fTree ? fTree->GetTree()->GetEntry(entry, getall) : 0;
172 //______________________________________________________________________________
173 void AliAnalysisManager::Init(TTree *tree)
175 // The Init() function is called when the selector needs to initialize
176 // a new tree or chain. Typically here the branch addresses of the tree
177 // will be set. It is normaly not necessary to make changes to the
178 // generated code, but the routine can be extended by the user if needed.
179 // Init() will be called many times when running with PROOF.
182 printf("->AliAnalysisManager::Init(%s)\n", tree->GetName());
184 if (!fInitOK) InitAnalysis();
185 if (!fInitOK) return;
187 AliAnalysisDataContainer *top = (AliAnalysisDataContainer*)fInputs->At(0);
189 cout<<"Error: No top input container !" <<endl;
194 printf("<-AliAnalysisManager::Init(%s)\n", tree->GetName());
198 //______________________________________________________________________________
199 void AliAnalysisManager::Begin(TTree *tree)
201 // The Begin() function is called at the start of the query.
202 // When running with PROOF Begin() is only called on the client.
203 // The tree argument is deprecated (on PROOF 0 is passed).
205 cout << "AliAnalysisManager::Begin()" << endl;
210 //______________________________________________________________________________
211 void AliAnalysisManager::SlaveBegin(TTree *tree)
213 // The SlaveBegin() function is called after the Begin() function.
214 // When running with PROOF SlaveBegin() is called on each slave server.
215 // The tree argument is deprecated (on PROOF 0 is passed).
217 cout << "->AliAnalysisManager::SlaveBegin()" << endl;
219 // Call InitIO of EventHandler
220 if (fOutputEventHandler) {
221 if (fMode == kProofAnalysis) {
222 fOutputEventHandler->InitIO("proof");
224 fOutputEventHandler->InitIO("local");
229 AliAnalysisTask *task;
230 // Call CreateOutputObjects for all tasks
231 while ((task=(AliAnalysisTask*)next())) {
232 TDirectory *curdir = gDirectory;
233 task->CreateOutputObjects();
234 if (curdir) curdir->cd();
236 if (fMode == kLocalAnalysis) Init(tree);
238 cout << "<-AliAnalysisManager::SlaveBegin()" << endl;
242 //______________________________________________________________________________
243 Bool_t AliAnalysisManager::Notify()
245 // The Notify() function is called when a new file is opened. This
246 // can be either for a new TTree in a TChain or when when a new TTree
247 // is started when using PROOF. It is normaly not necessary to make changes
248 // to the generated code, but the routine can be extended by the
249 // user if needed. The return value is currently not used.
251 TFile *curfile = fTree->GetCurrentFile();
252 if (curfile && fDebug>1) printf("AliAnalysisManager::Notify() file: %s\n", curfile->GetName());
254 AliAnalysisTask *task;
255 // Call Notify for all tasks
256 while ((task=(AliAnalysisTask*)next()))
259 // Call Notify of the MC truth handler
260 if (fMCtruthEventHandler) {
261 fMCtruthEventHandler->Notify(curfile->GetName());
267 //______________________________________________________________________________
268 Bool_t AliAnalysisManager::Process(Long64_t entry)
270 // The Process() function is called for each entry in the tree (or possibly
271 // keyed object in the case of PROOF) to be processed. The entry argument
272 // specifies which entry in the currently loaded tree is to be processed.
273 // It can be passed to either TTree::GetEntry() or TBranch::GetEntry()
274 // to read either all or the required parts of the data. When processing
275 // keyed objects with PROOF, the object is already loaded and is available
276 // via the fObject pointer.
278 // This function should contain the "body" of the analysis. It can contain
279 // simple or elaborate selection criteria, run algorithms on the data
280 // of the event and typically fill histograms.
282 // WARNING when a selector is used with a TChain, you must use
283 // the pointer to the current TTree to call GetEntry(entry).
284 // The entry is always the local entry number in the current tree.
285 // Assuming that fChain is the pointer to the TChain being processed,
286 // use fChain->GetTree()->GetEntry(entry).
288 cout << "->AliAnalysisManager::Process()" << endl;
291 if (fOutputEventHandler) fOutputEventHandler ->BeginEvent();
292 if (fMCtruthEventHandler) fMCtruthEventHandler->BeginEvent();
297 cout << "<-AliAnalysisManager::Process()" << endl;
302 //______________________________________________________________________________
303 void AliAnalysisManager::PackOutput(TList *target)
305 // Pack all output data containers in the output list. Called at SlaveTerminate
306 // stage in PROOF case for each slave.
308 cout << "->AliAnalysisManager::PackOutput()" << endl;
311 Error("PackOutput", "No target. Aborting.");
315 if (fOutputEventHandler) fOutputEventHandler ->Terminate();
316 if (fMCtruthEventHandler) fMCtruthEventHandler->Terminate();
318 if (fMode == kProofAnalysis) {
319 TIter next(fOutputs);
320 AliAnalysisDataContainer *output;
321 while ((output=(AliAnalysisDataContainer*)next())) {
322 if (fDebug > 1) printf(" Packing container %s...\n", output->GetName());
323 if (output->GetData()) target->Add(output->ExportData());
327 printf("<-AliAnalysisManager::PackOutput: output list contains %d containers\n", target->GetSize());
331 //______________________________________________________________________________
332 void AliAnalysisManager::ImportWrappers(TList *source)
334 // Import data in output containers from wrappers coming in source.
336 cout << "->AliAnalysisManager::ImportWrappers()" << endl;
338 TIter next(fOutputs);
339 AliAnalysisDataContainer *cont;
340 AliAnalysisDataWrapper *wrap;
342 while ((cont=(AliAnalysisDataContainer*)next())) {
343 wrap = (AliAnalysisDataWrapper*)source->FindObject(cont->GetName());
344 if (!wrap && fDebug>1) {
345 printf("(WW) ImportWrappers: container %s not found in analysis output !\n", cont->GetName());
349 if (fDebug > 1) printf(" Importing data for container %s\n", wrap->GetName());
350 if (cont->GetFileName()) printf(" -> %s\n", cont->GetFileName());
351 cont->ImportData(wrap);
354 cout << "<-AliAnalysisManager::ImportWrappers(): "<< icont << " containers imported" << endl;
358 //______________________________________________________________________________
359 void AliAnalysisManager::UnpackOutput(TList *source)
361 // Called by AliAnalysisSelector::Terminate. Output containers should
362 // be in source in the same order as in fOutputs.
364 cout << "->AliAnalysisManager::UnpackOutput()" << endl;
367 Error("UnpackOutput", "No target. Aborting.");
371 printf(" Source list contains %d containers\n", source->GetSize());
374 if (fMode == kProofAnalysis) ImportWrappers(source);
376 TIter next(fOutputs);
377 AliAnalysisDataContainer *output;
378 while ((output=(AliAnalysisDataContainer*)next())) {
379 if (!output->GetData()) continue;
380 // Check if there are client tasks that run post event loop
381 if (output->HasConsumers()) {
382 // Disable event loop semaphore
383 output->SetPostEventLoop(kTRUE);
384 TObjArray *list = output->GetConsumers();
385 Int_t ncons = list->GetEntriesFast();
386 for (Int_t i=0; i<ncons; i++) {
387 AliAnalysisTask *task = (AliAnalysisTask*)list->At(i);
388 task->CheckNotify(kTRUE);
389 // If task is active, execute it
390 if (task->IsPostEventLoop() && task->IsActive()) {
392 cout << "== Executing post event loop task " << task->GetName() << endl;
398 // Check if the output need to be written to a file.
399 const char *filename = output->GetFileName();
400 if (!(strcmp(filename, "default"))) {
401 if (fOutputEventHandler) filename = fOutputEventHandler->GetOutputFileName();
404 if (!filename || !strlen(filename)) continue;
405 TFile *file = (TFile*)gROOT->GetListOfFiles()->FindObject(filename);
406 if (file) file->cd();
407 else file = new TFile(filename, "RECREATE");
408 if (file->IsZombie()) continue;
409 // Reparent data to this file
411 if (output->GetData()->IsA())
412 callEnv.InitWithPrototype(output->GetData()->IsA(), "SetDirectory", "TDirectory*");
413 if (callEnv.IsValid()) {
414 callEnv.SetParam((Long_t) file);
415 callEnv.Execute(output->GetData());
417 output->GetData()->Write();
420 cout << "<-AliAnalysisManager::UnpackOutput()" << endl;
424 //______________________________________________________________________________
425 void AliAnalysisManager::Terminate()
427 // The Terminate() function is the last function to be called during
428 // a query. It always runs on the client, it can be used to present
429 // the results graphically.
431 cout << "->AliAnalysisManager::Terminate()" << endl;
433 AliAnalysisTask *task;
435 // Call Terminate() for tasks
436 while ((task=(AliAnalysisTask*)next())) task->Terminate();
438 cout << "<-AliAnalysisManager::Terminate()" << endl;
441 if (fOutputEventHandler) fOutputEventHandler->TerminateIO();
444 //______________________________________________________________________________
445 void AliAnalysisManager::AddTask(AliAnalysisTask *task)
447 // Adds a user task to the global list of tasks.
448 task->SetActive(kFALSE);
452 //______________________________________________________________________________
453 AliAnalysisTask *AliAnalysisManager::GetTask(const char *name) const
455 // Retreive task by name.
456 if (!fTasks) return NULL;
457 return (AliAnalysisTask*)fTasks->FindObject(name);
460 //______________________________________________________________________________
461 AliAnalysisDataContainer *AliAnalysisManager::CreateContainer(const char *name,
462 TClass *datatype, EAliAnalysisContType type, const char *filename)
464 // Create a data container of a certain type. Types can be:
465 // kExchangeContainer = 0, used to exchange date between tasks
466 // kInputContainer = 1, used to store input data
467 // kOutputContainer = 2, used for posting results
468 if (fContainers->FindObject(name)) {
469 Error("CreateContainer","A container named %s already defined !\n",name);
472 AliAnalysisDataContainer *cont = new AliAnalysisDataContainer(name, datatype);
473 fContainers->Add(cont);
475 case kInputContainer:
478 case kOutputContainer:
480 if (filename && strlen(filename)) cont->SetFileName(filename);
482 case kExchangeContainer:
488 //______________________________________________________________________________
489 Bool_t AliAnalysisManager::ConnectInput(AliAnalysisTask *task, Int_t islot,
490 AliAnalysisDataContainer *cont)
492 // Connect input of an existing task to a data container.
493 if (!fTasks->FindObject(task)) {
495 Warning("ConnectInput", "Task %s not registered. Now owned by analysis manager", task->GetName());
497 Bool_t connected = task->ConnectInput(islot, cont);
501 //______________________________________________________________________________
502 Bool_t AliAnalysisManager::ConnectOutput(AliAnalysisTask *task, Int_t islot,
503 AliAnalysisDataContainer *cont)
505 // Connect output of an existing task to a data container.
506 if (!fTasks->FindObject(task)) {
508 Warning("ConnectOutput", "Task %s not registered. Now owned by analysis manager", task->GetName());
510 Bool_t connected = task->ConnectOutput(islot, cont);
514 //______________________________________________________________________________
515 void AliAnalysisManager::CleanContainers()
517 // Clean data from all containers that have already finished all client tasks.
518 TIter next(fContainers);
519 AliAnalysisDataContainer *cont;
520 while ((cont=(AliAnalysisDataContainer *)next())) {
521 if (cont->IsOwnedData() &&
522 cont->IsDataReady() &&
523 cont->ClientsExecuted()) cont->DeleteData();
527 //______________________________________________________________________________
528 Bool_t AliAnalysisManager::InitAnalysis()
530 // Initialization of analysis chain of tasks. Should be called after all tasks
531 // and data containers are properly connected
532 // Check for input/output containers
534 // Check for top tasks (depending only on input data containers)
535 if (!fTasks->First()) {
536 Error("InitAnalysis", "Analysis has no tasks !");
540 AliAnalysisTask *task;
541 AliAnalysisDataContainer *cont;
544 Bool_t iszombie = kFALSE;
545 Bool_t istop = kTRUE;
547 while ((task=(AliAnalysisTask*)next())) {
550 Int_t ninputs = task->GetNinputs();
551 for (i=0; i<ninputs; i++) {
552 cont = task->GetInputSlot(i)->GetContainer();
560 Error("InitAnalysis", "Input slot %d of task %s has no container connected ! Declared zombie...",
563 if (iszombie) continue;
564 // Check if cont is an input container
565 if (istop && !fInputs->FindObject(cont)) istop=kFALSE;
566 // Connect to parent task
570 fTopTasks->Add(task);
574 Error("InitAnalysis", "No top task defined. At least one task should be connected only to input containers");
577 // Check now if there are orphan tasks
578 for (i=0; i<ntop; i++) {
579 task = (AliAnalysisTask*)fTopTasks->At(i);
584 while ((task=(AliAnalysisTask*)next())) {
585 if (!task->IsUsed()) {
587 Warning("InitAnalysis", "Task %s is orphan", task->GetName());
590 // Check the task hierarchy (no parent task should depend on data provided
591 // by a daughter task)
592 for (i=0; i<ntop; i++) {
593 task = (AliAnalysisTask*)fTopTasks->At(i);
594 if (task->CheckCircularDeps()) {
595 Error("InitAnalysis", "Found illegal circular dependencies between following tasks:");
600 // Check that all containers feeding post-event loop tasks are in the outputs list
601 TIter nextcont(fContainers); // loop over all containers
602 while ((cont=(AliAnalysisDataContainer*)nextcont())) {
603 if (!cont->IsPostEventLoop() && !fOutputs->FindObject(cont)) {
604 if (cont->HasConsumers()) {
605 // Check if one of the consumers is post event loop
606 TIter nextconsumer(cont->GetConsumers());
607 while ((task=(AliAnalysisTask*)nextconsumer())) {
608 if (task->IsPostEventLoop()) {
620 //______________________________________________________________________________
621 void AliAnalysisManager::PrintStatus(Option_t *option) const
623 // Print task hierarchy.
624 TIter next(fTopTasks);
625 AliAnalysisTask *task;
626 while ((task=(AliAnalysisTask*)next()))
627 task->PrintTask(option);
630 //______________________________________________________________________________
631 void AliAnalysisManager::ResetAnalysis()
633 // Reset all execution flags and clean containers.
637 //______________________________________________________________________________
638 void AliAnalysisManager::StartAnalysis(const char *type, TTree *tree)
640 // Start analysis for this manager. Analysis task can be: LOCAL, PROOF or GRID.
642 Error("StartAnalysis","Analysis manager was not initialized !");
646 cout << "StartAnalysis: " << GetName() << endl;
648 TString anaType = type;
650 fMode = kLocalAnalysis;
652 if (anaType.Contains("proof")) fMode = kProofAnalysis;
653 else if (anaType.Contains("grid")) fMode = kGridAnalysis;
655 if (fMode == kGridAnalysis) {
656 Warning("StartAnalysis", "GRID analysis mode not implemented. Running local.");
657 fMode = kLocalAnalysis;
660 SetEventLoop(kFALSE);
661 // Disable all branches if requested and set event loop mode
663 if (TestBit(kDisableBranches)) {
664 printf("Disabling all branches...\n");
665 // tree->SetBranchStatus("*",0); // not yet working
670 TChain *chain = dynamic_cast<TChain*>(tree);
672 // Initialize locally all tasks
674 AliAnalysisTask *task;
675 while ((task=(AliAnalysisTask*)next())) {
683 AliAnalysisTask *task;
684 // Call CreateOutputObjects for all tasks
685 while ((task=(AliAnalysisTask*)next())) {
686 TDirectory *curdir = gDirectory;
687 task->CreateOutputObjects();
688 if (curdir) curdir->cd();
694 // Run tree-based analysis via AliAnalysisSelector
695 // gROOT->ProcessLine(".L $ALICE_ROOT/ANALYSIS/AliAnalysisSelector.cxx+");
696 cout << "===== RUNNING LOCAL ANALYSIS " << GetName() << " ON TREE " << tree->GetName() << endl;
697 sprintf(line, "AliAnalysisSelector *selector = new AliAnalysisSelector((AliAnalysisManager*)0x%lx);",(ULong_t)this);
698 gROOT->ProcessLine(line);
699 sprintf(line, "((TTree*)0x%lx)->Process(selector);",(ULong_t)tree);
700 gROOT->ProcessLine(line);
703 if (!gROOT->GetListOfProofs() || !gROOT->GetListOfProofs()->GetEntries()) {
704 printf("StartAnalysis: no PROOF!!!\n");
707 sprintf(line, "gProof->AddInput((TObject*)0x%lx);", (ULong_t)this);
708 gROOT->ProcessLine(line);
711 cout << "===== RUNNING PROOF ANALYSIS " << GetName() << " ON CHAIN " << chain->GetName() << endl;
712 chain->Process("AliAnalysisSelector");
714 printf("StartAnalysis: no chain\n");
719 Warning("StartAnalysis", "GRID analysis mode not implemented. Running local.");
723 //______________________________________________________________________________
724 void AliAnalysisManager::ExecAnalysis(Option_t *option)
728 Error("ExecAnalysis", "Analysis manager was not initialized !");
731 AliAnalysisTask *task;
732 // Check if the top tree is active.
735 printf("AliAnalysisManager::ExecAnalysis\n");
738 // De-activate all tasks
739 while ((task=(AliAnalysisTask*)next())) task->SetActive(kFALSE);
740 AliAnalysisDataContainer *cont = (AliAnalysisDataContainer*)fInputs->At(0);
742 Error("ExecAnalysis","Cannot execute analysis in TSelector mode without at least one top container");
745 cont->SetData(fTree); // This will notify all consumers
747 // Call BeginEvent() for optional output and MC services
748 if (fOutputEventHandler) fOutputEventHandler ->BeginEvent();
749 if (fMCtruthEventHandler) fMCtruthEventHandler->BeginEvent();
752 TIter next1(cont->GetConsumers());
753 while ((task=(AliAnalysisTask*)next1())) {
755 cout << " Executing task " << task->GetName() << endl;
758 task->ExecuteTask(option);
761 // Call FinishEvent() for optional output and MC services
762 if (fOutputEventHandler) fOutputEventHandler ->FinishEvent();
763 if (fMCtruthEventHandler) fMCtruthEventHandler->FinishEvent();
767 // The event loop is not controlled by TSelector
769 // Call BeginEvent() for optional output and MC services
770 if (fOutputEventHandler) fOutputEventHandler ->BeginEvent();
771 if (fMCtruthEventHandler) fMCtruthEventHandler->BeginEvent();
772 TIter next2(fTopTasks);
773 while ((task=(AliAnalysisTask*)next2())) {
774 task->SetActive(kTRUE);
776 cout << " Executing task " << task->GetName() << endl;
778 task->ExecuteTask(option);
781 // Call FinishEvent() for optional output and MC services
782 if (fOutputEventHandler) fOutputEventHandler->FinishEvent();
783 if (fMCtruthEventHandler) fMCtruthEventHandler->FinishEvent();
786 //______________________________________________________________________________
787 void AliAnalysisManager::FinishAnalysis()