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 **************************************************************************/
16 // $Id: AliEvent.cxx,v 1.9 2003/01/09 16:06:35 nick Exp $
18 ///////////////////////////////////////////////////////////////////////////
20 // Creation and investigation of an Alice physics event.
21 // An AliEvent can be constructed by adding AliTracks, Alivertices, AliJets
22 // and/or AliCalorimeters.
24 // The basic functionality of AliEvent is identical to the one of AliVertex.
25 // So, an AliEvent may be used as the primary vertex with some additional
26 // functionality compared to AliVertex.
28 // To provide maximal flexibility to the user, the two modes of track/jet/vertex
29 // storage as described in AliJet and AliVertex can be used.
30 // In addition an identical structure is provided for the storage of AliCalorimeter
31 // objects, which can be selected by means of the memberfunction SetCalCopy().
33 // a) SetCalCopy(0) (which is the default).
34 // Only the pointers of the 'added' calorimeters are stored.
35 // This mode is typically used by making cal. studies based on a fixed set
36 // of calorimeters which stays under user control or is kept on an external
38 // In this way the AliEvent just represents a 'logical structure' for the
42 // Modifications made to the original calorimeters also affect the AliCalorimeter
43 // objects which are stored in the AliEvent.
46 // Of every 'added' calorimeter a private copy will be made of which the pointer
48 // In this way the AliEvent represents an entity on its own and modifications
49 // made to the original calorimeters do not affect the AliCalorimeter objects
50 // which are stored in the AliEvent.
51 // This mode will allow 'adding' many different AliCalorimeters into an AliEvent by
52 // creating only one AliCalorimeter instance in the main programme and using the
53 // AliCalorimeter::Reset() and AliCalorimeter parameter setting memberfunctions.
55 // See also the documentation provided for the memberfunction SetOwner().
57 // Coding example to make an event consisting of a primary vertex,
58 // 2 secondary vertices and a calorimeter.
59 // --------------------------------------------------------------
60 // vp contains the tracks 1,2,3 and 4 (primary vertex)
61 // v1 contains the tracks 5,6 and 7 (sec. vertex)
62 // v2 contains the jets 1 and 2 (sec. vertex)
66 // Specify the event object as the repository of all objects
67 // for the event building and physics analysis.
70 // evt.SetTrackCopy(1);
72 // Fill the event structure with the basic objects
74 // AliCalorimeter emcal;
76 // ... // code to fill the calorimeter data
79 // evt.AddCalorimeter(emcal);
81 // AliTrack* tx=new AliTrack();
82 // for (Int_t i=0; i<10; i++)
85 // ... // code to fill the track data
97 // Build the event structure (vertices, jets, ...) for physics analysis
98 // based on the basic objects from the event repository.
101 // for (Int_t i=0; i<evt.GetNtracks(); i++)
103 // tx=evt.GetTrack(i);
105 // ... // code to fill the jet data
110 // tx=evt.GetTrack(1);
112 // tx=evt.GetTrack(2);
114 // tx=evt.GetTrack(3);
116 // tx=evt.GetTrack(4);
119 // Float_t rp[3]={2.4,0.1,-8.5};
120 // vp.SetPosition(rp,"car");
123 // tx=evt.GetTrack(5);
125 // tx=evt.GetTrack(6);
127 // tx=evt.GetTrack(7);
130 // Float_t r1[3]={1.6,-3.2,5.7};
131 // v1.SetPosition(r1,"car");
139 // Float_t r2[3]={6.2,4.8,1.3};
140 // v2.SetPosition(r2,"car");
142 // Specify the vertices v1 and v2 as secondary vertices of the primary
144 // vp.SetVertexCopy(1);
148 // Enter the physics structures into the event
149 // evt.SetVertexCopy(1);
150 // evt.AddVertex(vp,0);
152 // The jets j1 and j2 are already available via sec. vertex v2,
153 // but can be made available also from the event itself if desired.
164 // Float_t etot=evt.GetEnergy();
165 // Ali3Vector ptot=evt.Get3Momentum();
167 // evt.GetPosition(loc,"sph");
168 // AliPosition r=v1.GetPosition();
170 // Int_t nt=v2.GetNtracks();
171 // AliTrack* tv=v2.GetTrack(1); // Access track number 1 of Vertex v2
175 // Int_t nv=evt.GetNvtx();
176 // AliVertex* vx=evt.GetVertex(1); // Access primary vertex
177 // Float_t e=vx->GetEnergy();
179 // Float_t M=evt.GetInvmass();
181 // Reconstruct the event from scratch
184 // evt.SetNvmax(25); // Increase initial no. of sec. vertices
186 // ... // code to create tracks etc...
189 // Note : All quantities are in GeV, GeV/c or GeV/c**2
191 //--- Author: Nick van Eijndhoven 27-may-2001 UU-SAP Utrecht
192 //- Modified: NvE $Date: 2003/01/09 16:06:35 $ UU-SAP Utrecht
193 ///////////////////////////////////////////////////////////////////////////
195 #include "AliEvent.h"
197 ClassImp(AliEvent) // Class implementation to enable ROOT I/O
201 // Default constructor.
202 // All variables initialised to default values.
218 ///////////////////////////////////////////////////////////////////////////
219 AliEvent::AliEvent(Int_t n): AliVertex(n)
221 // Create an event to hold initially a maximum of n tracks
222 // All variables initialised to default values
238 ///////////////////////////////////////////////////////////////////////////
239 AliEvent::~AliEvent()
241 // Default destructor
244 delete fCalorimeters;
248 ///////////////////////////////////////////////////////////////////////////
249 void AliEvent::Reset()
251 // Reset all variables to default values
252 // The max. number of tracks is set to the initial value again
253 // The max. number of vertices is set to the default value again
254 // Note : The CalCopy mode is maintained as it was set by the user before.
270 delete fCalorimeters;
276 ///////////////////////////////////////////////////////////////////////////
277 void AliEvent::SetOwner(Bool_t own)
279 // Set ownership of all added objects.
280 // The default parameter is own=kTRUE.
282 // Invokation of this memberfunction also sets all the copy modes
283 // (e.g. TrackCopy & co.) according to the value of own.
285 // This function (with own=kTRUE) is particularly useful when reading data
286 // from a tree/file, since Reset() will then actually remove all the
287 // added objects from memory irrespective of the copy mode settings
288 // during the tree/file creation process. In this way it provides a nice way
289 // of preventing possible memory leaks in the reading/analysis process.
291 // In addition this memberfunction can also be used as a shortcut to set all
292 // copy modes in one go during a tree/file creation process.
293 // However, in this case the user has to take care to only set/change the
294 // ownership (and copy mode) for empty objects (e.g. newly created objects
295 // or after invokation of the Reset() memberfunction) otherwise it will
296 // very likely result in inconsistent destructor behaviour.
300 if (fCalorimeters) fCalorimeters->SetOwner(own);
303 AliVertex::SetOwner(own);
305 ///////////////////////////////////////////////////////////////////////////
306 void AliEvent::SetDayTime(TDatime& stamp)
308 // Set the date and time stamp for this event
311 ///////////////////////////////////////////////////////////////////////////
312 void AliEvent::SetRunNumber(Int_t run)
314 // Set the run number for this event
317 ///////////////////////////////////////////////////////////////////////////
318 void AliEvent::SetEventNumber(Int_t evt)
320 // Set the event number for this event
323 ///////////////////////////////////////////////////////////////////////////
324 TDatime AliEvent::GetDayTime()
326 // Provide the date and time stamp for this event
329 ///////////////////////////////////////////////////////////////////////////
330 Int_t AliEvent::GetRunNumber()
332 // Provide the run number for this event
335 ///////////////////////////////////////////////////////////////////////////
336 Int_t AliEvent::GetEventNumber()
338 // Provide the event number for this event
341 ///////////////////////////////////////////////////////////////////////////
342 void AliEvent::SetProjectile(Int_t a,Int_t z,Double_t pnuc,Int_t id)
344 // Set the projectile A, Z, momentum per nucleon and user defined particle ID.
345 // By default the particle ID is set to zero.
351 ///////////////////////////////////////////////////////////////////////////
352 Int_t AliEvent::GetProjectileA()
354 // Provide the projectile A value.
357 ///////////////////////////////////////////////////////////////////////////
358 Int_t AliEvent::GetProjectileZ()
360 // Provide the projectile Z value.
363 ///////////////////////////////////////////////////////////////////////////
364 Double_t AliEvent::GetProjectilePnuc()
366 // Provide the projectile momentum value per nucleon.
369 ///////////////////////////////////////////////////////////////////////////
370 Int_t AliEvent::GetProjectileId()
372 // Provide the user defined particle ID of the projectile.
375 ///////////////////////////////////////////////////////////////////////////
376 void AliEvent::SetTarget(Int_t a,Int_t z,Double_t pnuc,Int_t id)
378 // Set the target A, Z, momentum per nucleon and user defined particle ID.
379 // By default the particle ID is set to zero.
385 ///////////////////////////////////////////////////////////////////////////
386 Int_t AliEvent::GetTargetA()
388 // Provide the target A value.
391 ///////////////////////////////////////////////////////////////////////////
392 Int_t AliEvent::GetTargetZ()
394 // Provide the target Z value.
397 ///////////////////////////////////////////////////////////////////////////
398 Double_t AliEvent::GetTargetPnuc()
400 // Provide the target momentum value per nucleon.
403 ///////////////////////////////////////////////////////////////////////////
404 Int_t AliEvent::GetTargetId()
406 // Provide the user defined particle ID of the target.
409 ///////////////////////////////////////////////////////////////////////////
410 void AliEvent::HeaderData()
412 // Provide event header information
413 Int_t date=fDaytime.GetDate();
414 Int_t time=fDaytime.GetTime();
416 Int_t year=date/10000;
417 Int_t month=(date%10000)/100;
420 Int_t mm=(time%10000)/100;
423 char* c[12]={"jan","feb","mar","apr","may","jun",
424 "jul","aug","sep","oct","nov","dec"};
426 cout << " *AliEvent::Data* Run : " << fRun << " Event : " << fEvent;
428 cout << " Date : " << setw(2) << day << "-" << c[month-1] << "-" << year
429 << " Time : " << setw(2) << hh << ":" << setw(2) << mm << ":" << setw(2) << ss;
431 cout << " Ncalorimeters : " << fNcals << endl;
433 ///////////////////////////////////////////////////////////////////////////
434 void AliEvent::Data(TString f)
436 // Provide event information within the coordinate frame f
440 ///////////////////////////////////////////////////////////////////////////
441 Int_t AliEvent::GetNcalorimeters()
443 // Provide the number of stored calorimeter systems
446 ///////////////////////////////////////////////////////////////////////////
447 void AliEvent::AddCalorimeter(AliCalorimeter& c)
449 // Add a calorimeter system to the event
452 fCalorimeters=new TObjArray();
453 if (fCalCopy) fCalorimeters->SetOwner();
456 // Add the calorimeter system to this event
460 fCalorimeters->AddLast((AliCalorimeter*)c.Clone());
464 fCalorimeters->AddLast(&c);
467 ///////////////////////////////////////////////////////////////////////////
468 void AliEvent::SetCalCopy(Int_t j)
470 // (De)activate the creation of private copies of the added calorimeters.
471 // j=0 ==> No private copies are made; pointers of original cals. are stored.
472 // j=1 ==> Private copies of the cals. are made and these pointers are stored.
474 // Note : Once the storage contains pointer(s) to AliCalorimeter(s) one cannot
475 // change the CalCopy mode anymore.
476 // To change the CalCopy mode for an existing AliEvent containing
477 // calorimeters one first has to invoke Reset().
486 cout << "*AliEvent::SetCalCopy* Invalid argument : " << j << endl;
491 cout << "*AliEvent::SetCalCopy* Storage already contained calorimeters."
492 << " ==> CalCopy mode not changed." << endl;
495 ///////////////////////////////////////////////////////////////////////////
496 Int_t AliEvent::GetCalCopy()
498 // Provide value of the CalCopy mode.
499 // 0 ==> No private copies are made; pointers of original cals. are stored.
500 // 1 ==> Private copies of the cals. are made and these pointers are stored.
503 ///////////////////////////////////////////////////////////////////////////
504 AliCalorimeter* AliEvent::GetCalorimeter(Int_t i)
506 // Return the i-th calorimeter of this event
509 cout << " *AliEvent::GetCalorimeter* No calorimeters present." << endl;
514 if (i<=0 || i>fNcals)
516 cout << " *AliEvent::GetCalorimeter* Invalid argument i : " << i
517 << " Ncals = " << fNcals << endl;
522 return (AliCalorimeter*)fCalorimeters->At(i-1);
526 ///////////////////////////////////////////////////////////////////////////
527 AliCalorimeter* AliEvent::GetCalorimeter(TString name)
529 // Return the calorimeter with name tag "name"
532 cout << " *AliEvent::GetCalorimeter* No calorimeters present." << endl;
539 for (Int_t i=0; i<fNcals; i++)
541 cx=(AliCalorimeter*)fCalorimeters->At(i);
545 if (s == name) return cx;
549 return 0; // No matching name found
552 ///////////////////////////////////////////////////////////////////////////