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 Bool_t dataPosted = kTRUE;
264 AliAnalysisDataContainer *coutput;
265 AliAnalysisManager *mgr = AliAnalysisManager::GetAnalysisManager();
266 for (Int_t islot=0; islot<fNoutputs; islot++) {
267 coutput = GetOutputSlot(islot)->GetContainer();
268 if (!coutput) continue;
269 if (coutput->IsExchange() || !mgr->GetOutputs()->FindObject(coutput) || coutput==mgr->GetCommonOutputContainer()) continue;
270 if (!coutput->GetData()) {
271 Error("CheckPostData", "Data not posted for slot #%d of task %s (%s)",
272 islot, GetName(), ClassName());
280 //______________________________________________________________________________
281 Bool_t AliAnalysisTask::CheckOwnership() const
283 // Check ownership of containers posted on output slots (1 level only)
285 for (Int_t islot=0; islot<fNoutputs; islot++) {
286 outdata = GetOutputData(islot);
287 if (outdata && outdata->InheritsFrom(TCollection::Class())) {
288 TCollection *coll = (TCollection*)outdata;
289 if (!coll->IsOwner()) {
290 Error("CheckOwnership","####### IMPORTANT! ####### \n\n\n\
291 Task %s (%s) posts a container that is not owner at output #%d. This may apply for other embedded containers. \n\n\
292 ####### FIX YOUR CODE, THIS WILL PRODUCE A FATAL ERROR IN FUTURE! ##########", GetName(), ClassName(), islot);
300 //______________________________________________________________________________
301 Bool_t AliAnalysisTask::ConnectInput(Int_t islot, AliAnalysisDataContainer *cont)
303 // Connect an input slot to a data container.
304 AliAnalysisDataSlot *input = GetInputSlot(islot);
306 Error("ConnectInput","Input slot %i not defined for analysis task %s", islot, GetName());
309 // Check type matching
310 if (!input->GetType()->InheritsFrom(cont->GetType())) {
311 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());
314 // Connect the slot to the container as input
315 if (!input->ConnectContainer(cont)) return kFALSE;
316 // Add this to the list of container consumers
317 cont->AddConsumer(this, islot);
322 //______________________________________________________________________________
323 Bool_t AliAnalysisTask::ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont)
325 // Connect an output slot to a data container.
326 AliAnalysisDataSlot *output = GetOutputSlot(islot);
328 Error("ConnectOutput","Output slot %i not defined for analysis task %s", islot, GetName());
331 // Check type matching
332 if (!output->GetType()->InheritsFrom(cont->GetType())) {
333 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());
336 // Connect the slot to the container as output
337 if (!output->ConnectContainer(cont)) return kFALSE;
338 // Set event loop type the same as for the task
339 cont->SetPostEventLoop(IsPostEventLoop());
340 // Declare this as the data producer
341 cont->SetProducer(this, islot);
346 //______________________________________________________________________________
347 void AliAnalysisTask::DefineInput(Int_t islot, TClass *type)
349 // Define an input slot and its type.
350 AliAnalysisDataSlot *input = new AliAnalysisDataSlot(type, this);
351 if (fNinputs<islot+1) fNinputs = islot+1;
352 fInputs->AddAtAndExpand(input, islot);
355 //______________________________________________________________________________
356 void AliAnalysisTask::DefineOutput(Int_t islot, TClass *type)
358 // Define an output slot and its type.
359 AliAnalysisDataSlot *output = new AliAnalysisDataSlot(type, this);
360 if (fNoutputs<islot+1) {
362 if (fOutputReady) delete [] fOutputReady;
363 fOutputReady = new Bool_t[fNoutputs];
364 memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
366 fOutputs->AddAtAndExpand(output, islot);
369 //______________________________________________________________________________
370 TClass *AliAnalysisTask::GetInputType(Int_t islot) const
372 // Retreive type of a given input slot.
373 AliAnalysisDataSlot *input = GetInputSlot(islot);
375 Error("GetInputType","Input slot %d not defined for analysis task %s", islot, GetName());
378 return (input->GetType());
381 //______________________________________________________________________________
382 TClass *AliAnalysisTask::GetOutputType(Int_t islot) const
384 // Retreive type of a given output slot.
385 AliAnalysisDataSlot *output = GetOutputSlot(islot);
387 Error("GetOutputType","Output slot %d not defined for analysis task %s", islot, GetName());
390 return (output->GetType());
393 //______________________________________________________________________________
394 TObject *AliAnalysisTask::GetInputData(Int_t islot) const
396 // Retreive input data for a slot if ready. Normally called by Exec() and
397 // the object has to be statically cast to the appropriate type.
398 AliAnalysisDataSlot *input = GetInputSlot(islot);
400 Error("GetInputData","Input slot %d not defined for analysis task %s", islot, GetName());
403 return (input->GetData());
406 //______________________________________________________________________________
407 TObject *AliAnalysisTask::GetOutputData(Int_t islot) const
409 // Retreive output data for a slot. Normally called in UserTask::Terminate to
410 // get a valid pointer to data even in case of Proof.
411 AliAnalysisDataSlot *output = GetOutputSlot(islot);
413 Error("GetOutputData","Input slot %d not defined for analysis task %s", islot, GetName());
416 return (output->GetData());
419 //______________________________________________________________________________
420 char *AliAnalysisTask::GetBranchAddress(Int_t islot, const char *branch) const
422 // Check if a branch with a given name from the specified input is connected
423 // to some address. Call this in Init() before trying to call SetBranchAddress()
424 // since the adress may be set by other task.
425 return (char *)GetInputSlot(islot)->GetBranchAddress(branch);
428 //______________________________________________________________________________
429 Bool_t AliAnalysisTask::SetBranchAddress(Int_t islot, const char *branch, void *address) const
431 // Connect an object address to a branch of the specified input.
432 return GetInputSlot(islot)->SetBranchAddress(branch, address);
435 //______________________________________________________________________________
436 void AliAnalysisTask::EnableBranch(Int_t islot, const char *bname) const
438 // Call this in ConnectInputData() to enable only the branches needed by this
439 // task. "*" will enable everything.
440 AliAnalysisDataSlot *input = GetInputSlot(islot);
441 if (!input || !input->GetType()->InheritsFrom(TTree::Class())) {
442 Error("EnableBranch", "Wrong slot type #%d for task %s: not TTree-derived type", islot, GetName());
445 TTree *tree = (TTree*)input->GetData();
446 if (!strcmp(bname, "*")) {
447 tree->SetBranchStatus("*",1);
450 AliAnalysisDataSlot::EnableBranch(bname, tree);
453 //______________________________________________________________________________
454 void AliAnalysisTask::FinishTaskOutput()
456 // Optional method that is called in SlaveTerminate phase.
457 // Used for calling aditional methods just after the last event was processed ON
458 // THE WORKING NODE. The call is made also in local case.
459 // Do NOT delete output objects here since they will have to be sent for
460 // merging in PROOF mode - use class destructor for cleanup.
463 //______________________________________________________________________________
464 void AliAnalysisTask::ConnectInputData(Option_t *)
466 // Overload and connect your branches here.
469 //______________________________________________________________________________
470 void AliAnalysisTask::LocalInit()
472 // The method LocalInit() may be implemented to call locally (on the client)
473 // all initialization methods of the class. It is not mandatory and was created
474 // in order to minimize the complexity and readability of the analysis macro.
475 // DO NOT create in this method the histigrams or task output objects that will
476 // go in the task output containers. Use CreateOutputObjects for that.
479 //______________________________________________________________________________
480 void AliAnalysisTask::CreateOutputObjects()
482 // Called once per task either in PROOF or local mode. Overload to put some
483 // task initialization and/or create your output objects here.
486 //______________________________________________________________________________
487 TFile *AliAnalysisTask::OpenFile(Int_t iout, Option_t *option) const
489 // This method has to be called INSIDE the user redefined CreateOutputObjects
490 // method, before creating each object corresponding to the output containers
491 // that are to be written to a file. This need to be done in general for the big output
492 // objects that may not fit memory during processing.
493 // - 'option' is the file opening option.
494 //=========================================================================
495 // NOTE !: The method call will be ignored in PROOF mode, in which case the
496 // results have to be streamed back to the client and written just before Terminate()
497 //=========================================================================
500 // void MyAnaTask::CreateOutputObjects() {
501 // OpenFile(0); // Will open the file for the object to be written at output #0
502 // fAOD = new TTree("AOD for D0toKPi");
504 // now some histos that should go in the file of the second output container
505 // fHist1 = new TH1F("my quality check hist1",...);
506 // fHist2 = new TH2F("my quality check hist2",...);
509 if (iout<0 || iout>=fNoutputs) {
510 Error("OpenFile", "No output slot for task %s with index %d", GetName(), iout);
513 // Method delegated to the analysis manager (A.G. 02/11/09)
514 AliAnalysisDataContainer *cont = GetOutputSlot(iout)->GetContainer();
515 return AliAnalysisManager::OpenFile(cont, option);
518 //______________________________________________________________________________
519 Bool_t AliAnalysisTask::Notify()
521 // Overload this IF you need to treat input file change.
525 //______________________________________________________________________________
526 Bool_t AliAnalysisTask::NotifyBinChange()
528 // Overload this IF you need to treat bin change in event mixing.
532 //______________________________________________________________________________
533 void AliAnalysisTask::Terminate(Option_t *)
535 // Method called by the framework at the end of data processing.
538 //______________________________________________________________________________
539 Bool_t AliAnalysisTask::PostData(Int_t iout, TObject *data, Option_t *option)
541 // Post output data for a given ouput slot in the corresponding data container.
542 // Published data becomes owned by the data container.
543 // If option is specified, the container connected to the output slot must have
544 // an associated file name defined. The option represents the method to open the file.
546 AliAnalysisDataSlot *output = GetOutputSlot(iout);
548 Error("PostData","Output slot %i not defined for analysis task %s", iout, GetName());
551 if (!output->IsConnected()) {
552 Error("PostData","Output slot %i of analysis task %s not connected to any data container", iout, GetName());
556 fOutputReady = new Bool_t[fNoutputs];
557 memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
559 fOutputReady[iout] = kTRUE;
560 fPublishedData = data;
561 return (output->GetContainer()->SetData(data, option));
564 //______________________________________________________________________________
565 void AliAnalysisTask::SetUsed(Bool_t flag)
567 // Set 'used' flag recursively to task and all daughter tasks.
568 if (TestBit(kTaskUsed)==flag) return;
569 TObject::SetBit(kTaskUsed,flag);
570 Int_t nd = fTasks->GetSize();
571 AliAnalysisTask *task;
572 for (Int_t i=0; i<nd; i++) {
573 task = (AliAnalysisTask*)fTasks->At(i);
578 //______________________________________________________________________________
579 void AliAnalysisTask::Reset()
581 // Clear activity flag. Reset data for exchange containers.
583 fHasExecuted = kFALSE;
584 // Call PostData(islot, 0) for all slots connected to exchange containers
586 AliAnalysisDataContainer *cont;
587 for (islot=0; islot<fNinputs; islot++) {
588 cont = GetInputSlot(islot)->GetContainer();
589 if (cont && cont->IsExchange()) cont->Reset();
593 //______________________________________________________________________________
594 Bool_t AliAnalysisTask::CheckCircularDeps()
596 // Check for illegal circular dependencies, e.g. a daughter task should not have
597 // a hierarchical parent as subtask.
598 if (IsChecked()) return kTRUE;
600 TList *tasks = GetListOfTasks();
601 Int_t ntasks = tasks->GetSize();
602 AliAnalysisTask *task;
603 for (Int_t i=0; i<ntasks; i++) {
604 task = (AliAnalysisTask*)tasks->At(i);
605 if (task->CheckCircularDeps()) return kTRUE;
611 //______________________________________________________________________________
612 Bool_t AliAnalysisTask::ProducersTouched() const
614 // Check if all producer containers are in the "touched" state.
616 AliAnalysisDataContainer *cont;
617 for (islot=0; islot<fNinputs; islot++) {
618 cont = GetInputSlot(islot)->GetContainer();
619 // Simulate the data flow so the tasks are printed only when all inputs
621 if (cont && !cont->IsTouched()) return kFALSE;
626 //______________________________________________________________________________
627 void AliAnalysisTask::PrintTask(Option_t *option, Int_t indent) const
631 AliAnalysisDataContainer *cont;
633 if (!ProducersTouched()) return;
636 Bool_t dep = (opt.Contains("dep"))?kTRUE:kFALSE;
638 for (Int_t i=0; i<indent; i++) ind += " ";
639 if (!dep || (dep && IsChecked())) {
640 printf("______________________________________________________________________________\n");
641 printf("%s\n", Form("%stask: %s ACTIVE=%i POST_LOOP=%i", ind.Data(), GetName(),IsActive(),IsPostEventLoop()));
642 if (dep) const_cast<AliAnalysisTask*>(this)->SetChecked(kFALSE);
644 for (islot=0; islot<fNinputs; islot++) {
645 printf("%s", Form("%s INPUT #%i: %s <- ",ind.Data(),islot, GetInputType(islot)->GetName()));
646 cont = GetInputSlot(islot)->GetContainer();
647 if (cont) printf(" [%s]\n", cont->GetName());
648 else printf(" [NO CONTAINER]\n");
650 for (islot=0; islot<fNoutputs; islot++) {
651 printf("%s", Form("%s OUTPUT #%i: %s -> ",ind.Data(),islot, GetOutputType(islot)->GetName()));
652 cont = GetOutputSlot(islot)->GetContainer();
653 if (cont) printf(" [%s]\n", cont->GetName());
654 else printf(" [NO CONTAINER]\n");
658 ((AliAnalysisTask*)this)->SetActive(kTRUE);
659 PrintContainers(option, indent+3);
660 if (!fBranchNames.IsNull()) printf("%sRequested branches: %s\n", ind.Data(), fBranchNames.Data());
663 //______________________________________________________________________________
664 void AliAnalysisTask::PrintContainers(Option_t *option, Int_t indent) const
666 // Print containers info.
667 AliAnalysisDataContainer *cont;
669 for (Int_t i=0; i<indent; i++) ind += " ";
671 for (islot=0; islot<fNoutputs; islot++) {
672 cont = GetOutputSlot(islot)->GetContainer();
673 if (cont) cont->PrintContainer(option, indent);
677 //______________________________________________________________________________
678 void AliAnalysisTask::SetPostEventLoop(Bool_t flag)
680 // Set the task execution mode - run after event loop or not. All output
681 // containers of this task will get the same type.
682 TObject::SetBit(kTaskPostEventLoop,flag);
683 AliAnalysisDataContainer *cont;
685 for (islot=0; islot<fNoutputs; islot++) {
686 cont = GetOutputSlot(islot)->GetContainer();
687 if (cont) cont->SetPostEventLoop(flag);
691 //______________________________________________________________________________
692 void AliAnalysisTask::GetBranches(const char *type, TString &result) const
694 // Get the list of branches for a given type (ESD, AOD). The list of branches
695 // requested by a task has to ve declared in the form:
696 // SetBranches("ESD:branch1,branch2,...,branchN AOD:branch1,branch2,...,branchM")
698 if (fBranchNames.IsNull()) return;
699 Int_t index1 = fBranchNames.Index(type);
700 if (index1<0) return;
701 index1 += 1+strlen(type);
702 Int_t index2 = fBranchNames.Index(" ", index1);
703 if (index2<0) index2 = fBranchNames.Length();
704 result = fBranchNames(index1, index2-index1);