Add auxiliary info for tof calibration to the ESD track, via TOFInfo
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisTask.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
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  **************************************************************************/
15
16 /* $Id$ */
17 // Author: Andrei Gheata, 31/05/2006
18
19 //==============================================================================
20 //   AliAnalysysTask - Class representing a basic analysis task. Any
21 // user-defined task should derive from it and implement the Exec() virtual
22 // method.
23 //==============================================================================
24 //
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:
27 //
28 //   UserTask::UserTask(name, title)
29 //   {
30 //      DefineInput(0, TTree::Class());
31 //      DefineInput(1, TH1::Class());
32 //      ...
33 //      DefineOutput(0, TTree::Class());
34 //      DefineOutput(1, MyObject::Class());
35 //      ...
36 //   }
37 //
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:
41 //
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
47 // match.
48 //
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.
52 // Example:
53 // MyAnalysisTask::ConnectInputData(Option_t *)
54 // {
55 //  // One should first check if the branch address was taken by some other task
56 //    char ** address = (char **)GetBranchAddress(0, "ESD");
57 //    if (address) {
58 //      fESD = (AliESD*)(*address);
59 //    } else {
60 //      fESD = new AliESD();
61 //      SetBranchAddress(0, "ESD", &fESD);
62 //    }
63 // }
64 // 
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.
70 //
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
73 // histograms)
74 //
75 // void MyAnalysisTask::CreateOutputObjects()
76 //{
77   // create histograms 
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);
84 // }
85 //
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:
90 //
91 //void MyAnalysisTask::Terminate(Option_t *) 
92 //{
93 //  fhPt = (TH1F*)GetOutputData(0);
94 // ...
95 //}
96
97 //
98 //==============================================================================
99
100 #include <Riostream.h>
101 #include <TFile.h>
102 #include <TClass.h>
103
104 #include "AliAnalysisTask.h"
105 #include "AliAnalysisDataSlot.h"
106 #include "AliAnalysisDataContainer.h"
107 #include "AliAnalysisManager.h"
108
109 ClassImp(AliAnalysisTask)
110
111 //______________________________________________________________________________
112 AliAnalysisTask::AliAnalysisTask()
113                 :fReady(kFALSE),
114                  fInitialized(kFALSE),
115                  fNinputs(0),
116                  fNoutputs(0),
117                  fOutputReady(NULL),
118                  fPublishedData(NULL),
119                  fInputs(NULL),
120                  fOutputs(NULL)
121 {
122 // Default constructor.
123    TObject::SetBit(kTaskEvtByEvt, kTRUE);
124 }
125
126 //______________________________________________________________________________
127 AliAnalysisTask::AliAnalysisTask(const char *name, const char *title)
128                 :TTask(name,title),
129                  fReady(kFALSE),
130                  fInitialized(kFALSE),
131                  fNinputs(0),
132                  fNoutputs(0),
133                  fOutputReady(NULL),
134                  fPublishedData(NULL),
135                  fInputs(NULL),
136                  fOutputs(NULL)                 
137 {
138 // Constructor.
139    TObject::SetBit(kTaskEvtByEvt, kTRUE);
140    fInputs      = new TObjArray(2);
141    fOutputs     = new TObjArray(2);
142 }
143
144 //______________________________________________________________________________
145 AliAnalysisTask::AliAnalysisTask(const AliAnalysisTask &task)
146                 :TTask(task),
147                  fReady(task.fReady),
148                  fInitialized(task.fInitialized),
149                  fNinputs(task.fNinputs),
150                  fNoutputs(task.fNoutputs),                 
151                  fOutputReady(NULL),
152                  fPublishedData(NULL),
153                  fInputs(NULL),
154                  fOutputs(NULL)                 
155 {
156 // Copy ctor.
157    fInputs      = new TObjArray((fNinputs)?fNinputs:2);
158    fOutputs     = new TObjArray((fNoutputs)?fNoutputs:2);
159    fPublishedData = 0;
160    Int_t i;
161    for (i=0; i<fNinputs; i++) fInputs->AddAt(task.GetInputSlot(i),i);
162    fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
163    for (i=0; i<fNoutputs; i++) {
164       fOutputReady[i] = IsOutputReady(i);
165       fOutputs->AddAt(task.GetOutputSlot(i),i);
166    }   
167 }
168
169 //______________________________________________________________________________
170 AliAnalysisTask::~AliAnalysisTask()
171 {
172 // Dtor.
173    if (fTasks) fTasks->Clear();
174    if (fInputs)  {fInputs->Delete(); delete fInputs;}
175    if (fOutputs) {fOutputs->Delete(); delete fOutputs;}
176 }   
177   
178 //______________________________________________________________________________
179 AliAnalysisTask& AliAnalysisTask::operator=(const AliAnalysisTask& task)
180 {
181 // Assignment
182    if (&task == this) return *this;
183    TTask::operator=(task);
184    fReady       = task.IsReady();
185    fInitialized = task.IsInitialized();
186    fNinputs     = task.GetNinputs();
187    fNoutputs    = task.GetNoutputs();
188    fInputs      = new TObjArray((fNinputs)?fNinputs:2);
189    fOutputs     = new TObjArray((fNoutputs)?fNoutputs:2);
190    fPublishedData = 0;
191    Int_t i;
192    for (i=0; i<fNinputs; i++) fInputs->AddAt(new AliAnalysisDataSlot(*task.GetInputSlot(i)),i);
193    fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
194    for (i=0; i<fNoutputs; i++) {
195       fOutputReady[i] = IsOutputReady(i);
196       fOutputs->AddAt(new AliAnalysisDataSlot(*task.GetOutputSlot(i)),i);
197    }         
198    return *this;
199 }
200
201 //______________________________________________________________________________
202 Bool_t AliAnalysisTask::AreSlotsConnected()
203 {
204 // Check if all input/output slots are connected. If this is the case fReady=true
205    fReady = kFALSE;
206    if (!fNinputs || !fNoutputs) return kFALSE;
207    Int_t i;
208    AliAnalysisDataSlot *slot;
209    for (i=0; i<fNinputs; i++) {
210       slot = (AliAnalysisDataSlot*)fInputs->At(i);
211       if (!slot) {
212               Error("AreSlotsConnected", "Input slot %d of task %s not defined !",i,GetName());
213          return kFALSE;
214       }   
215       if (!slot->IsConnected()) return kFALSE;
216    }   
217    for (i=0; i<fNoutputs; i++) {
218       slot = (AliAnalysisDataSlot*)fOutputs->At(i);
219       if (!slot) {
220          Error("AreSlotsConnected", "Output slot %d of task %s not defined !",i,GetName());
221          return kFALSE;
222       }   
223       if (!slot->IsConnected()) return kFALSE;
224    } 
225    fReady = kTRUE;  
226    return kTRUE;
227 }
228
229 //______________________________________________________________________________
230 void AliAnalysisTask::CheckNotify(Bool_t init)
231 {
232 // Check if data is available from all inputs. Change the status of the task
233 // accordingly. This method is called automatically for all tasks connected
234 // to a container where the data was published.
235    if (init) fInitialized = kFALSE;
236    Bool_t execperevent = IsExecPerEvent();
237    AliAnalysisDataContainer *cinput;
238    for (Int_t islot=0; islot<fNinputs; islot++) {
239       cinput = GetInputSlot(islot)->GetContainer();
240       if (!cinput) return;
241       if (!cinput->GetData() || execperevent!=cinput->IsEventByEvent()) {
242          SetActive(kFALSE);
243          return;
244       }   
245    }   
246    SetActive(kTRUE);
247    if (fInitialized) return;
248    TDirectory *cursav = gDirectory;
249    ConnectInputData();
250    if (cursav) cursav->cd();
251    fInitialized = kTRUE;
252 }
253
254 //______________________________________________________________________________
255 Bool_t AliAnalysisTask::ConnectInput(Int_t islot, AliAnalysisDataContainer *cont)
256 {
257 // Connect an input slot to a data container.
258    AliAnalysisDataSlot *input = GetInputSlot(islot);
259    if (!input) {
260       Error("ConnectInput","Input slot %i not defined for analysis task %s", islot, GetName());
261       return kFALSE;
262    }
263    // Check type matching          
264    if (!input->GetType()->InheritsFrom(cont->GetType())) {
265       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());
266       return kFALSE;
267    }  
268    // Connect the slot to the container as input          
269    if (!input->ConnectContainer(cont)) return kFALSE;
270    // Add this to the list of container consumers
271    cont->AddConsumer(this, islot);
272    AreSlotsConnected();
273    return kTRUE;
274 }   
275
276 //______________________________________________________________________________
277 Bool_t AliAnalysisTask::ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont)
278 {
279 // Connect an output slot to a data container.
280    AliAnalysisDataSlot *output = GetOutputSlot(islot);
281    if (!output) {
282       Error("ConnectOutput","Output slot %i not defined for analysis task %s", islot, GetName());
283       return kFALSE;
284    }
285    // Check type matching          
286    if (!output->GetType()->InheritsFrom(cont->GetType())) {
287       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());
288       return kFALSE;
289    }            
290    // Connect the slot to the container as output         
291    if (!output->ConnectContainer(cont)) return kFALSE;
292    // Declare this as the data producer
293    cont->SetProducer(this, islot);
294    AreSlotsConnected();
295    return kTRUE;
296 }   
297
298 //______________________________________________________________________________
299 void AliAnalysisTask::DefineInput(Int_t islot, TClass *type)
300 {
301 // Define an input slot and its type.
302    AliAnalysisDataSlot *input = new AliAnalysisDataSlot(type, this);
303    if (fNinputs<islot+1) fNinputs = islot+1;
304    fInputs->AddAtAndExpand(input, islot);
305 }
306
307 //______________________________________________________________________________
308 void AliAnalysisTask::DefineOutput(Int_t islot, TClass *type)
309 {
310 // Define an output slot and its type.
311    AliAnalysisDataSlot *output = new AliAnalysisDataSlot(type, this);
312    if (fNoutputs<islot+1) {
313       fNoutputs = islot+1;
314       if (fOutputReady) delete [] fOutputReady;
315       fOutputReady = new Bool_t[fNoutputs];
316       memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
317    } 
318    fOutputs->AddAtAndExpand(output, islot);
319 }
320
321 //______________________________________________________________________________
322 TClass *AliAnalysisTask::GetInputType(Int_t islot) const
323 {
324 // Retreive type of a given input slot.
325    AliAnalysisDataSlot *input = GetInputSlot(islot);
326    if (!input) {
327       Error("GetInputType","Input slot %d not defined for analysis task %s", islot, GetName());
328       return NULL;
329    }
330    return (input->GetType());
331 }
332
333 //______________________________________________________________________________
334 TClass *AliAnalysisTask::GetOutputType(Int_t islot) const
335 {
336 // Retreive type of a given output slot.
337    AliAnalysisDataSlot *output = GetOutputSlot(islot);
338    if (!output) {
339       Error("GetOutputType","Output slot %d not defined for analysis task %s", islot, GetName());
340       return NULL;
341    }
342    return (output->GetType());
343 }
344
345 //______________________________________________________________________________
346 TObject *AliAnalysisTask::GetInputData(Int_t islot) const
347 {
348 // Retreive input data for a slot if ready. Normally called by Exec() and
349 // the object has to be statically cast to the appropriate type.
350    AliAnalysisDataSlot *input = GetInputSlot(islot);
351    if (!input) {
352       Error("GetInputData","Input slot %d not defined for analysis task %s", islot, GetName());
353       return NULL;
354    }
355    return (input->GetData()); 
356 }
357
358 //______________________________________________________________________________
359 TObject *AliAnalysisTask::GetOutputData(Int_t islot) const
360 {
361 // Retreive output data for a slot. Normally called in UserTask::Terminate to
362 // get a valid pointer to data even in case of Proof.
363    AliAnalysisDataSlot *output = GetOutputSlot(islot);
364    if (!output) {
365       Error("GetOutputData","Input slot %d not defined for analysis task %s", islot, GetName());
366       return NULL;
367    }
368    return (output->GetData()); 
369 }
370
371 //______________________________________________________________________________
372 char *AliAnalysisTask::GetBranchAddress(Int_t islot, const char *branch) const
373 {
374 // Check if a branch with a given name from the specified input is connected
375 // to some address. Call this in Init() before trying to call SetBranchAddress()
376 // since the adress may be set by other task.
377    return (char *)GetInputSlot(islot)->GetBranchAddress(branch);
378 }
379
380 //______________________________________________________________________________
381 Bool_t AliAnalysisTask::SetBranchAddress(Int_t islot, const char *branch, void *address) const
382 {
383 // Connect an object address to a branch of the specified input.
384    return GetInputSlot(islot)->SetBranchAddress(branch, address);
385 }   
386
387 //______________________________________________________________________________
388 void AliAnalysisTask::ConnectInputData(Option_t *)
389 {
390 // Overload and connect your branches here.
391 }
392
393 //______________________________________________________________________________
394 void AliAnalysisTask::LocalInit()
395 {
396 // The method LocalInit() may be implemented to call locally (on the client)
397 // all initialization methods of the class. It is not mandatory and was created
398 // in order to minimize the complexity and readability of the analysis macro.
399 // DO NOT create in this method the histigrams or task output objects that will
400 // go in the task output containers. Use CreateOutputObjects for that.
401 }
402
403 //______________________________________________________________________________
404 void AliAnalysisTask::CreateOutputObjects()
405 {
406 // Called once per task either in PROOF or local mode. Overload to put some 
407 // task initialization and/or create your output objects here.
408 }
409
410 //______________________________________________________________________________
411 void AliAnalysisTask::OpenFile(Int_t iout, Option_t *option) const
412 {
413 // This method has to be called INSIDE the user redefined CreateOutputObjects
414 // method, before creating each object corresponding to the output containers
415 // that are to be written to a file. This need to be done in general for the big output
416 // objects that may not fit memory during processing. 
417 // - 'option' is the file opening option.
418 //=========================================================================
419 // NOTE !: The method call will be ignored in PROOF mode, in which case the 
420 // results have to be streamed back to the client and written just before Terminate()
421 //=========================================================================
422 //
423 // Example:
424 // void MyAnaTask::CreateOutputObjects() {
425 //    OpenFile(0);   // Will open the file for the object to be written at output #0
426 //    fAOD = new TTree("AOD for D0toKPi");
427 //    OpenFile(1);
428 // now some histos that should go in the file of the second output container
429 //    fHist1 = new TH1F("my quality check hist1",...);
430 //    fHist2 = new TH2F("my quality check hist2",...);
431 // }
432    
433    if (iout<0 || iout>=fNoutputs) return;
434    AliAnalysisManager *mgr = AliAnalysisManager::GetAnalysisManager();
435    if (!mgr || mgr->GetAnalysisType()==AliAnalysisManager::kProofAnalysis) return;
436    AliAnalysisDataContainer *cont = GetOutputSlot(iout)->GetContainer();
437    if (strlen(cont->GetFileName())) new TFile(cont->GetFileName(), option);
438 }
439
440 //______________________________________________________________________________
441 Bool_t AliAnalysisTask::Notify()
442 {
443 // Overload this IF you need to treat input file change.
444    return kTRUE;
445 }
446
447 //______________________________________________________________________________
448 void AliAnalysisTask::Terminate(Option_t *)
449 {
450 // Method called by the framework at the end of data processing.
451 }
452
453 //______________________________________________________________________________
454 Bool_t AliAnalysisTask::PostData(Int_t iout, TObject *data, Option_t *option)
455 {
456 // Post output data for a given ouput slot in the corresponding data container.
457 // Published data becomes owned by the data container.
458 // If option is specified, the container connected to the output slot must have
459 // an associated file name defined. The option represents the method to open the file.
460    fPublishedData = 0;
461    AliAnalysisDataSlot *output = GetOutputSlot(iout);
462    if (!output) {
463       Error("PostData","Output slot %i not defined for analysis task %s", iout, GetName());
464       return kFALSE;
465    }
466    if (!output->IsConnected()) {
467       Error("PostData","Output slot %i of analysis task %s not connected to any data container", iout, GetName());
468       return kFALSE;
469    }
470    if (!fOutputReady) {
471       fOutputReady = new Bool_t[fNoutputs];
472       memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
473    }   
474    fOutputReady[iout] = kTRUE;
475    fPublishedData = data;
476    return (output->GetContainer()->SetData(data, option));
477 }
478
479 //______________________________________________________________________________
480 void AliAnalysisTask::SetUsed(Bool_t flag)
481 {
482 // Set 'used' flag recursively to task and all daughter tasks.
483    if (TestBit(kTaskUsed)==flag) return;
484    TObject::SetBit(kTaskUsed,flag);
485    Int_t nd = fTasks->GetSize();
486    AliAnalysisTask *task;
487    for (Int_t i=0; i<nd; i++) {
488       task = (AliAnalysisTask*)fTasks->At(i);
489       task->SetUsed(flag);
490    }
491 }   
492
493 //______________________________________________________________________________
494 Bool_t AliAnalysisTask::CheckCircularDeps()
495 {
496 // Check for illegal circular dependencies, e.g. a daughter task should not have
497 // a hierarchical parent as subtask.
498    if (IsChecked()) return kTRUE;
499    SetChecked();
500    TList *tasks = GetListOfTasks();
501    Int_t ntasks = tasks->GetSize();
502    AliAnalysisTask *task;
503    for (Int_t i=0; i<ntasks; i++) {
504       task = (AliAnalysisTask*)tasks->At(i);
505       if (task->CheckCircularDeps()) return kTRUE;
506    }
507    SetChecked(kFALSE);
508    return kFALSE;
509 }   
510    
511 //______________________________________________________________________________
512 void AliAnalysisTask::PrintTask(Option_t *option, Int_t indent) const
513 {
514 // Print task info.
515    AliAnalysisTask *thistask = (AliAnalysisTask*)this;
516    TString opt(option);
517    opt.ToLower();
518    Bool_t dep = (opt.Contains("dep"))?kTRUE:kFALSE;
519    TString ind;
520    Int_t islot;
521    AliAnalysisDataContainer *cont;
522    for (Int_t i=0; i<indent; i++) ind += " ";
523    if (!dep || (dep && IsChecked())) {
524       printf("%s\n", Form("%stask: %s  ACTIVE=%i", ind.Data(), GetName(),IsActive()));
525       if (dep) thistask->SetChecked(kFALSE);
526       else {
527          for (islot=0; islot<fNinputs; islot++) {
528             printf("%s", Form("%s   INPUT #%i: %s <- ",ind.Data(),islot, GetInputType(islot)->GetName()));
529             cont = GetInputSlot(islot)->GetContainer();
530             if (cont) printf(" [%s]\n", cont->GetName());
531             else printf(" [NO CONTAINER]\n");
532          }
533          for (islot=0; islot<fNoutputs; islot++) {
534             printf("%s", Form("%s   OUTPUT #%i: %s -> ",ind.Data(),islot, GetOutputType(islot)->GetName()));
535             cont = GetOutputSlot(islot)->GetContainer();
536             if (cont) printf(" [%s]\n", cont->GetName());
537             else printf(" [NO CONTAINER]\n");
538          }            
539       }
540    }
541    PrintContainers(option, indent+3);
542 }      
543
544 //______________________________________________________________________________
545 void AliAnalysisTask::PrintContainers(Option_t *option, Int_t indent) const
546 {
547 // Print containers info.
548    AliAnalysisDataContainer *cont;
549    TString ind;
550    for (Int_t i=0; i<indent; i++) ind += " ";
551    Int_t islot;
552    for (islot=0; islot<fNoutputs; islot++) {
553       cont = GetOutputSlot(islot)->GetContainer();
554       if (cont) cont->PrintContainer(option, indent);
555    }   
556 }
557
558 //______________________________________________________________________________
559 void AliAnalysisTask::SetExecPerEvent(Bool_t flag)
560 {
561 // Set the task execution mode - run in a event loop or single shot. All output
562 // containers of this task will get the same type.
563    TObject::SetBit(kTaskEvtByEvt,flag);
564    AliAnalysisDataContainer *cont;
565    Int_t islot;
566    for (islot=0; islot<fNoutputs; islot++) {
567       cont = GetOutputSlot(islot)->GetContainer();
568       if (cont) cont->SetEventByEvent(flag);
569    }   
570 }
571