]> git.uio.no Git - u/mrichter/AliRoot.git/blob - STEER/STEER/AliGenerator.h
DA: Put back the DA rpm description removed by the Doxygen documentation
[u/mrichter/AliRoot.git] / STEER / STEER / AliGenerator.h
1 #ifndef ALIGENERATOR_H
2 #define ALIGENERATOR_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7
8 ///////////////////////////////////////////////////////////
9 //                                                       //
10 //  Class to generate the particles for the MC           //
11 //  The base class is empty                              //
12 //                                                       //
13 ///////////////////////////////////////////////////////////
14
15 #include <TArrayF.h>
16 #include <TLorentzVector.h>
17 #include <TMCProcess.h>
18
19 #include "AliRndm.h"
20
21 class AliVertexGenerator;
22 class AliCollisionGeometry;
23 class AliGenEventHeader;
24 class AliStack;
25 class TGenerator;
26
27
28
29 typedef enum { kNoSmear, kPerEvent, kPerTrack }  VertexSmear_t;
30 typedef enum { kExternal, kInternal, kContainer} VertexSource_t;
31
32
33 class AliGenerator : public TNamed, public AliRndm
34 {
35
36  public:
37
38     AliGenerator();
39     AliGenerator(Int_t npart);
40     virtual ~AliGenerator();
41     virtual void Init();
42     virtual void SetOrigin(Float_t ox, Float_t oy, Float_t oz);
43     virtual void SetOrigin(const TLorentzVector &o);
44     virtual void SetSigma(Float_t sx, Float_t sy, Float_t sz);
45     virtual void SetSigmaZ(Float_t sz) {fOsigma[2] = sz;}
46     virtual void SetMomentumRange(Float_t pmin=0, Float_t pmax=1.e10);
47     virtual void SetPtRange(Float_t ptmin=0, Float_t ptmax=1.e10);
48     virtual void SetPhiRange(Float_t phimin = 0., Float_t phimax = 360.);
49     virtual void SetYRange(Float_t ymin=-100, Float_t ymax=100);
50     virtual void SetVRange(Float_t vxmin, Float_t vxmax,
51                            Float_t vymin, Float_t vymax,
52                            Float_t vzmin, Float_t vzmax);
53     virtual void SetNumberParticles(Int_t npart=100) {fNpart=npart;}
54     virtual Int_t NumberParticles() const {return fNpart;}
55     virtual void SetThetaRange(Float_t thetamin=0, Float_t thetamax=180);
56     virtual void GenerateN(Int_t ntimes);
57     virtual void Generate()=0;
58     virtual void SetParentWeight(Float_t wgt) {fParentWeight=wgt;}
59     virtual void SetChildWeight(Float_t wgt)  {fChildWeight=wgt;}    
60     virtual void SetAnalog(Int_t flag=1) {fAnalog=flag;}        
61     virtual void SetVertexSmear(VertexSmear_t smear) {fVertexSmear = smear;}
62     virtual void SetCutVertexZ(Float_t cut=999999.) {fCutVertexZ = cut;}
63     virtual void SetVertexSource(VertexSource_t source = kInternal) {fVertexSource = source;}
64     virtual void SetVertex(Float_t vx, Float_t vy, Float_t vz, Float_t t = 0)
65     {fVertex[0] = vx; fVertex[1] = vy; fVertex[2] = vz; fTime = t;}
66     void SetVertexGenerator(AliVertexGenerator* vertexGenerator)
67       {fVertexGenerator = vertexGenerator; fVertexSource = kExternal; fVertexSmear = kPerEvent;}
68     void SetPileUpTimeWindow(Float_t pileUpTimeW) {fPileUpTimeWindow = pileUpTimeW;}
69     virtual void SetTime(Float_t time)
70         {fTime = time;}
71     virtual void SetTimeOrigin(Float_t timeorig)
72         {fTimeOrigin = timeorig;}
73     
74     virtual void SetTrackingFlag(Int_t flag=1) {fTrackIt=flag;}
75     void Vertex();
76     void VertexExternal();
77     virtual void VertexInternal();
78     virtual void FinishRun();
79     virtual void SetMC(TGenerator *theMC) {fMCEvGen =theMC;}
80     virtual TGenerator* GetMC() const {return fMCEvGen;}
81     virtual void AddHeader(AliGenEventHeader* /*header*/) {;}
82     virtual void SetContainer(AliGenerator* container) {fContainer = container;}
83     virtual void SetEventPlane(Float_t evPlane) {fEvPlane = evPlane; }
84
85   // Getters
86
87     virtual void GetOrigin(Float_t &ox, Float_t &oy, Float_t &oz) const
88         {ox=fOrigin.At(0);oy=fOrigin.At(1);oz=fOrigin.At(2);}
89     virtual void GetOrigin(TLorentzVector &o) const
90         {o[0]=fOrigin.At(0);o[1]=fOrigin.At(1);o[2]=fOrigin.At(2);o[3]=0;}
91   // Stack 
92     void SetStack (AliStack *stack) {fStack = stack;}
93     AliStack* GetStack(){return fStack;}
94   // Collision Geometry
95     virtual Bool_t ProvidesCollisionGeometry() const {return kFALSE;}
96     virtual Bool_t NeedsCollisionGeometry()    const {return kFALSE;}    
97     virtual AliCollisionGeometry* CollisionGeometry() const {return fCollisionGeometry;}
98     virtual void SetCollisionGeometry(AliCollisionGeometry* geom) {fCollisionGeometry = geom;}
99
100     virtual Float_t GetEnergyCMS() const { return fEnergyCMS; }
101     virtual void    SetEnergyCMS(Float_t energy = 0) { fEnergyCMS = energy; }
102     virtual void    GetProjectile(TString& tar, Int_t& a, Int_t& z) const
103     {tar = fProjectile; a = fAProjectile; z = fZProjectile;}    
104     virtual void    GetTarget(TString& tar, Int_t& a, Int_t& z) const
105     {tar = fTarget; a = fATarget; z = fZTarget;}    
106     virtual void    SetProjectile(TString proj="", Int_t a = 0, Int_t z = 0)
107         {fProjectile = proj; fAProjectile = a; fZProjectile = z;}
108     virtual void    SetTarget(TString tar="", Int_t a = 0, Int_t z = 0)
109         {fTarget = tar; fATarget = a; fZTarget = z;}
110     
111     virtual void    SetSeed(UInt_t seed);
112     
113  protected:
114     virtual  void  PushTrack(Int_t done, Int_t parent, Int_t pdg,
115                                Float_t *pmom, Float_t *vpos, Float_t *polar,
116                                Float_t tof, TMCProcess mech, Int_t &ntr,
117                                Float_t weight = 1, Int_t is = 0);
118     virtual  void  PushTrack(Int_t done, Int_t parent, Int_t pdg,
119                       Double_t px, Double_t py, Double_t pz, Double_t e,
120                       Double_t vx, Double_t vy, Double_t vz, Double_t tof,
121                       Double_t polx, Double_t poly, Double_t polz,
122                       TMCProcess mech, Int_t &ntr, Float_t weight = 1, Int_t is = 0);
123     virtual void   KeepTrack(Int_t itrack); 
124     virtual void   SetHighWaterMark(Int_t nt);
125
126  protected:
127     TGenerator* fMCEvGen;      //!Pointer to the generator
128     Float_t     fThetaMin;     //Minimum theta of generation in radians
129     Float_t     fThetaMax;     //Maximum theta of generation in radians
130     Float_t     fPhiMin;       //Minimum phi of generation in radians
131     Float_t     fPhiMax;       //Maximum phi of generation in radians
132     Float_t     fPMin;         //Minimum momentum of generation in GeV/c
133     Float_t     fPMax;         //Minimum momentum of generation in GeV/c
134     Float_t     fPtMin;        //Minimum transverse momentum
135     Float_t     fPtMax;        //Maximum transverse momentum
136     Float_t     fYMin;         //Minimum rapidity
137     Float_t     fYMax;         //Maximum rapidity
138     TArrayF     fVMin;         //Minimum Decaylength
139     TArrayF     fVMax;         //Minimum Decaylength    
140     Int_t       fNpart;        //Maximum number of particles per event
141     Float_t     fParentWeight; //Parent Weight
142     Float_t     fChildWeight;  //ChildWeight
143     Int_t       fAnalog;       //Flag for anolog or pt-weighted generation
144    //
145     VertexSmear_t     fVertexSmear;  //Vertex Smearing mode
146     VertexSource_t    fVertexSource; //Vertex source (internal/external)
147     Float_t     fCutVertexZ;         //Vertex cut in units of sigma_z
148     Float_t     fPileUpTimeWindow;   //Time window for pile-up events
149     Int_t       fTrackIt;    // if 1, Track final state particles 
150     AliVertexGenerator* fVertexGenerator;  //! Generator for the vertex
151     TArrayF     fOrigin;     // Origin of event
152     TArrayF     fOsigma;     // Sigma of the Origin of event
153     TArrayF     fVertex;        //! Vertex of current event
154     
155     Float_t     fTimeOrigin; // Time0 origin in a run or event sample
156     Float_t     fTime;       // Event time smeared around time0 origin using sigma vertex
157     Float_t     fEvPlane;    // the event plane 
158
159     AliStack*   fStack;         //! Local pointer to stack
160     AliGenerator* fContainer;   //! Local pointer to container
161     
162     AliCollisionGeometry* fCollisionGeometry; //!Collision geometry
163     /*************************************************************************/
164     enum {kThetaRange    = BIT(14),
165           kVertexRange   = BIT(15),
166           kPhiRange      = BIT(16),
167           kPtRange       = BIT(17),
168           kYRange        = BIT(18),
169           kMomentumRange = BIT(19),
170           kEtaRange      = BIT(20)        
171     };
172
173     Float_t     fEnergyCMS;    // Centre of mass energy
174     Int_t        fAProjectile;   // Projectile A
175     Int_t        fZProjectile;   // Projectile Z
176     Int_t        fATarget;       // Target A
177     Int_t        fZTarget;       // Target Z
178     TString      fProjectile;    // Projectile
179     TString      fTarget;        // Target
180
181  private:
182     AliGenerator(const AliGenerator &gen);
183     AliGenerator & operator=(const AliGenerator &gen);
184
185     ClassDef(AliGenerator,5) // Base class for event generators
186 };
187
188 #endif
189
190
191
192
193
194
195
196
197
198
199
200
201
202