Coding violation fixes.
[u/mrichter/AliRoot.git] / RALICE / AliJet.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
18 ///////////////////////////////////////////////////////////////////////////
19 // Class AliJet
20 // Creation and investigation of a jet of particle tracks.
21 // An AliJet can be constructed by adding AliTracks.
22 //
23 // To provide maximal flexibility to the user, two modes of track storage
24 // are provided by means of the memberfunction SetTrackCopy().
25 //
26 // a) SetTrackCopy(0) (which is the default).
27 //    Only the pointers of the 'added' tracks are stored.
28 //    This mode is typically used by making jet studies based on a fixed list
29 //    of tracks which stays under user control or is contained for instance
30 //    in an AliEvent.  
31 //    In this way the AliJet just represents a 'logical structure' for the
32 //    physics analysis which can be embedded in e.g. an AliEvent or AliVertex.
33 //
34 //    Note :
35 //    Modifications made to the original tracks also affect the AliTrack objects
36 //    which are stored in the AliJet. 
37 //
38 // b) SetTrackCopy(1).
39 //    Of every 'added' track a private copy will be made of which the pointer
40 //    will be stored.
41 //    In this way the AliJet represents an entity on its own and modifications
42 //    made to the original tracks do not affect the AliTrack objects which are
43 //    stored in the AliJet. 
44 //    This mode will allow 'adding' many different AliTracks into an AliJet by
45 //    creating only one AliTrack instance in the main programme and using the
46 //    AliTrack::Reset() and AliTrack parameter setting memberfunctions.
47 //
48 // See also the documentation provided for the memberfunction SetOwner(). 
49 //
50 // Coding example to make 2 jets j1 and j2.
51 // ----------------------------------------
52 // j1 contains the AliTracks t1 and t2
53 // j2 contains 10 different AliTracks via tx
54 //
55 // AliTrack t1,t2;
56 //  ...
57 //  ... // code to fill the AliTrack data
58 //  ...
59 // AliJet j1();
60 // j1.AddTrack(t1);
61 // j1.AddTrack(t2);
62 //
63 // AliJet j2();
64 // j2.SetTrackCopy(1);
65 // AliTrack* tx=new AliTrack();
66 // for (Int_t i=0; i<10; i++)
67 // {
68 //  ...
69 //  ... // code to set momentum etc... of the track tx
70 //  ...
71 //  j2.AddTrack(tx);
72 //  tx->Reset();
73 // }
74 //
75 // j1.Data();
76 // j2.Data("sph");
77 //
78 // Float_t e1=j1.GetEnergy();
79 // Float_t pnorm=j1->GetMomentum();
80 // Ali3Vector p=j1->Get3Momentum();
81 // Float_t m=j1.GetInvmass();
82 // Int_t ntk=j1.GetNtracks();
83 // AliTrack* tj=j1.GetTrack(1);
84 //
85 // delete tx;
86 //
87 // Note : All quantities are in GeV, GeV/c or GeV/c**2
88 //
89 //--- Author: Nick van Eijndhoven 10-jul-1997 UU-SAP Utrecht
90 //- Modified: NvE $Date$ UU-SAP Utrecht
91 ///////////////////////////////////////////////////////////////////////////
92
93 #include "AliJet.h"
94 #include "Riostream.h"
95  
96 ClassImp(AliJet) // Class implementation to enable ROOT I/O
97  
98 AliJet::AliJet() : TNamed(),Ali4Vector()
99 {
100 // Default constructor
101 // All variables initialised to 0
102 // Initial maximum number of tracks is set to the default value
103  Init();
104  Reset();
105  SetNtinit();
106 }
107 ///////////////////////////////////////////////////////////////////////////
108 void AliJet::Init()
109 {
110 // Initialisation of pointers etc...
111  fTracks=0;
112  fNtinit=0;
113  fTrackCopy=0;
114  fSelected=0;
115 }
116 ///////////////////////////////////////////////////////////////////////////
117 AliJet::AliJet(Int_t n) : TNamed(),Ali4Vector()
118 {
119 // Create a jet to hold initially a maximum of n tracks
120 // All variables initialised to 0
121  Init();
122  Reset();
123  if (n > 0)
124  {
125   SetNtinit(n);
126  }
127  else
128  {
129   cout << endl;
130   cout << " *AliJet* Initial max. number of tracks entered : " << n << endl;
131   cout << " This is invalid. Default initial maximum will be used." << endl;
132   cout << endl;
133   SetNtinit();
134  }
135 }
136 ///////////////////////////////////////////////////////////////////////////
137 AliJet::~AliJet()
138 {
139 // Default destructor
140  if (fTracks)
141  {
142   delete fTracks;
143   fTracks=0;
144  }
145  if (fSelected)
146  {
147   delete fSelected;
148   fSelected=0;
149  }
150 }
151 ///////////////////////////////////////////////////////////////////////////
152 void AliJet::SetOwner(Bool_t own)
153 {
154 // Set ownership of all added objects. 
155 // The default parameter is own=kTRUE.
156 //
157 // Invokation of this memberfunction also sets all the copy modes
158 // (e.g. TrackCopy & co.) according to the value of own.
159 //
160 // This function (with own=kTRUE) is particularly useful when reading data
161 // from a tree/file, since Reset() will then actually remove all the
162 // added objects from memory irrespective of the copy mode settings
163 // during the tree/file creation process. In this way it provides a nice way
164 // of preventing possible memory leaks in the reading/analysis process.
165 //
166 // In addition this memberfunction can also be used as a shortcut to set all
167 // copy modes in one go during a tree/file creation process.
168 // However, in this case the user has to take care to only set/change the
169 // ownership (and copy mode) for empty objects (e.g. newly created objects
170 // or after invokation of the Reset() memberfunction) otherwise it will
171 // very likely result in inconsistent destructor behaviour.
172
173  Int_t mode=1;
174  if (!own) mode=0;
175  if (fTracks) fTracks->SetOwner(own);
176  fTrackCopy=mode;
177 }
178 ///////////////////////////////////////////////////////////////////////////
179 AliJet::AliJet(const AliJet& j) : TNamed(j),Ali4Vector(j)
180 {
181 // Copy constructor
182  fNtinit=j.fNtinit;
183  fNtmax=j.fNtmax;
184  fQ=j.fQ;
185  fNtrk=j.fNtrk;
186  fTrackCopy=j.fTrackCopy;
187  fUserId=j.fUserId;
188
189  fSelected=0;
190
191  fTracks=0;
192  if (fNtrk)
193  {
194   fTracks=new TObjArray(fNtmax);
195   if (fTrackCopy) fTracks->SetOwner();
196  }
197
198  for (Int_t i=1; i<=fNtrk; i++)
199  {
200   AliTrack* tx=j.GetTrack(i);
201   if (fTrackCopy)
202   {
203    fTracks->Add(tx->Clone());
204   }
205   else
206   {
207    fTracks->Add(tx);
208   }
209  } 
210 }
211 ///////////////////////////////////////////////////////////////////////////
212 void AliJet::SetNtinit(Int_t n)
213 {
214 // Set the initial maximum number of tracks for this jet
215  fNtinit=n;
216  fNtmax=n;
217  if (fTracks)
218  {
219   delete fTracks;
220   fTracks=0;
221  }
222 }
223 ///////////////////////////////////////////////////////////////////////////
224 void AliJet::Reset()
225 {
226 // Reset all variables to 0
227 // The max. number of tracks is set to the initial value again
228  fNtrk=0;
229  fQ=0;
230  fUserId=0;
231  Double_t a[4]={0,0,0,0};
232  SetVector(a,"sph");
233  if (fNtinit > 0) SetNtinit(fNtinit);
234 }
235 ///////////////////////////////////////////////////////////////////////////
236 void AliJet::AddTrack(AliTrack& t)
237 {
238 // Add a track to the jet.
239 // In case the maximum number of tracks has been reached
240 // space will be extended to hold an additional amount of tracks as
241 // was initially reserved.
242 // See SetTrackCopy() to tailor the functionality of the stored structures.
243 //
244 // Note :
245 // In case a private copy is made, this is performed via the Clone() memberfunction.
246 // All AliTrack and derived classes have the default TObject::Clone() memberfunction.
247 // However, derived classes generally contain an internal data structure which may
248 // include pointers to other objects. Therefore it is recommended to provide
249 // for all derived classes a specific copy constructor and override the default Clone()
250 // memberfunction using this copy constructor.
251 // An example for this may be seen from AliTrack.   
252
253  AddTrack(t,1);
254 }
255 ///////////////////////////////////////////////////////////////////////////
256 void AliJet::AddTrack(AliTrack& t,Int_t copy)
257 {
258 // Internal memberfunction to actually add a track to the jet.
259 // In case the maximum number of tracks has been reached
260 // space will be extended to hold an additional amount of tracks as
261 // was initially reserved.
262 //
263 // If copy=0 NO copy of the track will be made, irrespective of the setting
264 // of the TrackCopy flag.
265 // This allows a proper treatment of automatically generated connecting
266 // tracks between vertices.
267 //
268 // Note :
269 // In case a private copy is made, this is performed via the Clone() memberfunction.
270
271  if (!fTracks)
272  {
273   fTracks=new TObjArray(fNtmax);
274   if (fTrackCopy) fTracks->SetOwner();
275  }
276  if (fNtrk == fNtmax) // Check if maximum track number is reached
277  {
278   fNtmax+=fNtinit;
279   fTracks->Expand(fNtmax);
280  }
281  
282  // Add the track to this jet
283  fNtrk++;
284  if (fTrackCopy && copy)
285  {
286   fTracks->Add(t.Clone());
287  }
288  else
289  {
290   fTracks->Add(&t);
291  }
292
293  (*this)+=(Ali4Vector&)t;
294  fQ+=t.GetCharge();
295
296 }
297 ///////////////////////////////////////////////////////////////////////////
298 void AliJet::Data(TString f)
299 {
300 // Provide jet information within the coordinate frame f
301  const char* name=GetName();
302  const char* title=GetTitle();
303
304  cout << " *AliJet::Data*";
305  if (strlen(name))  cout << " Name : " << GetName();
306  if (strlen(title)) cout << " Title : " << GetTitle();
307  cout << endl;
308  cout << " Id : " << fUserId << " Invmass : " << GetInvmass() << " Charge : " << fQ
309       << " Momentum : " << GetMomentum() << endl;
310
311  ShowTracks(0);
312
313  Ali4Vector::Data(f); 
314
315 ///////////////////////////////////////////////////////////////////////////
316 void AliJet::List(TString f)
317 {
318 // Provide jet and primary track information within the coordinate frame f
319
320  Data(f); // Information of the current jet
321
322  // The tracks of this jet
323  AliTrack* t; 
324  for (Int_t it=1; it<=fNtrk; it++)
325  {
326   t=GetTrack(it);
327   if (t)
328   {
329    cout << "  ---Track no. " << it << endl;
330    cout << " ";
331    t->Data(f); 
332   }
333   else
334   {
335    cout << " *AliJet::List* Error : No track present." << endl; 
336   }
337  }
338
339 ///////////////////////////////////////////////////////////////////////////
340 void AliJet::ListAll(TString f)
341 {
342 // Provide jet and prim.+sec. track information within the coordinate frame f
343
344  Data(f); // Information of the current jet
345
346  // The tracks of this jet
347  AliTrack* t; 
348  for (Int_t it=1; it<=fNtrk; it++)
349  {
350   t=GetTrack(it);
351   if (t)
352   {
353    cout << "  ---Track no. " << it << endl;
354    cout << " ";
355    t->ListAll(f); 
356   }
357   else
358   {
359    cout << " *AliJet::List* Error : No track present." << endl; 
360   }
361  }
362
363 ///////////////////////////////////////////////////////////////////////////
364 Int_t AliJet::GetNtracks() const
365 {
366 // Return the current number of tracks of this jet
367  return fNtrk;
368 }
369 ///////////////////////////////////////////////////////////////////////////
370 Double_t AliJet::GetEnergy()
371 {
372 // Return the total energy of the jet
373  return GetScalar();
374 }
375 ///////////////////////////////////////////////////////////////////////////
376 Double_t AliJet::GetMomentum()
377 {
378 // Return the value of the total jet 3-momentum
379 // The error can be obtained by invoking GetResultError() after
380 // invokation of GetMomentum().
381  Double_t norm=fV.GetNorm();
382  fDresult=fV.GetResultError();
383  return norm;
384 }
385 ///////////////////////////////////////////////////////////////////////////
386 Ali3Vector AliJet::Get3Momentum() const
387 {
388 // Return the the total jet 3-momentum
389  Ali3Vector p=Get3Vector();
390  return p;
391 }
392 ///////////////////////////////////////////////////////////////////////////
393 Double_t AliJet::GetInvmass()
394 {
395 // Return the invariant mass of the jet
396  Double_t m2=Dot(*this);
397  if (m2>0)
398  {
399   return sqrt(m2);
400  }
401  else
402  {
403   return 0;
404  }
405 }
406 ///////////////////////////////////////////////////////////////////////////
407 Float_t AliJet::GetCharge() const
408 {
409 // Return the total charge of the jet
410  return fQ;
411 }
412 ///////////////////////////////////////////////////////////////////////////
413 AliTrack* AliJet::GetTrack(Int_t i) const
414 {
415 // Return the i-th track of this jet
416
417  if (!fTracks) return 0;
418
419  if (i<=0 || i>fNtrk)
420  {
421   cout << " *AliJet*::GetTrack* Invalid argument i : " << i
422        << " Ntrk = " << fNtrk << endl;
423   return 0;
424  }
425  else
426  {
427   return (AliTrack*)fTracks->At(i-1);
428  }
429 }
430 ///////////////////////////////////////////////////////////////////////////
431 AliTrack* AliJet::GetIdTrack(Int_t id) const
432 {
433 // Return the track with user identifier "id" of this jet
434  if (!fTracks) return 0;
435
436  AliTrack* tx=0;
437  for (Int_t i=0; i<fNtrk; i++)
438  {
439   tx=(AliTrack*)fTracks->At(i);
440   if (id == tx->GetId()) return tx;
441  }
442  return 0; // No matching id found
443 }
444 ///////////////////////////////////////////////////////////////////////////
445 TObjArray* AliJet::GetTracks(Int_t idmode,Int_t chmode,Int_t pcode)
446 {
447 // Provide references to user selected tracks based on the idmode, chmode
448 // and pcode selections as specified by the user.
449 //
450 // The following selection combinations are available :
451 // ----------------------------------------------------
452 // idmode = -1 ==> Select tracks with negative user identifier "id"
453 //           0 ==> No selection on user identifier
454 //           1 ==> Select tracks with positive user identifier "id"
455 //
456 // chmode = -1 ==> Select tracks with negative charge
457 //           0 ==> Select neutral tracks
458 //           1 ==> Select tracks with positive charge
459 //           2 ==> No selection on charge
460 //
461 // pcode  =  0 ==> No selection on particle code
462 //           X ==> Select tracks with particle code +X or -X
463 //                 This allows selection of both particles and anti-particles
464 //                 in case of PDG particle codes.
465 //                 Selection of either particles or anti-particles can be
466 //                 obtained in combination with the "chmode" selector.
467 //
468 // Examples :
469 // ----------
470 // idmode=-1 chmode=0 pcode=0   : Selection of all neutral tracks with negative id.
471 // idmode=0  chmode=2 pcode=211 : Selection of all charged pions (PDG convention).
472 // idmode=0  chmode=1 pcode=321 : Selection of all positive kaons (PDG convention).
473 //
474 // The default values are idmode=0 chmode=2 pcode=0 (i.e. no selections applied).
475 //
476 // Notes :
477 // -------
478 // 1) In case the user has labeled simulated tracks with negative id and
479 //    reconstructed tracks with positive id, this memberfunction provides
480 //    easy access to either all simulated or reconstructed tracks.
481 // 2) Subsequent invokations of this memberfunction with e.g. chmode=-1 and chmode=1
482 //    provides a convenient way to investigate particle pairs with opposite charge
483 //    (e.g. for invariant mass analysis).
484
485  if (fSelected)
486  {
487   fSelected->Clear();
488  }
489  else
490  {
491   fSelected=new TObjArray();
492  }
493
494  if (!fTracks) return fSelected;
495
496  AliTrack* tx=0;
497  Int_t code=0;
498  Int_t id=0;
499  Float_t q=0;
500  for (Int_t i=0; i<fNtrk; i++)
501  {
502   tx=(AliTrack*)fTracks->At(i);
503   if (!tx) continue;
504
505   code=tx->GetParticleCode();
506   if (pcode && abs(pcode)!=abs(code)) continue;
507
508   id=tx->GetId();
509   if (idmode==-1 && id>=0) continue;
510   if (idmode==1 && id<=0) continue;
511
512   q=tx->GetCharge();
513   if (chmode==-1 && q>=0) continue;
514   if (chmode==0 && fabs(q)>1e-10) continue;
515   if (chmode==1 && q<=0) continue;
516
517   fSelected->Add(tx);
518  }
519
520  return fSelected;
521 }
522 ///////////////////////////////////////////////////////////////////////////
523 void AliJet::ShowTracks(Int_t mode) const
524 {
525 // Provide an overview of the available tracks.
526 // The argument mode determines the amount of information as follows :
527 // mode = 0 ==> Only printout of the number of tracks
528 //        1 ==> Provide a listing with 1 line of info for each track
529 //
530 // The default is mode=1.
531 //
532  Int_t ntk=GetNtracks();
533  if (ntk)
534  {
535   if (!mode)
536   {
537    cout << " There are " << ntk << " tracks available." << endl; 
538   }
539   else
540   {
541    cout << " The following " << ntk << " tracks are available :" << endl; 
542    for (Int_t i=1; i<=ntk; i++)
543    {
544     AliTrack* tx=GetTrack(i);
545     if (tx)
546     {
547      const char* name=tx->GetName();
548      const char* title=tx->GetTitle();
549      cout << " Track : " << i;
550      cout << " Id : " << tx->GetId();
551      cout << " Q : " << tx->GetCharge() << " m : " << tx->GetMass() << " p : " << tx->GetMomentum();
552      if (strlen(name)) cout << " Name : " << name;
553      if (strlen(title)) cout << " Title : " << title;
554      cout << endl;
555     }
556    }
557   }
558  }
559  else
560  {
561   cout << " No tracks are present." << endl;
562  }
563 }
564 ///////////////////////////////////////////////////////////////////////////
565 Double_t AliJet::GetPt()
566 {
567 // Provide trans. momentum value w.r.t. z-axis.
568 // The error on the value can be obtained by GetResultError()
569 // after invokation of GetPt().
570  Ali3Vector v;
571  v=GetVecTrans();
572  Double_t norm=v.GetNorm();
573  fDresult=v.GetResultError();
574
575  return norm;
576 }
577 ///////////////////////////////////////////////////////////////////////////
578 Double_t AliJet::GetPl()
579 {
580 // Provide long. momentum value w.r.t. z-axis.
581 // Note : the returned value can also be negative.
582 // The error on the value can be obtained by GetResultError()
583 // after invokation of GetPl().
584  Ali3Vector v;
585  v=GetVecLong();
586
587  Double_t pl=v.GetNorm();
588  fDresult=v.GetResultError();
589
590  Double_t a[3];
591  v.GetVector(a,"sph");
592  if (cos(a[1])<0) pl=-pl;
593
594  return pl;
595 }
596 ///////////////////////////////////////////////////////////////////////////
597 Double_t AliJet::GetEt()
598 {
599 // Provide trans. energy value w.r.t. z-axis.
600 // The error on the value can be obtained by GetResultError()
601 // after invokation of GetEt().
602  Double_t et=GetScaTrans();
603
604  return et;
605 }
606 ///////////////////////////////////////////////////////////////////////////
607 Double_t AliJet::GetEl()
608 {
609 // Provide long. energy value w.r.t. z-axis.
610 // Note : the returned value can also be negative.
611 // The error on the value can be obtained by GetResultError()
612 // after invokation of GetEl().
613  Double_t el=GetScaLong();
614
615  return el;
616 }
617 ///////////////////////////////////////////////////////////////////////////
618 Double_t AliJet::GetMt()
619 {
620 // Provide transverse mass value w.r.t. z-axis.
621 // The error on the value can be obtained by GetResultError()
622 // after invokation of GetMt().
623  Double_t pt=GetPt();
624  Double_t dpt=GetResultError();
625  Double_t m=GetInvmass();
626  Double_t dm=GetResultError();
627
628  Double_t mt=sqrt(pt*pt+m*m);
629  Double_t dmt2=0;
630  if (mt) dmt2=(pow((pt*dpt),2)+pow((m*dm),2))/(mt*mt);
631
632  fDresult=sqrt(dmt2);
633  return mt;
634 }
635 ///////////////////////////////////////////////////////////////////////////
636 Double_t AliJet::GetRapidity()
637 {
638 // Provide rapidity value w.r.t. z-axis.
639 // The error on the value can be obtained by GetResultError()
640 // after invokation of GetRapidity().
641 // Note : Also GetPseudoRapidity() is available since this class is
642 //        derived from Ali4Vector.
643  Double_t e=GetEnergy();
644  Double_t de=GetResultError();
645  Double_t pl=GetPl();
646  Double_t dpl=GetResultError();
647  Double_t sum=e+pl;
648  Double_t dif=e-pl;
649
650  Double_t y=9999,dy2=0;
651  if (sum && dif) y=0.5*log(sum/dif);
652
653  if (sum*dif) dy2=(1./(sum*dif))*(pow((pl*de),2)+pow((e*dpl),2));
654
655  fDresult=sqrt(dy2);
656  return y;
657 }
658 ///////////////////////////////////////////////////////////////////////////
659 void AliJet::SetTrackCopy(Int_t j)
660 {
661 // (De)activate the creation of private copies of the added tracks.
662 // j=0 ==> No private copies are made; pointers of original tracks are stored.
663 // j=1 ==> Private copies of the tracks are made and these pointers are stored.
664 //
665 // Note : Once the storage contains pointer(s) to AliTrack(s) one cannot
666 //        change the TrackCopy mode anymore.
667 //        To change the TrackCopy mode for an existing AliJet containing
668 //        tracks one first has to invoke Reset().
669  if (!fTracks)
670  {
671   if (j==0 || j==1)
672   {
673    fTrackCopy=j;
674   }
675   else
676   {
677    cout << "*AliJet::SetTrackCopy* Invalid argument : " << j << endl;
678   }
679  }
680  else
681  {
682   cout << "*AliJet::SetTrackCopy* Storage already contained tracks."
683        << "  ==> TrackCopy mode not changed." << endl; 
684  }
685 }
686 ///////////////////////////////////////////////////////////////////////////
687 Int_t AliJet::GetTrackCopy() const
688 {
689 // Provide value of the TrackCopy mode.
690 // 0 ==> No private copies are made; pointers of original tracks are stored.
691 // 1 ==> Private copies of the tracks are made and these pointers are stored.
692  return fTrackCopy;
693 }
694 ///////////////////////////////////////////////////////////////////////////
695 void AliJet::SetId(Int_t id)
696 {
697 // Set a user defined identifier for this jet.
698  fUserId=id;
699 }
700 ///////////////////////////////////////////////////////////////////////////
701 Int_t AliJet::GetId() const
702 {
703 // Provide the user defined identifier of this jet.
704  return fUserId;
705 }
706 ///////////////////////////////////////////////////////////////////////////
707 TObject* AliJet::Clone(const char* name) const
708 {
709 // Make a deep copy of the current object and provide the pointer to the copy.
710 // This memberfunction enables automatic creation of new objects of the
711 // correct type depending on the object type, a feature which may be very useful
712 // for containers when adding objects in case the container owns the objects.
713 // This feature allows e.g. AliVertex to store either AliJet objects or
714 // objects derived from AliJet via the AddJet memberfunction, provided
715 // these derived classes also have a proper Clone memberfunction. 
716
717  AliJet* jet=new AliJet(*this);
718  if (name)
719  {
720   if (strlen(name)) jet->SetName(name);
721  }
722  return jet;
723 }
724 ///////////////////////////////////////////////////////////////////////////