]> git.uio.no Git - u/mrichter/AliRoot.git/blob - ANALYSIS/AliAnalysisTask.cxx
- AliAnalysisTask::OpenFile(i) opens and returns the file for the container
[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 #include <TTree.h>
104
105 #include "AliAnalysisTask.h"
106 #include "AliAnalysisDataSlot.h"
107 #include "AliAnalysisDataContainer.h"
108 #include "AliAnalysisManager.h"
109
110 ClassImp(AliAnalysisTask)
111
112 //______________________________________________________________________________
113 AliAnalysisTask::AliAnalysisTask()
114                 :fReady(kFALSE),
115                  fInitialized(kFALSE),
116                  fNinputs(0),
117                  fNoutputs(0),
118                  fOutputReady(NULL),
119                  fPublishedData(NULL),
120                  fInputs(NULL),
121                  fOutputs(NULL)
122 {
123 // Default constructor.
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    fInputs      = new TObjArray(2);
140    fOutputs     = new TObjArray(2);
141 }
142
143 //______________________________________________________________________________
144 AliAnalysisTask::AliAnalysisTask(const AliAnalysisTask &task)
145                 :TTask(task),
146                  fReady(task.fReady),
147                  fInitialized(task.fInitialized),
148                  fNinputs(task.fNinputs),
149                  fNoutputs(task.fNoutputs),                 
150                  fOutputReady(NULL),
151                  fPublishedData(NULL),
152                  fInputs(NULL),
153                  fOutputs(NULL)                 
154 {
155 // Copy ctor.
156    fInputs      = new TObjArray((fNinputs)?fNinputs:2);
157    fOutputs     = new TObjArray((fNoutputs)?fNoutputs:2);
158    fPublishedData = 0;
159    Int_t i;
160    for (i=0; i<fNinputs; i++) fInputs->AddAt(task.GetInputSlot(i),i);
161    fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
162    for (i=0; i<fNoutputs; i++) {
163       fOutputReady[i] = IsOutputReady(i);
164       fOutputs->AddAt(task.GetOutputSlot(i),i);
165    }   
166 }
167
168 //______________________________________________________________________________
169 AliAnalysisTask::~AliAnalysisTask()
170 {
171 // Dtor.
172    if (fTasks) fTasks->Clear();
173    if (fInputs)  {fInputs->Delete(); delete fInputs;}
174    if (fOutputs) {fOutputs->Delete(); delete fOutputs;}
175 }   
176   
177 //______________________________________________________________________________
178 AliAnalysisTask& AliAnalysisTask::operator=(const AliAnalysisTask& task)
179 {
180 // Assignment
181    if (&task == this) return *this;
182    TTask::operator=(task);
183    fReady       = task.IsReady();
184    fInitialized = task.IsInitialized();
185    fNinputs     = task.GetNinputs();
186    fNoutputs    = task.GetNoutputs();
187    fInputs      = new TObjArray((fNinputs)?fNinputs:2);
188    fOutputs     = new TObjArray((fNoutputs)?fNoutputs:2);
189    fPublishedData = 0;
190    Int_t i;
191    for (i=0; i<fNinputs; i++) fInputs->AddAt(new AliAnalysisDataSlot(*task.GetInputSlot(i)),i);
192    fOutputReady = new Bool_t[(fNoutputs)?fNoutputs:2];
193    for (i=0; i<fNoutputs; i++) {
194       fOutputReady[i] = IsOutputReady(i);
195       fOutputs->AddAt(new AliAnalysisDataSlot(*task.GetOutputSlot(i)),i);
196    }         
197    return *this;
198 }
199
200 //______________________________________________________________________________
201 Bool_t AliAnalysisTask::AreSlotsConnected()
202 {
203 // Check if all input/output slots are connected. If this is the case fReady=true
204    fReady = kFALSE;
205    if (!fNinputs || !fNoutputs) return kFALSE;
206    Int_t i;
207    AliAnalysisDataSlot *slot;
208    for (i=0; i<fNinputs; i++) {
209       slot = (AliAnalysisDataSlot*)fInputs->At(i);
210       if (!slot) {
211               Error("AreSlotsConnected", "Input slot %d of task %s not defined !",i,GetName());
212          return kFALSE;
213       }   
214       if (!slot->IsConnected()) return kFALSE;
215    }   
216    for (i=0; i<fNoutputs; i++) {
217       slot = (AliAnalysisDataSlot*)fOutputs->At(i);
218       if (!slot) {
219          Error("AreSlotsConnected", "Output slot %d of task %s not defined !",i,GetName());
220          return kFALSE;
221       }   
222       if (!slot->IsConnected()) return kFALSE;
223    } 
224    fReady = kTRUE;  
225    return kTRUE;
226 }
227
228 //______________________________________________________________________________
229 void AliAnalysisTask::CheckNotify(Bool_t init)
230 {
231 // Check if data is available from all inputs. Change the status of the task
232 // accordingly. This method is called automatically for all tasks connected
233 // to a container where the data was published.
234    if (init) fInitialized = kFALSE;
235    Bool_t single_shot = IsPostEventLoop();
236    AliAnalysisDataContainer *cinput;
237    for (Int_t islot=0; islot<fNinputs; islot++) {
238       cinput = GetInputSlot(islot)->GetContainer();
239       if (!cinput->GetData() || (single_shot && !cinput->IsPostEventLoop())) {
240          SetActive(kFALSE);
241          return;
242       }   
243    }   
244    SetActive(kTRUE);
245    if (fInitialized) return;
246    TDirectory *cursav = gDirectory;
247    ConnectInputData();
248    if (cursav) cursav->cd();
249    fInitialized = kTRUE;
250 }
251
252 //______________________________________________________________________________
253 Bool_t AliAnalysisTask::ConnectInput(Int_t islot, AliAnalysisDataContainer *cont)
254 {
255 // Connect an input slot to a data container.
256    AliAnalysisDataSlot *input = GetInputSlot(islot);
257    if (!input) {
258       Error("ConnectInput","Input slot %i not defined for analysis task %s", islot, GetName());
259       return kFALSE;
260    }
261    // Check type matching          
262    if (!input->GetType()->InheritsFrom(cont->GetType())) {
263       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());
264       return kFALSE;
265    }  
266    // Connect the slot to the container as input          
267    if (!input->ConnectContainer(cont)) return kFALSE;
268    // Add this to the list of container consumers
269    cont->AddConsumer(this, islot);
270    AreSlotsConnected();
271    return kTRUE;
272 }   
273
274 //______________________________________________________________________________
275 Bool_t AliAnalysisTask::ConnectOutput(Int_t islot, AliAnalysisDataContainer *cont)
276 {
277 // Connect an output slot to a data container.
278    AliAnalysisDataSlot *output = GetOutputSlot(islot);
279    if (!output) {
280       Error("ConnectOutput","Output slot %i not defined for analysis task %s", islot, GetName());
281       return kFALSE;
282    }
283    // Check type matching          
284    if (!output->GetType()->InheritsFrom(cont->GetType())) {
285       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());
286       return kFALSE;
287    }            
288    // Connect the slot to the container as output         
289    if (!output->ConnectContainer(cont)) return kFALSE;
290    // Set event loop type the same as for the task
291    cont->SetPostEventLoop(IsPostEventLoop());
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::EnableBranch(Int_t islot, const char *bname) const
389 {
390 // Call this in ConnectInputData() to enable only the branches needed by this 
391 // task. "*" will enable everything.
392    AliAnalysisDataSlot *input = GetInputSlot(islot);
393    if (!input || !input->GetType()->InheritsFrom(TTree::Class())) {
394       Error("EnableBranch", "Wrong slot type #%d for task %s: not TTree-derived type", islot, GetName());
395       return;
396    }   
397    TTree *tree = (TTree*)input->GetData();
398    if (!strcmp(bname, "*")) {
399       tree->SetBranchStatus("*",1);
400       return;
401    }
402    AliAnalysisDataSlot::EnableBranch(bname, tree);
403 }
404       
405 //______________________________________________________________________________
406 void AliAnalysisTask::ConnectInputData(Option_t *)
407 {
408 // Overload and connect your branches here.
409 }
410
411 //______________________________________________________________________________
412 void AliAnalysisTask::LocalInit()
413 {
414 // The method LocalInit() may be implemented to call locally (on the client)
415 // all initialization methods of the class. It is not mandatory and was created
416 // in order to minimize the complexity and readability of the analysis macro.
417 // DO NOT create in this method the histigrams or task output objects that will
418 // go in the task output containers. Use CreateOutputObjects for that.
419 }
420
421 //______________________________________________________________________________
422 void AliAnalysisTask::CreateOutputObjects()
423 {
424 // Called once per task either in PROOF or local mode. Overload to put some 
425 // task initialization and/or create your output objects here.
426 }
427
428 //______________________________________________________________________________
429 TFile *AliAnalysisTask::OpenFile(Int_t iout, Option_t *option) const
430 {
431 // This method has to be called INSIDE the user redefined CreateOutputObjects
432 // method, before creating each object corresponding to the output containers
433 // that are to be written to a file. This need to be done in general for the big output
434 // objects that may not fit memory during processing. 
435 // - 'option' is the file opening option.
436 //=========================================================================
437 // NOTE !: The method call will be ignored in PROOF mode, in which case the 
438 // results have to be streamed back to the client and written just before Terminate()
439 //=========================================================================
440 //
441 // Example:
442 // void MyAnaTask::CreateOutputObjects() {
443 //    OpenFile(0);   // Will open the file for the object to be written at output #0
444 //    fAOD = new TTree("AOD for D0toKPi");
445 //    OpenFile(1);
446 // now some histos that should go in the file of the second output container
447 //    fHist1 = new TH1F("my quality check hist1",...);
448 //    fHist2 = new TH2F("my quality check hist2",...);
449 // }
450    
451    if (iout<0 || iout>=fNoutputs) {
452       Error("OpenFile", "No output slot for task %s with index %d", GetName(), iout);
453       return NULL;
454    }   
455    // We allow file opening also on the slaves (AG)
456 //   AliAnalysisManager *mgr = AliAnalysisManager::GetAnalysisManager();
457 //   if (!mgr || mgr->GetAnalysisType()==AliAnalysisManager::kProofAnalysis) return;
458    AliAnalysisDataContainer *cont = GetOutputSlot(iout)->GetContainer();
459    TFile *f = NULL;
460    if (strlen(cont->GetFileName())) f = new TFile(cont->GetFileName(), option);
461    if (f && !f->IsZombie()) return f;
462    return NULL;
463 }
464
465 //______________________________________________________________________________
466 Bool_t AliAnalysisTask::Notify()
467 {
468 // Overload this IF you need to treat input file change.
469    return kTRUE;
470 }
471
472 //______________________________________________________________________________
473 void AliAnalysisTask::Terminate(Option_t *)
474 {
475 // Method called by the framework at the end of data processing.
476 }
477
478 //______________________________________________________________________________
479 Bool_t AliAnalysisTask::PostData(Int_t iout, TObject *data, Option_t *option)
480 {
481 // Post output data for a given ouput slot in the corresponding data container.
482 // Published data becomes owned by the data container.
483 // If option is specified, the container connected to the output slot must have
484 // an associated file name defined. The option represents the method to open the file.
485    fPublishedData = 0;
486    AliAnalysisDataSlot *output = GetOutputSlot(iout);
487    if (!output) {
488       Error("PostData","Output slot %i not defined for analysis task %s", iout, GetName());
489       return kFALSE;
490    }
491    if (!output->IsConnected()) {
492       Error("PostData","Output slot %i of analysis task %s not connected to any data container", iout, GetName());
493       return kFALSE;
494    }
495    if (!fOutputReady) {
496       fOutputReady = new Bool_t[fNoutputs];
497       memset(fOutputReady, 0, fNoutputs*sizeof(Bool_t));
498    }   
499    fOutputReady[iout] = kTRUE;
500    fPublishedData = data;
501    return (output->GetContainer()->SetData(data, option));
502 }
503
504 //______________________________________________________________________________
505 void AliAnalysisTask::SetUsed(Bool_t flag)
506 {
507 // Set 'used' flag recursively to task and all daughter tasks.
508    if (TestBit(kTaskUsed)==flag) return;
509    TObject::SetBit(kTaskUsed,flag);
510    Int_t nd = fTasks->GetSize();
511    AliAnalysisTask *task;
512    for (Int_t i=0; i<nd; i++) {
513       task = (AliAnalysisTask*)fTasks->At(i);
514       task->SetUsed(flag);
515    }
516 }   
517
518 //______________________________________________________________________________
519 Bool_t AliAnalysisTask::CheckCircularDeps()
520 {
521 // Check for illegal circular dependencies, e.g. a daughter task should not have
522 // a hierarchical parent as subtask.
523    if (IsChecked()) return kTRUE;
524    SetChecked();
525    TList *tasks = GetListOfTasks();
526    Int_t ntasks = tasks->GetSize();
527    AliAnalysisTask *task;
528    for (Int_t i=0; i<ntasks; i++) {
529       task = (AliAnalysisTask*)tasks->At(i);
530       if (task->CheckCircularDeps()) return kTRUE;
531    }
532    SetChecked(kFALSE);
533    return kFALSE;
534 }   
535    
536 //______________________________________________________________________________
537 void AliAnalysisTask::PrintTask(Option_t *option, Int_t indent) const
538 {
539 // Print task info.
540    AliAnalysisTask *thistask = (AliAnalysisTask*)this;
541    TString opt(option);
542    opt.ToLower();
543    Bool_t dep = (opt.Contains("dep"))?kTRUE:kFALSE;
544    TString ind;
545    Int_t islot;
546    AliAnalysisDataContainer *cont;
547    for (Int_t i=0; i<indent; i++) ind += " ";
548    if (!dep || (dep && IsChecked())) {
549       printf("%s\n", Form("%stask: %s  ACTIVE=%i POST_LOOP=%i", ind.Data(), GetName(),IsActive(),IsPostEventLoop()));
550       if (dep) thistask->SetChecked(kFALSE);
551       else {
552          for (islot=0; islot<fNinputs; islot++) {
553             printf("%s", Form("%s   INPUT #%i: %s <- ",ind.Data(),islot, GetInputType(islot)->GetName()));
554             cont = GetInputSlot(islot)->GetContainer();
555             if (cont) printf(" [%s]\n", cont->GetName());
556             else printf(" [NO CONTAINER]\n");
557          }
558          for (islot=0; islot<fNoutputs; islot++) {
559             printf("%s", Form("%s   OUTPUT #%i: %s -> ",ind.Data(),islot, GetOutputType(islot)->GetName()));
560             cont = GetOutputSlot(islot)->GetContainer();
561             if (cont) printf(" [%s]\n", cont->GetName());
562             else printf(" [NO CONTAINER]\n");
563          }            
564       }
565    }
566    PrintContainers(option, indent+3);
567 }      
568
569 //______________________________________________________________________________
570 void AliAnalysisTask::PrintContainers(Option_t *option, Int_t indent) const
571 {
572 // Print containers info.
573    AliAnalysisDataContainer *cont;
574    TString ind;
575    for (Int_t i=0; i<indent; i++) ind += " ";
576    Int_t islot;
577    for (islot=0; islot<fNoutputs; islot++) {
578       cont = GetOutputSlot(islot)->GetContainer();
579       if (cont) cont->PrintContainer(option, indent);
580    }   
581 }
582
583 //______________________________________________________________________________
584 void AliAnalysisTask::SetPostEventLoop(Bool_t flag)
585 {
586 // Set the task execution mode - run after event loop or not. All output
587 // containers of this task will get the same type.
588    TObject::SetBit(kTaskPostEventLoop,flag);
589    AliAnalysisDataContainer *cont;
590    Int_t islot;
591    for (islot=0; islot<fNoutputs; islot++) {
592       cont = GetOutputSlot(islot)->GetContainer();
593       if (cont) cont->SetPostEventLoop(flag);
594    }   
595 }
596