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.14 2003/10/26 14:53:44 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 devices like AliCalorimeters.
23 // All objects which are derived from TObject can be regarded as a device.
25 // The basic functionality of AliEvent is identical to the one of AliVertex.
26 // So, an AliEvent may be used as the primary vertex with some additional
27 // functionality compared to AliVertex.
29 // To provide maximal flexibility to the user, the two modes of track/jet/vertex
30 // storage as described in AliJet and AliVertex can be used.
31 // In addition an identical structure is provided for the storage of devices like
32 // AliCalorimeter objects, which can be selected by means of the memberfunction
35 // a) SetDevCopy(0) (which is the default).
36 // Only the pointers of the 'added' devices are stored.
37 // This mode is typically used by making studies based on a fixed set
38 // of devices which stays under user control or is kept on an external
40 // In this way the AliEvent just represents a 'logical structure' for the
44 // Modifications made to the original devices also affect the device
45 // objects which are stored in the AliEvent.
48 // Of every 'added' device a private copy will be made of which the pointer
50 // In this way the AliEvent represents an entity on its own and modifications
51 // made to the original calorimeters do not affect the AliCalorimeter objects
52 // which are stored in the AliEvent.
53 // This mode will allow 'adding' many different devices into an AliEvent by
54 // creating only one device instance in the main programme and using the
55 // Reset() and parameter setting memberfunctions of the object representing the device.
58 // The copy is made using the Clone() memberfunction.
59 // All devices (i.e. classes derived from TObject) have the default TObject::Clone()
61 // However, devices generally contain an internal (signal) data structure
62 // which may include pointers to other objects. Therefore it is recommended to provide
63 // for all devices a specific copy constructor and override the default Clone()
64 // memberfunction using this copy constructor.
65 // An example for this may be seen from AliCalorimeter.
67 // See also the documentation provided for the memberfunction SetOwner().
69 // Coding example to make an event consisting of a primary vertex,
70 // 2 secondary vertices and a calorimeter.
71 // --------------------------------------------------------------
72 // vp contains the tracks 1,2,3 and 4 (primary vertex)
73 // v1 contains the tracks 5,6 and 7 (sec. vertex)
74 // v2 contains the jets 1 and 2 (sec. vertex)
78 // Specify the event object as the repository of all objects
79 // for the event building and physics analysis.
82 // evt.SetTrackCopy(1);
84 // Fill the event structure with the basic objects
86 // AliCalorimeter emcal;
88 // ... // code to fill the calorimeter data
91 // evt.AddDevice(emcal);
93 // AliTrack* tx=new AliTrack();
94 // for (Int_t i=0; i<10; i++)
97 // ... // code to fill the track data
109 // Build the event structure (vertices, jets, ...) for physics analysis
110 // based on the basic objects from the event repository.
113 // for (Int_t i=0; i<evt.GetNtracks(); i++)
115 // tx=evt.GetTrack(i);
117 // ... // code to fill the jet data
122 // tx=evt.GetTrack(1);
124 // tx=evt.GetTrack(2);
126 // tx=evt.GetTrack(3);
128 // tx=evt.GetTrack(4);
131 // Float_t rp[3]={2.4,0.1,-8.5};
132 // vp.SetPosition(rp,"car");
135 // tx=evt.GetTrack(5);
137 // tx=evt.GetTrack(6);
139 // tx=evt.GetTrack(7);
142 // Float_t r1[3]={1.6,-3.2,5.7};
143 // v1.SetPosition(r1,"car");
151 // Float_t r2[3]={6.2,4.8,1.3};
152 // v2.SetPosition(r2,"car");
154 // Specify the vertices v1 and v2 as secondary vertices of the primary
156 // vp.SetVertexCopy(1);
160 // Enter the physics structures into the event
161 // evt.SetVertexCopy(1);
162 // evt.AddVertex(vp,0);
164 // The jets j1 and j2 are already available via sec. vertex v2,
165 // but can be made available also from the event itself if desired.
176 // Float_t etot=evt.GetEnergy();
177 // Ali3Vector ptot=evt.Get3Momentum();
179 // evt.GetPosition(loc,"sph");
180 // AliPosition r=v1.GetPosition();
182 // Int_t nt=v2.GetNtracks();
183 // AliTrack* tv=v2.GetTrack(1); // Access track number 1 of Vertex v2
187 // Int_t nv=evt.GetNvtx();
188 // AliVertex* vx=evt.GetVertex(1); // Access primary vertex
189 // Float_t e=vx->GetEnergy();
191 // Float_t M=evt.GetInvmass();
193 // Reconstruct the event from scratch
196 // evt.SetNvmax(25); // Increase initial no. of sec. vertices
198 // ... // code to create tracks etc...
201 // Note : All quantities are in GeV, GeV/c or GeV/c**2
203 //--- Author: Nick van Eijndhoven 27-may-2001 UU-SAP Utrecht
204 //- Modified: NvE $Date: 2003/10/26 14:53:44 $ UU-SAP Utrecht
205 ///////////////////////////////////////////////////////////////////////////
207 #include "AliEvent.h"
208 #include "Riostream.h"
210 ClassImp(AliEvent) // Class implementation to enable ROOT I/O
212 AliEvent::AliEvent() : AliVertex()
214 // Default constructor.
215 // All variables initialised to default values.
231 ///////////////////////////////////////////////////////////////////////////
232 AliEvent::AliEvent(Int_t n) : AliVertex(n)
234 // Create an event to hold initially a maximum of n tracks
235 // All variables initialised to default values
238 cout << " *** This AliVertex initialisation was invoked via the AliEvent ctor." << endl;
255 ///////////////////////////////////////////////////////////////////////////
256 AliEvent::~AliEvent()
258 // Default destructor
265 ///////////////////////////////////////////////////////////////////////////
266 AliEvent::AliEvent(AliEvent& evt) : AliVertex(evt)
269 fDaytime=evt.fDaytime;
274 fPnucProj=evt.fPnucProj;
278 fPnucTarg=evt.fPnucTarg;
280 fDevCopy=evt.fDevCopy;
283 Int_t ndevs=evt.GetNdevices();
286 fDevices=new TObjArray(ndevs);
287 if (fDevCopy) fDevices->SetOwner();
288 for (Int_t i=1; i<=ndevs; i++)
290 TObject* dev=evt.GetDevice(i);
295 fDevices->Add(dev->Clone());
305 ///////////////////////////////////////////////////////////////////////////
306 void AliEvent::Reset()
308 // Reset all variables to default values
309 // The max. number of tracks is set to the initial value again
310 // The max. number of vertices is set to the default value again
311 // Note : The CalCopy mode is maintained as it was set by the user before.
334 ///////////////////////////////////////////////////////////////////////////
335 void AliEvent::SetOwner(Bool_t own)
337 // Set ownership of all added objects.
338 // The default parameter is own=kTRUE.
340 // Invokation of this memberfunction also sets all the copy modes
341 // (e.g. TrackCopy & co.) according to the value of own.
343 // This function (with own=kTRUE) is particularly useful when reading data
344 // from a tree/file, since Reset() will then actually remove all the
345 // added objects from memory irrespective of the copy mode settings
346 // during the tree/file creation process. In this way it provides a nice way
347 // of preventing possible memory leaks in the reading/analysis process.
349 // In addition this memberfunction can also be used as a shortcut to set all
350 // copy modes in one go during a tree/file creation process.
351 // However, in this case the user has to take care to only set/change the
352 // ownership (and copy mode) for empty objects (e.g. newly created objects
353 // or after invokation of the Reset() memberfunction) otherwise it will
354 // very likely result in inconsistent destructor behaviour.
358 if (fDevices) fDevices->SetOwner(own);
361 AliVertex::SetOwner(own);
363 ///////////////////////////////////////////////////////////////////////////
364 void AliEvent::SetDayTime(TTimeStamp& stamp)
366 // Set the date and time stamp for this event.
367 // An exact copy of the entered date/time stamp will be saved with an
368 // accuracy of 1 second.
371 ///////////////////////////////////////////////////////////////////////////
372 void AliEvent::SetDayTime(TDatime& stamp)
374 // Set the date and time stamp for this event.
375 // The entered date/time will be interpreted as being the local date/time
376 // and the accuracy is 1 second.
377 // This function with the TDatime argument is mainly kept for backward
378 // compatibility reasons. It is recommended to use the corresponding
379 // function with the TTimeStamp argument.
381 TTimeStamp ts(stamp.GetDate(),stamp.GetTime(),0,kFALSE);
384 ///////////////////////////////////////////////////////////////////////////
385 void AliEvent::SetRunNumber(Int_t run)
387 // Set the run number for this event
390 ///////////////////////////////////////////////////////////////////////////
391 void AliEvent::SetEventNumber(Int_t evt)
393 // Set the event number for this event
396 ///////////////////////////////////////////////////////////////////////////
397 TTimeStamp AliEvent::GetDayTime()
399 // Provide the date and time stamp for this event
402 ///////////////////////////////////////////////////////////////////////////
403 Int_t AliEvent::GetRunNumber()
405 // Provide the run number for this event
408 ///////////////////////////////////////////////////////////////////////////
409 Int_t AliEvent::GetEventNumber()
411 // Provide the event number for this event
414 ///////////////////////////////////////////////////////////////////////////
415 void AliEvent::SetProjectile(Int_t a,Int_t z,Double_t pnuc,Int_t id)
417 // Set the projectile A, Z, momentum per nucleon and user defined particle ID.
418 // By default the particle ID is set to zero.
424 ///////////////////////////////////////////////////////////////////////////
425 Int_t AliEvent::GetProjectileA()
427 // Provide the projectile A value.
430 ///////////////////////////////////////////////////////////////////////////
431 Int_t AliEvent::GetProjectileZ()
433 // Provide the projectile Z value.
436 ///////////////////////////////////////////////////////////////////////////
437 Double_t AliEvent::GetProjectilePnuc()
439 // Provide the projectile momentum value per nucleon.
442 ///////////////////////////////////////////////////////////////////////////
443 Int_t AliEvent::GetProjectileId()
445 // Provide the user defined particle ID of the projectile.
448 ///////////////////////////////////////////////////////////////////////////
449 void AliEvent::SetTarget(Int_t a,Int_t z,Double_t pnuc,Int_t id)
451 // Set the target A, Z, momentum per nucleon and user defined particle ID.
452 // By default the particle ID is set to zero.
458 ///////////////////////////////////////////////////////////////////////////
459 Int_t AliEvent::GetTargetA()
461 // Provide the target A value.
464 ///////////////////////////////////////////////////////////////////////////
465 Int_t AliEvent::GetTargetZ()
467 // Provide the target Z value.
470 ///////////////////////////////////////////////////////////////////////////
471 Double_t AliEvent::GetTargetPnuc()
473 // Provide the target momentum value per nucleon.
476 ///////////////////////////////////////////////////////////////////////////
477 Int_t AliEvent::GetTargetId()
479 // Provide the user defined particle ID of the target.
482 ///////////////////////////////////////////////////////////////////////////
483 void AliEvent::HeaderData()
485 // Provide event header information
486 cout << " *" << ClassName() << "::Data* Name : " << GetName()
487 << " Title : " << GetTitle() << endl;
488 cout << " " << fDaytime.AsString() << endl;
489 cout << " Run : " << fRun << " Event : " << fEvent << endl;
493 ///////////////////////////////////////////////////////////////////////////
494 void AliEvent::Data(TString f)
496 // Provide event information within the coordinate frame f
500 ///////////////////////////////////////////////////////////////////////////
501 Int_t AliEvent::GetNdevices()
503 // Provide the number of stored devices
505 if (fDevices) ndevs=fDevices->GetEntries();
508 ///////////////////////////////////////////////////////////////////////////
509 void AliEvent::AddDevice(TObject& d)
511 // Add a device to the event.
514 // In case a private copy is made, this is performed via the Clone() memberfunction.
515 // All devices (i.e. classes derived from TObject) have the default TObject::Clone()
517 // However, devices generally contain an internal (signal) data structure
518 // which may include pointers to other objects. Therefore it is recommended to provide
519 // for all devices a specific copy constructor and override the default Clone()
520 // memberfunction using this copy constructor.
521 // An example for this may be seen from AliCalorimeter.
525 fDevices=new TObjArray();
526 if (fDevCopy) fDevices->SetOwner();
529 // Add the device to this event
532 fDevices->Add(d.Clone());
539 ///////////////////////////////////////////////////////////////////////////
540 void AliEvent::SetDevCopy(Int_t j)
542 // (De)activate the creation of private copies of the added devices.
543 // j=0 ==> No private copies are made; pointers of original devices are stored.
544 // j=1 ==> Private copies of the devices are made and these pointers are stored.
548 // In case a private copy is made, this is performed via the Clone() memberfunction.
549 // All devices (i.e. classes derived from TObject) have the default TObject::Clone()
551 // However, devices generally contain an internal (signal) data structure
552 // which may include pointers to other objects. Therefore it is recommended to provide
553 // for all devices a specific copy constructor and override the default Clone()
554 // memberfunction using this copy constructor.
555 // An example for this may be seen from AliCalorimeter.
557 // Once the storage contains pointer(s) to device(s) one cannot
558 // change the DevCopy mode anymore.
559 // To change the DevCopy mode for an existing AliEvent containing
560 // devices one first has to invoke Reset().
570 cout << " *" << ClassName() << "::SetDevCopy* Invalid argument : " << j << endl;
575 cout << " *" << ClassName() << "::SetDevCopy* Storage already contained devices."
576 << " ==> DevCopy mode not changed." << endl;
579 ///////////////////////////////////////////////////////////////////////////
580 Int_t AliEvent::GetDevCopy()
582 // Provide value of the DevCopy mode.
583 // 0 ==> No private copies are made; pointers of original devices are stored.
584 // 1 ==> Private copies of the devices are made and these pointers are stored.
587 // In case a private copy is made, this is performed via the Clone() memberfunction.
588 // All devices (i.e. classes derived from TObject) have the default TObject::Clone()
590 // However, devices generally contain an internal (signal) data structure
591 // which may include pointers to other objects. Therefore it is recommended to provide
592 // for all devices a specific copy constructor and override the default Clone()
593 // memberfunction using this copy constructor.
594 // An example for this may be seen from AliCalorimeter.
598 ///////////////////////////////////////////////////////////////////////////
599 TObject* AliEvent::GetDevice(Int_t i)
601 // Return the i-th device of this event.
602 // The first device corresponds to i=1.
606 cout << " *AliEvent::GetDevice* No devices present." << endl;
611 Int_t ndevs=GetNdevices();
614 cout << " *" << ClassName() << "::GetDevice* Invalid argument i : " << i
615 << " ndevs = " << ndevs << endl;
620 return fDevices->At(i-1);
624 ///////////////////////////////////////////////////////////////////////////
625 TObject* AliEvent::GetDevice(TString name)
627 // Return the device with name tag "name"
630 cout << " *" << ClassName() << "::GetDevice* No devices present." << endl;
636 Int_t ndevs=GetNdevices();
637 for (Int_t i=0; i<ndevs; i++)
639 TObject* dev=fDevices->At(i);
643 if (s == name) return dev;
647 return 0; // No matching name found
650 ///////////////////////////////////////////////////////////////////////////
651 void AliEvent::ShowDevices()
653 // Provide an overview of the available devices.
654 Int_t ndevs=GetNdevices();
657 cout << " The following " << ndevs << " devices are available :" << endl;
658 for (Int_t i=1; i<=ndevs; i++)
660 TObject* dev=GetDevice(i);
663 cout << " Device number : " << i
664 << " Class : " << dev->ClassName()
665 << " Name : " << dev->GetName() << endl;
671 cout << " No devices present for this event." << endl;
674 ///////////////////////////////////////////////////////////////////////////