]> git.uio.no Git - u/mrichter/AliRoot.git/blob - MUON/AliMUONRecoParam.h
Comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONRecoParam.h
1 #ifndef AliMUONRecoParam_H
2 #define AliMUONRecoParam_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 /// \ingroup rec
9 /// \class AliMUONRecoParam
10 /// \brief Class with MUON reconstruction parameters
11 ///
12 //  Author: Philippe Pillot
13
14 #include "AliDetectorRecoParam.h"
15 #include "TString.h"
16
17 class AliMUONRecoParam : public AliDetectorRecoParam
18 {
19  public: 
20   AliMUONRecoParam();
21   virtual ~AliMUONRecoParam();
22   
23   static AliMUONRecoParam *GetLowFluxParam();
24   static AliMUONRecoParam *GetHighFluxParam();
25   static AliMUONRecoParam *GetCosmicParam();
26   
27   /// set the calibration mode (see GetCalibrationMode() for possible modes)
28   void SetCalibrationMode(Option_t* mode) { fCalibrationMode = mode; fCalibrationMode.ToUpper();}
29
30   Option_t* GetCalibrationMode() const;
31       
32   /// set the clustering (pre-clustering) mode
33   void      SetClusteringMode(Option_t* mode) {fClusteringMode = mode; fClusteringMode.ToUpper();}
34   /// get the clustering (pre-clustering) mode
35   Option_t* GetClusteringMode() const {return fClusteringMode.Data();}
36   
37   /// set the tracking mode
38   void      SetTrackingMode(Option_t* mode) {fTrackingMode = mode; fTrackingMode.ToUpper();}
39   /// get the tracking mode
40   Option_t* GetTrackingMode() const {return fTrackingMode.Data();}
41   
42   /// switch on/off the combined cluster/track reconstruction
43   void      CombineClusterTrackReco(Bool_t flag) {fCombinedClusterTrackReco = flag;}
44   /// return kTRUE/kFALSE if the combined cluster/track reconstruction is on/off
45   Bool_t    CombineClusterTrackReco() const {return fCombinedClusterTrackReco;}
46   
47   /// save all cluster info (including pads) in ESD, for the given percentage of events
48   void      SaveFullClusterInESD(Bool_t flag, Double_t percentOfEvent = 100.) {fSaveFullClusterInESD = flag;
49                                  fPercentOfFullClusterInESD = (fSaveFullClusterInESD) ? percentOfEvent : 0.;}
50   /// return kTRUE/kFALSE depending on whether we save all cluster info in ESD or not
51   Bool_t    SaveFullClusterInESD() const {return fSaveFullClusterInESD;}
52   /// return the percentage of events for which all cluster info are stored in ESD
53   Double_t  GetPercentOfFullClusterInESD() const {return fPercentOfFullClusterInESD;}
54   
55   /// set the minimum value (GeV/c) of momentum in bending plane
56   void     SetMinBendingMomentum(Double_t val) {fMinBendingMomentum = val;}
57   /// return the minimum value (GeV/c) of momentum in bending plane
58   Double_t GetMinBendingMomentum() const {return fMinBendingMomentum;}
59   /// set the maximum value (GeV/c) of momentum in bending plane
60   void     SetMaxBendingMomentum(Double_t val) {fMaxBendingMomentum = val;}
61   /// return the maximum value (GeV/c) of momentum in bending plane
62   Double_t GetMaxBendingMomentum() const {return fMaxBendingMomentum;}
63   /// set the maximum value of the non bending slope
64   void     SetMaxNonBendingSlope(Double_t val) {fMaxNonBendingSlope = val;}
65   /// return the maximum value of the non bending slope
66   Double_t GetMaxNonBendingSlope() const {return fMaxNonBendingSlope;}
67   /// set the maximum value of the bending slope
68   void     SetMaxBendingSlope(Double_t val) {fMaxBendingSlope = val;}
69   /// return the maximum value of the bending slope
70   Double_t GetMaxBendingSlope() const {return fMaxBendingSlope;}
71   
72   /// set the vertex dispersion (cm) in non bending plane (used for original tracking only)
73   void     SetNonBendingVertexDispersion(Double_t val) {fNonBendingVertexDispersion = val;} 
74   /// return the vertex dispersion (cm) in non bending plane (used for original tracking only)
75   Double_t GetNonBendingVertexDispersion() const {return fNonBendingVertexDispersion;}
76   /// set the vertex dispersion (cm) in bending plane (used for original tracking only)
77   void     SetBendingVertexDispersion(Double_t val) {fBendingVertexDispersion = val;} 
78   /// return the vertex dispersion (cm) in bending plane (used for original tracking only)
79   Double_t GetBendingVertexDispersion() const {return fBendingVertexDispersion;}
80   
81   /// set the maximum distance to the track to search for compatible cluster(s) in non bending direction
82   void     SetMaxNonBendingDistanceToTrack(Double_t val) {fMaxNonBendingDistanceToTrack = val;} 
83   /// return the maximum distance to the track to search for compatible cluster(s) in non bending direction
84   Double_t GetMaxNonBendingDistanceToTrack() const {return fMaxNonBendingDistanceToTrack;}
85   /// set the maximum distance to the track to search for compatible cluster(s) in bending direction
86   void     SetMaxBendingDistanceToTrack(Double_t val) {fMaxBendingDistanceToTrack = val;} 
87   /// return the maximum distance to the track to search for compatible cluster(s) in bending direction
88   Double_t GetMaxBendingDistanceToTrack() const {return fMaxBendingDistanceToTrack;}
89   
90   /// set the cut in sigma to apply on cluster (local chi2) and track (global chi2) during tracking
91   void     SetSigmaCutForTracking(Double_t val) {fSigmaCutForTracking = val;} 
92   /// return the cut in sigma to apply on cluster (local chi2) and track (global chi2) during tracking
93   Double_t GetSigmaCutForTracking() const {return fSigmaCutForTracking;}
94   
95   /// switch on/off the track improvement and keep the default cut in sigma to apply on cluster (local chi2)
96   void     ImproveTracks(Bool_t flag) {fImproveTracks = flag;} 
97   /// switch on/off the track improvement and set the cut in sigma to apply on cluster (local chi2)
98   void     ImproveTracks(Bool_t flag, Double_t sigmaCut) {fImproveTracks = flag; fSigmaCutForImprovement = sigmaCut;} 
99   /// return kTRUE/kFALSE if the track improvement is switch on/off
100   Bool_t   ImproveTracks() const {return fImproveTracks;}
101   /// return the cut in sigma to apply on cluster (local chi2) during track improvement
102   Double_t GetSigmaCutForImprovement() const {return fSigmaCutForImprovement;}
103
104   /// set the cut in sigma to apply on track during trigger hit pattern search
105   void     SetSigmaCutForTrigger(Double_t val) {fSigmaCutForTrigger = val;} 
106   /// return the cut in sigma to apply on track during trigger hit pattern search
107   Double_t GetSigmaCutForTrigger() const {return fSigmaCutForTrigger;}
108   /// set the cut in strips to apply on trigger track during trigger chamber efficiency
109   void     SetStripCutForTrigger(Double_t val) {fStripCutForTrigger = val;} 
110   /// return the cut in strips to apply on trigger track during trigger chamber efficiency
111   Double_t GetStripCutForTrigger() const {return fStripCutForTrigger;}
112   /// set the maximum search area in strips to apply on trigger track during trigger chamber efficiency
113   void     SetMaxStripAreaForTrigger(Double_t val) {fMaxStripAreaForTrigger = val;} 
114   /// return the maximum search area in strips to apply on trigger track during trigger chamber efficiency
115   Double_t GetMaxStripAreaForTrigger() const {return fMaxStripAreaForTrigger;}
116   
117   /// set the maximum normalized chi2 of tracking/trigger track matching
118   void     SetMaxNormChi2MatchTrigger(Double_t val) {fMaxNormChi2MatchTrigger = val;} 
119   /// return the maximum normalized chi2 of tracking/trigger track matching
120   Double_t GetMaxNormChi2MatchTrigger() const {return fMaxNormChi2MatchTrigger;}
121   
122   /// switch on/off the tracking of all the possible candidates (track only the best one if switched off)
123   void     TrackAllTracks(Bool_t flag) {fTrackAllTracks = flag;} 
124   /// return kTRUE/kFALSE if the tracking of all the possible candidates is switched on/off
125   Bool_t   TrackAllTracks() const {return fTrackAllTracks;}
126   
127   /// switch on/off the recovering of tracks being lost during reconstruction
128   void     RecoverTracks(Bool_t flag) {fRecoverTracks = flag;} 
129   /// return kTRUE/kFALSE if the recovering of tracks being lost during reconstruction is switched on/off
130   Bool_t   RecoverTracks() const {return fRecoverTracks;}
131   
132   /// switch on/off the fast building of track candidates (assuming linear propagation between stations 4 and 5)
133   void     MakeTrackCandidatesFast(Bool_t flag) {fMakeTrackCandidatesFast = flag;} 
134   /// return kTRUE/kFALSE if the fast building of track candidates is switched on/off
135   Bool_t   MakeTrackCandidatesFast() const {return fMakeTrackCandidatesFast;}
136   
137   /// switch on/off the building of track candidates starting from 1 cluster in each of the stations 4 and 5
138   void     MakeMoreTrackCandidates(Bool_t flag) {fMakeMoreTrackCandidates = flag;} 
139   /// return kTRUE/kFALSE if the building of extra track candidates is switched on/off
140   Bool_t   MakeMoreTrackCandidates() const {return fMakeMoreTrackCandidates;}
141   
142   /// switch on/off the completion of reconstructed track
143   void     ComplementTracks(Bool_t flag) {fComplementTracks = flag;} 
144   /// return kTRUE/kFALSE if completion of the reconstructed track is switched on/off
145   Bool_t   ComplementTracks() const {return fComplementTracks;}
146   
147   /// switch on/off the use of the smoother
148   void     UseSmoother(Bool_t flag) {fUseSmoother = flag;} 
149   /// return kTRUE/kFALSE if the use of the smoother is switched on/off
150   Bool_t   UseSmoother() const {return fUseSmoother;}
151   
152   /// switch on/off a chamber in the reconstruction
153   void     UseChamber(Int_t iCh, Bool_t flag) {if (iCh >= 0 && iCh < 10) fUseChamber[iCh] = flag;}
154   /// return kTRUE/kFALSE whether the chamber must be used or not
155   Bool_t   UseChamber(Int_t iCh) const {return (iCh >= 0 && iCh < 10) ? fUseChamber[iCh] : kFALSE;}
156   
157   /// request or not at least one cluster in the station to validate the track
158   void     RequestStation(Int_t iSt, Bool_t flag) {if (iSt >= 0 && iSt < 5) fRequestStation[iSt] = flag;}
159   /// return kTRUE/kFALSE whether at least one cluster is requested in the station to validate the track
160   Bool_t   RequestStation(Int_t iSt) const {return (iSt >= 0 && iSt < 5) ? fRequestStation[iSt] : kFALSE;}
161   /// return an integer where first 5 bits are set to 1 if the corresponding station is requested
162   UInt_t   RequestedStationMask() const;
163   
164   /// set the bypassSt45 value
165   void BypassSt45(Bool_t st4, Bool_t st5);
166         
167   /// return kTRUE if we should replace clusters in St 4 and 5 by generated clusters from trigger tracks
168   Bool_t BypassSt45() const { return fBypassSt45==45; }
169   
170         /// return kTRUE if we should replace clusters in St 4 by generated clusters from trigger tracks
171   Bool_t BypassSt4() const { return BypassSt45() || fBypassSt45==4 ; }
172
173         /// return kTRUE if we should replace clusters in St 5 by generated clusters from trigger tracks
174   Bool_t BypassSt5() const { return BypassSt45() || fBypassSt45==5 ; }
175   
176         /// Set Low and High threshold for St12 HV
177   void SetHVSt12Limits(float low, float high) { fHVSt12Limits[0]=low; fHVSt12Limits[1]=high; }
178         /// Retrieve low limit for St12's HV
179         Float_t HVSt12LowLimit() const { return fHVSt12Limits[0]; }
180         /// Retrieve high limit for St12's HV
181         Float_t HVSt12HighLimit() const { return fHVSt12Limits[1]; }
182         
183   /// Set Low and High threshold for St345 HV
184   void SetHVSt345Limits(float low, float high) { fHVSt345Limits[0]=low; fHVSt345Limits[1]=high; } 
185         /// Retrieve low limit for St345's HV
186         Float_t HVSt345LowLimit() const { return fHVSt345Limits[0]; }
187         /// Retrieve high limit for St345's HV
188         Float_t HVSt345HighLimit() const { return fHVSt345Limits[1]; }
189         
190   /// Set Low and High threshold for pedestal mean
191   void SetPedMeanLimits(float low, float high) { fPedMeanLimits[0]=low; fPedMeanLimits[1]=high; }
192         /// Retrieve low limit of ped mean
193         Float_t PedMeanLowLimit() const { return fPedMeanLimits[0]; }
194         /// Retrieve high limit of ped mean
195         Float_t PedMeanHighLimit() const { return fPedMeanLimits[1]; }
196         
197   /// Set Low and High threshold for pedestal sigma 
198   void SetPedSigmaLimits(float low, float high) { fPedSigmaLimits[0]=low; fPedSigmaLimits[1]=high; }
199         /// Retrieve low limit of ped sigma
200         Float_t PedSigmaLowLimit() const { return fPedSigmaLimits[0]; }
201         /// Retrieve high limit of ped sigma
202         Float_t PedSigmaHighLimit() const { return fPedSigmaLimits[1]; }
203   
204         /// Set Low and High threshold for gain a0 term
205         void SetGainA1Limits(float low, float high) { fGainA1Limits[0]=low; fGainA1Limits[1]=high; }
206         /// Retrieve low limit of a1 (linear term) gain parameter
207         Float_t GainA1LowLimit() const { return fGainA1Limits[0]; }
208         /// Retrieve high limit of a1 (linear term) gain parameter
209         Float_t GainA1HighLimit() const { return fGainA1Limits[1]; }
210         
211         /// Set Low and High threshold for gain a1 term
212         void SetGainA2Limits(float low, float high) { fGainA2Limits[0]=low; fGainA2Limits[1]=high; }
213         /// Retrieve low limit of a2 (quadratic term) gain parameter
214         Float_t GainA2LowLimit() const { return fGainA2Limits[0]; }
215         /// Retrieve high limit of a2 (quadratic term) gain parameter
216         Float_t GainA2HighLimit() const { return fGainA2Limits[1]; }
217         
218         /// Set Low and High threshold for gain threshold term
219         void SetGainThresLimits(float low, float high) { fGainThresLimits[0]=low; fGainThresLimits[1]=high; }
220         /// Retrieve low limit on threshold gain parameter
221         Float_t GainThresLowLimit() const { return fGainThresLimits[0]; }
222         /// Retrieve high limit on threshold gain parameter
223         Float_t GainThresHighLimit() const { return fGainThresLimits[1]; }
224         
225         /// Set the goodness mask (see AliMUONPadStatusMapMaker)
226         void SetPadGoodnessMask(UInt_t mask) { fPadGoodnessMask=mask; }
227         /// Get the goodness mask
228         UInt_t PadGoodnessMask() const { return fPadGoodnessMask; }
229         
230   virtual void Print(Option_t *option = "") const;
231   
232   /// Number of sigma cut we must apply when cutting on adc-ped
233   Double_t ChargeSigmaCut() const { return fChargeSigmaCut; }
234
235   /// Number of sigma cut we must apply when cutting on adc-ped
236   void ChargeSigmaCut(Double_t value) { fChargeSigmaCut=value; }
237
238 private:
239         void SetDefaultLimits();
240         
241  private:
242   
243   /// clustering mode:  NOCLUSTERING, PRECLUSTER, PRECLUSTERV2, PRECLUSTERV3, COG, <pre>
244   ///                   SIMPLEFIT, SIMPLEFITV3, MLEM:DRAW, MLEM, MLEMV2, MLEMV3   </pre>
245   TString fClusteringMode; ///< \brief name of the clustering (+ pre-clustering) mode
246   
247   /// tracking mode: ORIGINAL, KALMAN
248   TString fTrackingMode; ///< \brief name of the tracking mode
249   
250   Double32_t fMinBendingMomentum; ///< minimum value (GeV/c) of momentum in bending plane
251   Double32_t fMaxBendingMomentum; ///< maximum value (GeV/c) of momentum in bending plane
252   Double32_t fMaxNonBendingSlope; ///< maximum value of the non bending slope
253   Double32_t fMaxBendingSlope;    ///< maximum value of the bending slope (used only if B = 0)
254   
255   Double32_t fNonBendingVertexDispersion; ///< vertex dispersion (cm) in non bending plane (used for original tracking only)
256   Double32_t fBendingVertexDispersion;    ///< vertex dispersion (cm) in bending plane (used for original tracking only)
257   
258   Double32_t fMaxNonBendingDistanceToTrack; ///< maximum distance to the track to search for compatible cluster(s) in non bending direction
259   Double32_t fMaxBendingDistanceToTrack;    ///< maximum distance to the track to search for compatible cluster(s) in bending direction
260   
261   Double32_t fSigmaCutForTracking; ///< cut in sigma to apply on cluster (local chi2) and track (global chi2) during tracking
262
263   Double32_t fSigmaCutForImprovement; ///< cut in sigma to apply on cluster (local chi2) during track improvement
264   
265   Double32_t fSigmaCutForTrigger; ///< cut in sigma to apply on track during trigger hit pattern search
266
267   Double32_t fStripCutForTrigger; ///< cut in strips to apply on trigger track during trigger chamber efficiency
268
269   Double32_t fMaxStripAreaForTrigger; ///< max. search area in strips to apply on trigger track during trigger chamber efficiency
270   
271   Double32_t fMaxNormChi2MatchTrigger; ///< maximum normalized chi2 of tracking/trigger track matching
272   
273   Double32_t fPercentOfFullClusterInESD; ///< percentage of events for which all cluster info are stored in ESD
274   
275   Bool_t     fCombinedClusterTrackReco; ///< switch on/off the combined cluster/track reconstruction
276   
277   Bool_t     fTrackAllTracks; ///< kTRUE to track all the possible candidates; kFALSE to track only the best ones
278   
279   Bool_t     fRecoverTracks; ///< kTRUE to try to recover the tracks getting lost during reconstruction
280   
281   Bool_t     fMakeTrackCandidatesFast; ///< kTRUE to make candidate tracks assuming linear propagation between stations 4 and 5
282   
283   Bool_t     fMakeMoreTrackCandidates; ///< kTRUE to make candidate tracks starting from 1 cluster in each of the stations 4 and 5
284   
285   Bool_t     fComplementTracks; ///< kTRUE to try to complete the reconstructed tracks by adding missing clusters
286   
287   Bool_t     fImproveTracks; ///< kTRUE to try to improve the reconstructed tracks by removing bad clusters
288   
289   Bool_t     fUseSmoother; ///< kTRUE to use the smoother to compute track parameters/covariances and local chi2 at each cluster (used for Kalman tracking only)
290   
291   Bool_t     fSaveFullClusterInESD; ///< kTRUE to save all cluster info (including pads) in ESD
292   
293   /// calibration mode:  GAIN, NOGAIN, GAINCONSTANTCAPA
294   TString fCalibrationMode; ///<\brief calibration mode
295   
296   Int_t fBypassSt45; ///< non-zero to use trigger tracks to generate "fake" clusters in St 4 and 5. Can be 0, 4, 5 or 45 only
297   
298   Bool_t     fUseChamber[10]; ///< kTRUE to use the chamber i in the tracking algorithm
299   
300   Bool_t     fRequestStation[5]; ///< kTRUE to request at least one cluster in station i to validate the track
301   
302         Double32_t fGainA1Limits[2]; ///< Low and High threshold for gain a0 parameter
303   Double32_t fGainA2Limits[2]; ///< Low and High threshold for gain a1 parameter
304   Double32_t fGainThresLimits[2]; ///< Low and High threshold for gain threshold parameter
305   Double32_t fHVSt12Limits[2]; ///< Low and High threshold for St12 HV
306   Double32_t fHVSt345Limits[2]; ///< Low and High threshold for St345 HV
307   Double32_t fPedMeanLimits[2]; ///< Low and High threshold for pedestal mean
308   Double32_t fPedSigmaLimits[2]; ///< Low and High threshold for pedestal sigma
309         
310         UInt_t fPadGoodnessMask; ///< goodness mask (see AliMUONPadStatusMaker)
311         
312   Double_t fChargeSigmaCut; ///< number of sigma to cut on adc-ped 
313   
314   // functions
315   void SetLowFluxParam();
316   void SetHighFluxParam();
317   void SetCosmicParam();
318     
319   ClassDef(AliMUONRecoParam,9) // MUON reco parameters
320 };
321
322 #endif
323