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 **************************************************************************/
18 ///////////////////////////////////////////////////////////////////////////
20 // Creation and investigation of a jet of particle tracks.
21 // An AliJet can be constructed by adding AliTracks.
23 // To provide maximal flexibility to the user, two modes of track storage
24 // are provided by means of the memberfunction SetTrackCopy().
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
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.
35 // Modifications made to the original tracks also affect the AliTrack objects
36 // which are stored in the AliJet.
38 // b) SetTrackCopy(1).
39 // Of every 'added' track a private copy will be made of which the pointer
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.
48 // See also the documentation provided for the memberfunction SetOwner().
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
57 // ... // code to fill the AliTrack data
64 // j2.SetTrackCopy(1);
65 // AliTrack* tx=new AliTrack();
66 // for (Int_t i=0; i<10; i++)
69 // ... // code to set momentum etc... of the track tx
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);
87 // Note : All quantities are in GeV, GeV/c or GeV/c**2
89 //--- Author: Nick van Eijndhoven 10-jul-1997 UU-SAP Utrecht
90 //- Modified: NvE $Date$ UU-SAP Utrecht
91 ///////////////////////////////////////////////////////////////////////////
94 #include "Riostream.h"
96 ClassImp(AliJet) // Class implementation to enable ROOT I/O
98 AliJet::AliJet() : TNamed(),Ali4Vector()
100 // Default constructor
101 // All variables initialised to 0
102 // Initial maximum number of tracks is set to the default value
107 ///////////////////////////////////////////////////////////////////////////
110 // Initialisation of pointers etc...
116 ///////////////////////////////////////////////////////////////////////////
117 AliJet::AliJet(Int_t n) : TNamed(),Ali4Vector()
119 // Create a jet to hold initially a maximum of n tracks
120 // All variables initialised to 0
130 cout << " *AliJet* Initial max. number of tracks entered : " << n << endl;
131 cout << " This is invalid. Default initial maximum will be used." << endl;
136 ///////////////////////////////////////////////////////////////////////////
139 // Default destructor
151 ///////////////////////////////////////////////////////////////////////////
152 void AliJet::SetOwner(Bool_t own)
154 // Set ownership of all added objects.
155 // The default parameter is own=kTRUE.
157 // Invokation of this memberfunction also sets all the copy modes
158 // (e.g. TrackCopy & co.) according to the value of own.
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.
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.
175 if (fTracks) fTracks->SetOwner(own);
178 ///////////////////////////////////////////////////////////////////////////
179 AliJet::AliJet(const AliJet& j) : TNamed(j),Ali4Vector(j)
186 fTrackCopy=j.fTrackCopy;
194 fTracks=new TObjArray(fNtmax);
195 if (fTrackCopy) fTracks->SetOwner();
198 for (Int_t i=1; i<=fNtrk; i++)
200 AliTrack* tx=j.GetTrack(i);
203 fTracks->Add(tx->Clone());
211 ///////////////////////////////////////////////////////////////////////////
212 void AliJet::SetNtinit(Int_t n)
214 // Set the initial maximum number of tracks for this jet
224 ///////////////////////////////////////////////////////////////////////////
227 // Reset all variables to 0
228 // The max. number of tracks is set to the initial value again
232 Double_t a[4]={0,0,0,0};
234 if (fNtinit > 0) SetNtinit(fNtinit);
236 ///////////////////////////////////////////////////////////////////////////
237 void AliJet::AddTrack(AliTrack& t)
239 // Add a track to the jet.
240 // In case the maximum number of tracks has been reached
241 // space will be extended to hold an additional amount of tracks as
242 // was initially reserved.
243 // See SetTrackCopy() to tailor the functionality of the stored structures.
247 // In case a private copy is made, this is performed via the Clone() memberfunction.
248 // All AliTrack and derived classes have the default TObject::Clone() memberfunction.
249 // However, derived classes generally contain an internal data structure which may
250 // include pointers to other objects. Therefore it is recommended to provide
251 // for all derived classes a specific copy constructor and override the default Clone()
252 // memberfunction using this copy constructor.
253 // An example for this may be seen from AliTrack.
255 // In case NO private copy is made, a check will be performed if this
256 // specific track is already present in the jet.
257 // If this is the case, no action is performed to prevent multiple
258 // additions of the same track.
263 ///////////////////////////////////////////////////////////////////////////
264 void AliJet::AddTrack(AliTrack& t,Int_t copy)
266 // Internal memberfunction to actually add a track to the jet.
267 // In case the maximum number of tracks has been reached
268 // space will be extended to hold an additional amount of tracks as
269 // was initially reserved.
271 // If copy=0 NO copy of the track will be made, irrespective of the setting
272 // of the TrackCopy flag.
273 // This allows a proper treatment of automatically generated connecting
274 // tracks between vertices.
276 // In case NO copy of the track is made, a check will be performed if this
277 // specific track is already present in the jet.
278 // If this is the case, no action is performed to prevent multiple
279 // additions of the same track.
282 // In case a private copy is made, this is performed via the Clone() memberfunction.
286 fTracks=new TObjArray(fNtmax);
287 if (fTrackCopy) fTracks->SetOwner();
289 else if (!fTrackCopy || !copy) // Check if this track is already present
291 for (Int_t i=0; i<fNtrk; i++)
293 AliTrack* tx=(AliTrack*)fTracks->At(i);
294 if (tx == &t) return;
298 if (fNtrk == fNtmax) // Check if maximum track number is reached
301 fTracks->Expand(fNtmax);
304 // Add the track to this jet
306 if (fTrackCopy && copy)
308 fTracks->Add(t.Clone());
315 (*this)+=(Ali4Vector&)t;
319 ///////////////////////////////////////////////////////////////////////////
320 void AliJet::Data(TString f,TString u)
322 // Provide jet information within the coordinate frame f
324 // The string argument "u" allows to choose between different angular units
325 // in case e.g. a spherical frame is selected.
326 // u = "rad" : angles provided in radians
327 // "deg" : angles provided in degrees
329 // The defaults are f="car" and u="rad".
331 const char* name=GetName();
332 const char* title=GetTitle();
334 cout << " *AliJet::Data*";
335 if (strlen(name)) cout << " Name : " << GetName();
336 if (strlen(title)) cout << " Title : " << GetTitle();
338 cout << " Id : " << fUserId << " Invmass : " << GetInvmass() << " Charge : " << fQ
339 << " Momentum : " << GetMomentum() << endl;
343 Ali4Vector::Data(f,u);
345 ///////////////////////////////////////////////////////////////////////////
346 void AliJet::List(TString f,TString u)
348 // Provide jet and primary track information within the coordinate frame f
350 // The string argument "u" allows to choose between different angular units
351 // in case e.g. a spherical frame is selected.
352 // u = "rad" : angles provided in radians
353 // "deg" : angles provided in degrees
355 // The defaults are f="car" and u="rad".
357 Data(f,u); // Information of the current jet
359 // The tracks of this jet
361 for (Int_t it=1; it<=fNtrk; it++)
366 cout << " ---Track no. " << it << endl;
372 cout << " *AliJet::List* Error : No track present." << endl;
376 ///////////////////////////////////////////////////////////////////////////
377 void AliJet::ListAll(TString f,TString u)
379 // Provide jet and prim.+sec. track information within the coordinate frame f
381 // The string argument "u" allows to choose between different angular units
382 // in case e.g. a spherical frame is selected.
383 // u = "rad" : angles provided in radians
384 // "deg" : angles provided in degrees
386 // The defaults are f="car" and u="rad".
388 Data(f,u); // Information of the current jet
390 // The tracks of this jet
392 for (Int_t it=1; it<=fNtrk; it++)
397 cout << " ---Track no. " << it << endl;
403 cout << " *AliJet::List* Error : No track present." << endl;
407 ///////////////////////////////////////////////////////////////////////////
408 Int_t AliJet::GetNtracks(Int_t idmode,Int_t chmode,Int_t pcode)
410 // Provide the number of user selected tracks in this jet based on the
411 // idmode, chmode and pcode selections as specified by the user.
412 // For specification of the selection parameters see GetTracks().
413 // The default parameters correspond to no selection, which implies
414 // that invokation of GetNtracks() just returns the total number of
415 // tracks registered in this jet.
417 // Note : In case certain selections are specified, this function
418 // invokes GetTracks(idmode,chmode,pcode) to determine the
419 // number of tracks corresponding to the selections.
420 // When the jet contains a large number of tracks, invokation
421 // of GetTracks(idmode,chmode,pcode) and subsequently invoking
422 // GetEntries() for the resulting TObjArray* might be slightly
426 if (idmode==0 && chmode==2 && pcode==0)
432 TObjArray* arr=GetTracks(idmode,chmode,pcode);
437 ///////////////////////////////////////////////////////////////////////////
438 Double_t AliJet::GetEnergy()
440 // Return the total energy of the jet
443 ///////////////////////////////////////////////////////////////////////////
444 Double_t AliJet::GetMomentum()
446 // Return the value of the total jet 3-momentum
447 // The error can be obtained by invoking GetResultError() after
448 // invokation of GetMomentum().
449 Double_t norm=fV.GetNorm();
450 fDresult=fV.GetResultError();
453 ///////////////////////////////////////////////////////////////////////////
454 Ali3Vector AliJet::Get3Momentum() const
456 // Return the the total jet 3-momentum
457 Ali3Vector p=Get3Vector();
460 ///////////////////////////////////////////////////////////////////////////
461 Double_t AliJet::GetInvmass()
463 // Return the invariant mass of the jet
464 Double_t m2=Dot(*this);
474 ///////////////////////////////////////////////////////////////////////////
475 Float_t AliJet::GetCharge() const
477 // Return the total charge of the jet
480 ///////////////////////////////////////////////////////////////////////////
481 AliTrack* AliJet::GetTrack(Int_t i) const
483 // Return the i-th track of this jet
485 if (!fTracks) return 0;
489 cout << " *AliJet*::GetTrack* Invalid argument i : " << i
490 << " Ntrk = " << fNtrk << endl;
495 return (AliTrack*)fTracks->At(i-1);
498 ///////////////////////////////////////////////////////////////////////////
499 AliTrack* AliJet::GetIdTrack(Int_t id) const
501 // Return the track with user identifier "id" of this jet
502 if (!fTracks) return 0;
505 for (Int_t i=0; i<fNtrk; i++)
507 tx=(AliTrack*)fTracks->At(i);
508 if (id == tx->GetId()) return tx;
510 return 0; // No matching id found
512 ///////////////////////////////////////////////////////////////////////////
513 TObjArray* AliJet::GetTracks(Int_t idmode,Int_t chmode,Int_t pcode)
515 // Provide references to user selected tracks based on the idmode, chmode
516 // and pcode selections as specified by the user.
518 // The following selection combinations are available :
519 // ----------------------------------------------------
520 // idmode = -1 ==> Select tracks with negative user identifier "id"
521 // 0 ==> No selection on user identifier
522 // 1 ==> Select tracks with positive user identifier "id"
524 // chmode = -1 ==> Select tracks with negative charge
525 // 0 ==> Select neutral tracks
526 // 1 ==> Select tracks with positive charge
527 // 2 ==> No selection on charge
528 // 3 ==> Select all charged tracks
530 // pcode = 0 ==> No selection on particle code
531 // X ==> Select tracks with particle code +X or -X
532 // This allows selection of both particles and anti-particles
533 // in case of PDG particle codes.
534 // Selection of either particles or anti-particles can be
535 // obtained in combination with the "chmode" selector.
539 // idmode=-1 chmode=0 pcode=0 : Selection of all neutral tracks with negative id.
540 // idmode=0 chmode=2 pcode=211 : Selection of all charged pions (PDG convention).
541 // idmode=0 chmode=1 pcode=321 : Selection of all positive kaons (PDG convention).
543 // The default values are idmode=0 chmode=2 pcode=0 (i.e. no selections applied).
547 // 1) In case the user has labeled simulated tracks with negative id and
548 // reconstructed tracks with positive id, this memberfunction provides
549 // easy access to either all simulated or reconstructed tracks.
550 // 2) Subsequent invokations of this memberfunction with e.g. chmode=-1 and chmode=1
551 // provides a convenient way to investigate particle pairs with opposite charge
552 // (e.g. for invariant mass analysis).
560 fSelected=new TObjArray();
563 if (!fTracks) return fSelected;
569 for (Int_t i=0; i<fNtrk; i++)
571 tx=(AliTrack*)fTracks->At(i);
574 code=tx->GetParticleCode();
575 if (pcode && abs(pcode)!=abs(code)) continue;
578 if (idmode==-1 && id>=0) continue;
579 if (idmode==1 && id<=0) continue;
582 if (chmode==-1 && q>=0) continue;
583 if (chmode==0 && fabs(q)>1e-10) continue;
584 if (chmode==1 && q<=0) continue;
585 if (chmode==3 && fabs(q)<1e-10) continue;
592 ///////////////////////////////////////////////////////////////////////////
593 void AliJet::ShowTracks(Int_t mode)
595 // Provide an overview of the available tracks.
596 // The argument mode determines the amount of information as follows :
597 // mode = 0 ==> Only printout of the number of tracks
598 // 1 ==> Provide a listing with 1 line of info for each track
600 // The default is mode=1.
602 Int_t ntk=GetNtracks();
607 cout << " There are " << ntk << " tracks available." << endl;
611 cout << " The following " << ntk << " tracks are available :" << endl;
612 for (Int_t i=1; i<=ntk; i++)
614 AliTrack* tx=GetTrack(i);
617 const char* name=tx->GetName();
618 const char* title=tx->GetTitle();
619 cout << " Track : " << i;
620 cout << " Id : " << tx->GetId();
621 cout << " Q : " << tx->GetCharge() << " m : " << tx->GetMass() << " p : " << tx->GetMomentum();
622 if (strlen(name)) cout << " Name : " << name;
623 if (strlen(title)) cout << " Title : " << title;
631 cout << " No tracks are present." << endl;
634 ///////////////////////////////////////////////////////////////////////////
635 Double_t AliJet::GetPt()
637 // Provide trans. momentum value w.r.t. z-axis.
638 // The error on the value can be obtained by GetResultError()
639 // after invokation of GetPt().
642 Double_t norm=v.GetNorm();
643 fDresult=v.GetResultError();
647 ///////////////////////////////////////////////////////////////////////////
648 Double_t AliJet::GetPl()
650 // Provide long. momentum value w.r.t. z-axis.
651 // Note : the returned value can also be negative.
652 // The error on the value can be obtained by GetResultError()
653 // after invokation of GetPl().
657 Double_t pl=v.GetNorm();
658 fDresult=v.GetResultError();
661 v.GetVector(a,"sph");
662 if (cos(a[1])<0) pl=-pl;
666 ///////////////////////////////////////////////////////////////////////////
667 Double_t AliJet::GetEt()
669 // Provide trans. energy value w.r.t. z-axis.
670 // The error on the value can be obtained by GetResultError()
671 // after invokation of GetEt().
672 Double_t et=GetScaTrans();
676 ///////////////////////////////////////////////////////////////////////////
677 Double_t AliJet::GetEl()
679 // Provide long. energy value w.r.t. z-axis.
680 // Note : the returned value can also be negative.
681 // The error on the value can be obtained by GetResultError()
682 // after invokation of GetEl().
683 Double_t el=GetScaLong();
687 ///////////////////////////////////////////////////////////////////////////
688 Double_t AliJet::GetMt()
690 // Provide transverse mass value w.r.t. z-axis.
691 // The error on the value can be obtained by GetResultError()
692 // after invokation of GetMt().
694 Double_t dpt=GetResultError();
695 Double_t m=GetInvmass();
696 Double_t dm=GetResultError();
698 Double_t mt=sqrt(pt*pt+m*m);
700 if (mt) dmt2=(pow((pt*dpt),2)+pow((m*dm),2))/(mt*mt);
705 ///////////////////////////////////////////////////////////////////////////
706 Double_t AliJet::GetRapidity()
708 // Provide rapidity value w.r.t. z-axis.
709 // The error on the value can be obtained by GetResultError()
710 // after invokation of GetRapidity().
711 // Note : Also GetPseudoRapidity() is available since this class is
712 // derived from Ali4Vector.
713 Double_t e=GetEnergy();
714 Double_t de=GetResultError();
716 Double_t dpl=GetResultError();
720 Double_t y=9999,dy2=0;
721 if (sum && dif) y=0.5*log(sum/dif);
723 if (sum*dif) dy2=(1./(sum*dif))*(pow((pl*de),2)+pow((e*dpl),2));
728 ///////////////////////////////////////////////////////////////////////////
729 void AliJet::SetTrackCopy(Int_t j)
731 // (De)activate the creation of private copies of the added tracks.
732 // j=0 ==> No private copies are made; pointers of original tracks are stored.
733 // j=1 ==> Private copies of the tracks are made and these pointers are stored.
735 // Note : Once the storage contains pointer(s) to AliTrack(s) one cannot
736 // change the TrackCopy mode anymore.
737 // To change the TrackCopy mode for an existing AliJet containing
738 // tracks one first has to invoke Reset().
747 cout << "*AliJet::SetTrackCopy* Invalid argument : " << j << endl;
752 cout << "*AliJet::SetTrackCopy* Storage already contained tracks."
753 << " ==> TrackCopy mode not changed." << endl;
756 ///////////////////////////////////////////////////////////////////////////
757 Int_t AliJet::GetTrackCopy() const
759 // Provide value of the TrackCopy mode.
760 // 0 ==> No private copies are made; pointers of original tracks are stored.
761 // 1 ==> Private copies of the tracks are made and these pointers are stored.
764 ///////////////////////////////////////////////////////////////////////////
765 void AliJet::SetId(Int_t id)
767 // Set a user defined identifier for this jet.
770 ///////////////////////////////////////////////////////////////////////////
771 Int_t AliJet::GetId() const
773 // Provide the user defined identifier of this jet.
776 ///////////////////////////////////////////////////////////////////////////
777 TObjArray* AliJet::SortTracks(Int_t mode,TObjArray* tracks)
779 // Order the references to an array of tracks by looping over the input array "tracks"
780 // and checking the value of a certain observable.
781 // The ordered array is returned as a TObjArray.
782 // In case tracks=0 (default), the registered tracks of the current jet are used.
783 // Note that the original track array is not modified.
784 // Via the "mode" argument the user can specify the observable to be checked upon
785 // and specify whether sorting should be performed in decreasing order (mode<0)
786 // or in increasing order (mode>0).
788 // The convention for the observable selection is the following :
789 // mode : 1 ==> Number of signals associated to the track
790 // 2 ==> Track energy
791 // 3 ==> Track momentum
792 // 4 ==> Mass of the track
793 // 5 ==> Transverse momentum of the track
794 // 6 ==> Longitudinal momentum of the track
795 // 7 ==> Transverse energy of the track
796 // 8 ==> Longitudinal energy of the track
797 // 9 ==> Transverse mass of the track
798 // 10 ==> Track rapidity
799 // 11 ==> Pseudo-rapidity of the track
801 // The default is mode=-1.
803 // Note : This sorting routine uses a common area in memory, which is used
804 // by various other sorting facilities as well.
805 // This means that the resulting sorted TObjArray may be overwritten
806 // when another sorting is invoked.
807 // To retain the sorted list of pointers, the user is advised to copy
808 // the pointers contained in the returned TObjArray into a private
809 // TObjArray instance.
817 if (!tracks) tracks=fTracks;
819 if (abs(mode)>11 || !tracks) return fSelected;
821 Int_t ntracks=tracks->GetEntries();
828 fSelected=new TObjArray(ntracks);
831 Double_t val1,val2; // Values of the observable to be tested upon
834 for (Int_t i=0; i<ntracks; i++) // Loop over all tracks of the array
836 AliTrack* tx=(AliTrack*)tracks->At(i);
840 if (nord == 0) // store the first track at the first ordered position
843 fSelected->AddAt(tx,nord-1);
847 for (Int_t j=0; j<=nord; j++) // put track in the right ordered position
849 if (j == nord) // track has smallest (mode<0) or largest (mode>0) observable value seen so far
852 fSelected->AddAt(tx,j); // add track at the end
853 break; // go for next track
859 val1=tx->GetNsignals();
860 val2=((AliTrack*)fSelected->At(j))->GetNsignals();
863 val1=tx->GetEnergy();
864 val2=((AliTrack*)fSelected->At(j))->GetEnergy();
867 val1=tx->GetMomentum();
868 val2=((AliTrack*)fSelected->At(j))->GetMomentum();
872 val2=((AliTrack*)fSelected->At(j))->GetMass();
876 val2=((AliTrack*)fSelected->At(j))->GetPt();
880 val2=((AliTrack*)fSelected->At(j))->GetPl();
884 val2=((AliTrack*)fSelected->At(j))->GetEt();
888 val2=((AliTrack*)fSelected->At(j))->GetEl();
892 val2=((AliTrack*)fSelected->At(j))->GetMt();
895 val1=tx->GetRapidity();
896 val2=((AliTrack*)fSelected->At(j))->GetRapidity();
899 val1=tx->GetPseudoRapidity();
900 val2=((AliTrack*)fSelected->At(j))->GetPseudoRapidity();
904 if (mode<0 && val1 < val2) continue;
905 if (mode>0 && val1 > val2) continue;
908 for (Int_t k=nord-1; k>j; k--) // create empty position
910 fSelected->AddAt(fSelected->At(k-1),k);
912 fSelected->AddAt(tx,j); // put track at empty position
913 break; // go for next track
918 ///////////////////////////////////////////////////////////////////////////
919 TObject* AliJet::Clone(const char* name) const
921 // Make a deep copy of the current object and provide the pointer to the copy.
922 // This memberfunction enables automatic creation of new objects of the
923 // correct type depending on the object type, a feature which may be very useful
924 // for containers when adding objects in case the container owns the objects.
925 // This feature allows e.g. AliVertex to store either AliJet objects or
926 // objects derived from AliJet via the AddJet memberfunction, provided
927 // these derived classes also have a proper Clone memberfunction.
929 AliJet* jet=new AliJet(*this);
932 if (strlen(name)) jet->SetName(name);
936 ///////////////////////////////////////////////////////////////////////////