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 // AliAnalysysTask - Class representing a basic analysis task. Any
21 // user-defined task should derive from it and implement the Exec() virtual
23 //==============================================================================
25 // A specific user analysis task have to derive from this class. The list of
26 // specific input and output slots have to be defined in the derived class ctor:
28 // UserTask::UserTask(name, title)
30 // DefineInput(0, TTree::Class());
31 // DefineInput(1, TH1::Class());
33 // DefineOutput(0, TTree::Class());
34 // DefineOutput(1, MyObject::Class());
38 // An existing data contaner (AliAnalysisDataContainer) can be connected to the
39 // input/output slots of an analysis task. Containers should not be defined and
40 // connected by the derived analysis task, but from the level of AliAnalysisManager:
42 // AliAnalysisManager::ConnectInput(AliAnalysisTask *task, Int_t islot,
43 // AliAnalysisDataContainer *cont)
44 // AliAnalysisManager::ConnectOutput(AliAnalysisTask *task, Int_t islot,
45 // AliAnalysisDataContainer *cont)
46 // To connect a slot to a data container, the data types declared by both must
49 // The method ConnectInputData() has to be overloaded by the derived class in order to
50 // set the branch address or connect to a branch address in case the input
51 // slots are connected to trees.
53 // MyAnalysisTask::ConnectInputData(Option_t *)
55 // // One should first check if the branch address was taken by some other task
56 // char ** address = (char **)GetBranchAddress(0, "ESD");
58 // fESD = (AliESD*)(*address);
60 // fESD = new AliESD();
61 // SetBranchAddress(0, "ESD", &fESD);
65 // The method LocalInit() may be implemented to call locally (on the client)
66 // all initialization methods of the class. It is not mandatory and was created
67 // in order to minimize the complexity and readability of the analysis macro.
68 // DO NOT create in this method the histigrams or task output objects that will
69 // go in the task output containers. Use CreateOutputObjects for that.
71 // The method CreateOutputObjects() has to be implemented an will contain the
72 // objects that should be created only once per session (e.g. output
75 // void MyAnalysisTask::CreateOutputObjects()
78 // fhPt = new TH1F("fhPt","This is the Pt distribution",15,0.1,3.1);
79 // fhPt->SetStats(kTRUE);
80 // fhPt->GetXaxis()->SetTitle("P_{T} [GeV]");
81 // fhPt->GetYaxis()->SetTitle("#frac{dN}{dP_{T}}");
82 // fhPt->GetXaxis()->SetTitleColor(1);
83 // fhPt->SetMarkerStyle(kFullCircle);
86 // The method Terminate() will be called by the framework once at the end of
87 // data processing. Overload this if needed. DO NOT ASSUME that the pointers
88 // to histograms defined in CreateOutputObjects() are valid, since this is
89 // not true in case of PROOF. Restore the pointer values like:
91 //void MyAnalysisTask::Terminate(Option_t *)
93 // fhPt = (TH1F*)GetOutputData(0);
98 //==============================================================================
100 #include <Riostream.h>
103 #include <TCollection.h>
107 #include "AliAnalysisTask.h"
108 #include "AliAnalysisDataSlot.h"
109 #include "AliAnalysisDataContainer.h"
110 #include "AliAnalysisManager.h"
112 ClassImp(AliAnalysisTask)
114 //______________________________________________________________________________
115 AliAnalysisTask::AliAnalysisTask()
117 fInitialized(kFALSE),
121 fPublishedData(NULL),
126 // Default constructor.
129 //______________________________________________________________________________
130 AliAnalysisTask::AliAnalysisTask(const char *name, const char *title)
133 fInitialized(kFALSE),
137 fPublishedData(NULL),
143 fInputs = new TObjArray(2);
144 fOutputs = new TObjArray(2);
147 //______________________________________________________________________________
148 AliAnalysisTask::AliAnalysisTask(const AliAnalysisTask &task)
151 fInitialized(task.fInitialized),
152 fNinputs(task.fNinputs),
153 fNoutputs(task.fNoutputs),
155 fPublishedData(NULL),
158 fBranchNames(task.fBranchNames)
161 fInputs = new TObjArray((fNinputs)?fNinputs:2);
162 fOutputs = new TObjArray((fNoutputs)?fNoutputs:2);
165 for (i=0; i<fNinputs; i++) fInputs->AddAt(task.GetInputSlot(i),i);
166 fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
167 for (i=0; i<fNoutputs; i++) {
168 fOutputReady[i] = IsOutputReady(i);
169 fOutputs->AddAt(task.GetOutputSlot(i),i);
173 //______________________________________________________________________________
174 AliAnalysisTask::~AliAnalysisTask()
177 if (fTasks) fTasks->Clear();
178 if (fInputs) {fInputs->Delete(); delete fInputs;}
179 if (fOutputs) {fOutputs->Delete(); delete fOutputs;}
182 //______________________________________________________________________________
183 AliAnalysisTask& AliAnalysisTask::operator=(const AliAnalysisTask& task)
186 if (&task == this) return *this;
187 TTask::operator=(task);
188 fReady = task.IsReady();
189 fInitialized = task.IsInitialized();
190 fNinputs = task.GetNinputs();
191 fNoutputs = task.GetNoutputs();
192 fInputs = new TObjArray((fNinputs)?fNinputs:2);
193 fOutputs = new TObjArray((fNoutputs)?fNoutputs:2);
196 for (i=0; i<fNinputs; i++) fInputs->AddAt(new AliAnalysisDataSlot(*task.GetInputSlot(i)),i);
197 fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
198 for (i=0; i<fNoutputs; i++) {
199 fOutputReady[i] = IsOutputReady(i);
200 fOutputs->AddAt(new AliAnalysisDataSlot(*task.GetOutputSlot(i)),i);
202 fBranchNames = task.fBranchNames;
206 //______________________________________________________________________________
207 Bool_t AliAnalysisTask::AreSlotsConnected()
209 // Check if all input/output slots are connected. If this is the case fReady=true
211 if (!fNinputs || !fNoutputs) return kFALSE;
213 AliAnalysisDataSlot *slot;
214 for (i=0; i<fNinputs; i++) {
215 slot = (AliAnalysisDataSlot*)fInputs->At(i);
217 Error("AreSlotsConnected", "Input slot %d of task %s not defined !",i,GetName());
220 if (!slot->IsConnected()) return kFALSE;
222 for (i=0; i<fNoutputs; i++) {
223 slot = (AliAnalysisDataSlot*)fOutputs->At(i);
225 Error("AreSlotsConnected", "Output slot %d of task %s not defined !",i,GetName());
228 if (!slot->IsConnected()) return kFALSE;
234 //______________________________________________________________________________
235 void AliAnalysisTask::CheckNotify(Bool_t init)
237 // Check if data is available from all inputs. Change the status of the task
238 // accordingly. This method is called automatically for all tasks connected
239 // to a container where the data was published.
240 if (init) fInitialized = kFALSE;
241 Bool_t single_shot = IsPostEventLoop();
242 AliAnalysisDataContainer *cinput;
243 for (Int_t islot=0; islot<fNinputs; islot++) {
244 cinput = GetInputSlot(islot)->GetContainer();
245 if (!cinput->GetData() || (single_shot && !cinput->IsPostEventLoop())) {
251 if (fInitialized) return;
252 TDirectory *cursav = gDirectory;
254 if (cursav) cursav->cd();
255 fInitialized = kTRUE;
258 //______________________________________________________________________________
259 Bool_t AliAnalysisTask::CheckPostData() const
261 // Checks if data was posted to all outputs defined by the task. If task does
262 // not have output slots this returns always kTRUE.
263 AliAnalysisDataContainer *coutput;
264 AliAnalysisManager *mgr = AliAnalysisManager::GetAnalysisManager();
265 for (Int_t islot=0; islot<fNoutputs; islot++) {
266 coutput = GetOutputSlot(islot)->GetContainer();
267 if (!mgr->GetOutputs()->FindObject(coutput)) continue;
268 if (!coutput->GetData()) return kFALSE;
274 //______________________________________________________________________________
275 Bool_t AliAnalysisTask::CheckOwnership() const
277 // Check ownership of containers posted on output slots (1 level only)
279 for (Int_t islot=0; islot<fNoutputs; islot++) {
280 outdata = GetOutputData(islot);
281 if (outdata && outdata->InheritsFrom(TCollection::Class())) {
282 TCollection *coll = (TCollection*)outdata;
283 if (!coll->IsOwner()) {
284 Error("CheckOwnership","####### IMPORTANT! ####### \n\n\n\
285 Task %s (%s) posts a container that is not owner at output #%d. This may apply for other embedded containers. \n\n\
286 ####### FIX YOUR CODE, THIS WILL PRODUCE A FATAL ERROR IN FUTURE! ##########", GetName(), ClassName(), islot);
294 //______________________________________________________________________________
295 Bool_t AliAnalysisTask::ConnectInput(Int_t islot, AliAnalysisDataContainer *cont)
297 // Connect an input slot to a data container.
298 AliAnalysisDataSlot *input = GetInputSlot(islot);
300 Error("ConnectInput","Input slot %i not defined for analysis task %s", islot, GetName());
303 // Check type matching
304 if (!input->GetType()->InheritsFrom(cont->GetType())) {
305 Error("ConnectInput","Data type %s for input %i of task %s not matching container %s of type %s",input->GetType()->GetName(), islot, GetName(), cont->GetName(), cont->GetType()->GetName());
308 // Connect the slot to the container as input
309 if (!input->ConnectContainer(cont)) return kFALSE;
310 // Add this to the list of container consumers
311 cont->AddConsumer(this, islot);
316 //______________________________________________________________________________
317 Bool_t AliAnalysisTask::ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont)
319 // Connect an output slot to a data container.
320 AliAnalysisDataSlot *output = GetOutputSlot(islot);
322 Error("ConnectOutput","Output slot %i not defined for analysis task %s", islot, GetName());
325 // Check type matching
326 if (!output->GetType()->InheritsFrom(cont->GetType())) {
327 Error("ConnectOutput","Data type %s for output %i of task %s not matching container %s of type %s",output->GetType()->GetName(), islot, GetName(), cont->GetName(), cont->GetType()->GetName());
330 // Connect the slot to the container as output
331 if (!output->ConnectContainer(cont)) return kFALSE;
332 // Set event loop type the same as for the task
333 cont->SetPostEventLoop(IsPostEventLoop());
334 // Declare this as the data producer
335 cont->SetProducer(this, islot);
340 //______________________________________________________________________________
341 void AliAnalysisTask::DefineInput(Int_t islot, TClass *type)
343 // Define an input slot and its type.
344 AliAnalysisDataSlot *input = new AliAnalysisDataSlot(type, this);
345 if (fNinputs<islot+1) fNinputs = islot+1;
346 fInputs->AddAtAndExpand(input, islot);
349 //______________________________________________________________________________
350 void AliAnalysisTask::DefineOutput(Int_t islot, TClass *type)
352 // Define an output slot and its type.
353 AliAnalysisDataSlot *output = new AliAnalysisDataSlot(type, this);
354 if (fNoutputs<islot+1) {
356 if (fOutputReady) delete [] fOutputReady;
357 fOutputReady = new Bool_t[fNoutputs];
358 memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
360 fOutputs->AddAtAndExpand(output, islot);
363 //______________________________________________________________________________
364 TClass *AliAnalysisTask::GetInputType(Int_t islot) const
366 // Retreive type of a given input slot.
367 AliAnalysisDataSlot *input = GetInputSlot(islot);
369 Error("GetInputType","Input slot %d not defined for analysis task %s", islot, GetName());
372 return (input->GetType());
375 //______________________________________________________________________________
376 TClass *AliAnalysisTask::GetOutputType(Int_t islot) const
378 // Retreive type of a given output slot.
379 AliAnalysisDataSlot *output = GetOutputSlot(islot);
381 Error("GetOutputType","Output slot %d not defined for analysis task %s", islot, GetName());
384 return (output->GetType());
387 //______________________________________________________________________________
388 TObject *AliAnalysisTask::GetInputData(Int_t islot) const
390 // Retreive input data for a slot if ready. Normally called by Exec() and
391 // the object has to be statically cast to the appropriate type.
392 AliAnalysisDataSlot *input = GetInputSlot(islot);
394 Error("GetInputData","Input slot %d not defined for analysis task %s", islot, GetName());
397 return (input->GetData());
400 //______________________________________________________________________________
401 TObject *AliAnalysisTask::GetOutputData(Int_t islot) const
403 // Retreive output data for a slot. Normally called in UserTask::Terminate to
404 // get a valid pointer to data even in case of Proof.
405 AliAnalysisDataSlot *output = GetOutputSlot(islot);
407 Error("GetOutputData","Input slot %d not defined for analysis task %s", islot, GetName());
410 return (output->GetData());
413 //______________________________________________________________________________
414 char *AliAnalysisTask::GetBranchAddress(Int_t islot, const char *branch) const
416 // Check if a branch with a given name from the specified input is connected
417 // to some address. Call this in Init() before trying to call SetBranchAddress()
418 // since the adress may be set by other task.
419 return (char *)GetInputSlot(islot)->GetBranchAddress(branch);
422 //______________________________________________________________________________
423 Bool_t AliAnalysisTask::SetBranchAddress(Int_t islot, const char *branch, void *address) const
425 // Connect an object address to a branch of the specified input.
426 return GetInputSlot(islot)->SetBranchAddress(branch, address);
429 //______________________________________________________________________________
430 void AliAnalysisTask::EnableBranch(Int_t islot, const char *bname) const
432 // Call this in ConnectInputData() to enable only the branches needed by this
433 // task. "*" will enable everything.
434 AliAnalysisDataSlot *input = GetInputSlot(islot);
435 if (!input || !input->GetType()->InheritsFrom(TTree::Class())) {
436 Error("EnableBranch", "Wrong slot type #%d for task %s: not TTree-derived type", islot, GetName());
439 TTree *tree = (TTree*)input->GetData();
440 if (!strcmp(bname, "*")) {
441 tree->SetBranchStatus("*",1);
444 AliAnalysisDataSlot::EnableBranch(bname, tree);
447 //______________________________________________________________________________
448 void AliAnalysisTask::FinishTaskOutput()
450 // Optional method that is called in SlaveTerminate phase.
451 // Used for calling aditional methods just after the last event was processed ON
452 // THE WORKING NODE. The call is made also in local case.
453 // Do NOT delete output objects here since they will have to be sent for
454 // merging in PROOF mode - use class destructor for cleanup.
457 //______________________________________________________________________________
458 void AliAnalysisTask::ConnectInputData(Option_t *)
460 // Overload and connect your branches here.
463 //______________________________________________________________________________
464 void AliAnalysisTask::LocalInit()
466 // The method LocalInit() may be implemented to call locally (on the client)
467 // all initialization methods of the class. It is not mandatory and was created
468 // in order to minimize the complexity and readability of the analysis macro.
469 // DO NOT create in this method the histigrams or task output objects that will
470 // go in the task output containers. Use CreateOutputObjects for that.
473 //______________________________________________________________________________
474 void AliAnalysisTask::CreateOutputObjects()
476 // Called once per task either in PROOF or local mode. Overload to put some
477 // task initialization and/or create your output objects here.
480 //______________________________________________________________________________
481 TFile *AliAnalysisTask::OpenFile(Int_t iout, Option_t *option) const
483 // This method has to be called INSIDE the user redefined CreateOutputObjects
484 // method, before creating each object corresponding to the output containers
485 // that are to be written to a file. This need to be done in general for the big output
486 // objects that may not fit memory during processing.
487 // - 'option' is the file opening option.
488 //=========================================================================
489 // NOTE !: The method call will be ignored in PROOF mode, in which case the
490 // results have to be streamed back to the client and written just before Terminate()
491 //=========================================================================
494 // void MyAnaTask::CreateOutputObjects() {
495 // OpenFile(0); // Will open the file for the object to be written at output #0
496 // fAOD = new TTree("AOD for D0toKPi");
498 // now some histos that should go in the file of the second output container
499 // fHist1 = new TH1F("my quality check hist1",...);
500 // fHist2 = new TH2F("my quality check hist2",...);
503 if (iout<0 || iout>=fNoutputs) {
504 Error("OpenFile", "No output slot for task %s with index %d", GetName(), iout);
507 // Method delegated to the analysis manager (A.G. 02/11/09)
508 AliAnalysisDataContainer *cont = GetOutputSlot(iout)->GetContainer();
509 return AliAnalysisManager::OpenFile(cont, option);
512 //______________________________________________________________________________
513 Bool_t AliAnalysisTask::Notify()
515 // Overload this IF you need to treat input file change.
519 //______________________________________________________________________________
520 Bool_t AliAnalysisTask::NotifyBinChange()
522 // Overload this IF you need to treat bin change in event mixing.
526 //______________________________________________________________________________
527 void AliAnalysisTask::Terminate(Option_t *)
529 // Method called by the framework at the end of data processing.
532 //______________________________________________________________________________
533 Bool_t AliAnalysisTask::PostData(Int_t iout, TObject *data, Option_t *option)
535 // Post output data for a given ouput slot in the corresponding data container.
536 // Published data becomes owned by the data container.
537 // If option is specified, the container connected to the output slot must have
538 // an associated file name defined. The option represents the method to open the file.
540 AliAnalysisDataSlot *output = GetOutputSlot(iout);
542 Error("PostData","Output slot %i not defined for analysis task %s", iout, GetName());
545 if (!output->IsConnected()) {
546 Error("PostData","Output slot %i of analysis task %s not connected to any data container", iout, GetName());
550 fOutputReady = new Bool_t[fNoutputs];
551 memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
553 fOutputReady[iout] = kTRUE;
554 fPublishedData = data;
555 return (output->GetContainer()->SetData(data, option));
558 //______________________________________________________________________________
559 void AliAnalysisTask::SetUsed(Bool_t flag)
561 // Set 'used' flag recursively to task and all daughter tasks.
562 if (TestBit(kTaskUsed)==flag) return;
563 TObject::SetBit(kTaskUsed,flag);
564 Int_t nd = fTasks->GetSize();
565 AliAnalysisTask *task;
566 for (Int_t i=0; i<nd; i++) {
567 task = (AliAnalysisTask*)fTasks->At(i);
572 //______________________________________________________________________________
573 Bool_t AliAnalysisTask::CheckCircularDeps()
575 // Check for illegal circular dependencies, e.g. a daughter task should not have
576 // a hierarchical parent as subtask.
577 if (IsChecked()) return kTRUE;
579 TList *tasks = GetListOfTasks();
580 Int_t ntasks = tasks->GetSize();
581 AliAnalysisTask *task;
582 for (Int_t i=0; i<ntasks; i++) {
583 task = (AliAnalysisTask*)tasks->At(i);
584 if (task->CheckCircularDeps()) return kTRUE;
590 //______________________________________________________________________________
591 void AliAnalysisTask::PrintTask(Option_t *option, Int_t indent) const
596 Bool_t dep = (opt.Contains("dep"))?kTRUE:kFALSE;
599 AliAnalysisDataContainer *cont;
600 for (Int_t i=0; i<indent; i++) ind += " ";
601 if (!dep || (dep && IsChecked())) {
602 printf("______________________________________________________________________________\n");
603 printf("%s\n", Form("%stask: %s ACTIVE=%i POST_LOOP=%i", ind.Data(), GetName(),IsActive(),IsPostEventLoop()));
604 if (dep) const_cast<AliAnalysisTask*>(this)->SetChecked(kFALSE);
606 for (islot=0; islot<fNinputs; islot++) {
607 printf("%s", Form("%s INPUT #%i: %s <- ",ind.Data(),islot, GetInputType(islot)->GetName()));
608 cont = GetInputSlot(islot)->GetContainer();
609 if (cont) printf(" [%s]\n", cont->GetName());
610 else printf(" [NO CONTAINER]\n");
612 for (islot=0; islot<fNoutputs; islot++) {
613 printf("%s", Form("%s OUTPUT #%i: %s -> ",ind.Data(),islot, GetOutputType(islot)->GetName()));
614 cont = GetOutputSlot(islot)->GetContainer();
615 if (cont) printf(" [%s]\n", cont->GetName());
616 else printf(" [NO CONTAINER]\n");
620 PrintContainers(option, indent+3);
621 if (!fBranchNames.IsNull()) printf("Requested branches: %s\n", fBranchNames.Data());
624 //______________________________________________________________________________
625 void AliAnalysisTask::PrintContainers(Option_t *option, Int_t indent) const
627 // Print containers info.
628 AliAnalysisDataContainer *cont;
630 for (Int_t i=0; i<indent; i++) ind += " ";
632 for (islot=0; islot<fNoutputs; islot++) {
633 cont = GetOutputSlot(islot)->GetContainer();
634 if (cont) cont->PrintContainer(option, indent);
638 //______________________________________________________________________________
639 void AliAnalysisTask::SetPostEventLoop(Bool_t flag)
641 // Set the task execution mode - run after event loop or not. All output
642 // containers of this task will get the same type.
643 TObject::SetBit(kTaskPostEventLoop,flag);
644 AliAnalysisDataContainer *cont;
646 for (islot=0; islot<fNoutputs; islot++) {
647 cont = GetOutputSlot(islot)->GetContainer();
648 if (cont) cont->SetPostEventLoop(flag);
652 //______________________________________________________________________________
653 void AliAnalysisTask::GetBranches(const char *type, TString &result) const
655 // Get the list of branches for a given type (ESD, AOD). The list of branches
656 // requested by a task has to ve declared in the form:
657 // SetBranches("ESD:branch1,branch2,...,branchN AOD:branch1,branch2,...,branchM")
659 if (fBranchNames.IsNull()) return;
660 Int_t index1 = fBranchNames.Index(type);
661 if (index1<0) return;
662 index1 += 1+strlen(type);
663 Int_t index2 = fBranchNames.Index(" ", index1);
664 if (index2<0) index2 = fBranchNames.Length();
665 result = fBranchNames(index1, index2-index1);