Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONVTrackReconstructor.h
1 #ifndef ALIMUONVTRACKRECONSTRUCTOR_H
2 #define ALIMUONVTRACKRECONSTRUCTOR_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 AliMUONVTrackReconstructor
10 /// \brief Virtual class for the MUON track reconstruction
11 ///
12 //  Author: Philippe Pillot
13
14 #include <TObject.h>
15
16 class TClonesArray;
17 class AliMUONData;
18 class AliMUONTriggerTrack;
19
20 class AliMUONVTrackReconstructor : public TObject {
21
22  public:
23   AliMUONVTrackReconstructor(AliMUONData* data); // default Constructor
24   virtual ~AliMUONVTrackReconstructor(); // Destructor
25
26   // Parameters for track reconstruction: public methods
27   // Get and Set, Set to defaults
28            /// Return minimum value (GeV/c) of momentum in bending plane
29   Double_t GetMinBendingMomentum(void) const {return fMinBendingMomentum;}
30            /// Return chamber resolution (cm) in bending plane
31   Double_t GetBendingResolution(void) const {return fBendingResolution;}
32            /// Return chamber resolution (cm) in non-bending plane
33   Double_t GetNonBendingResolution(void) const {return fNonBendingResolution;}
34
35   // Reconstructed tracks
36            /// Return number of reconstructed tracks
37   Int_t GetNRecTracks() const {return fNRecTracks;} // Number
38            /// Set number of reconstructed tracks
39   void SetNRecTracks(Int_t NRecTracks) {fNRecTracks = NRecTracks;}
40            /// Return array of reconstructed tracks
41   TClonesArray* GetRecTracksPtr(void) const {return fRecTracksPtr;} // Array
42  
43   // Functions
44   void EventReconstruct(void);
45   void EventReconstructTrigger(void);
46   virtual void EventDump(void) = 0;  // dump reconstructed event
47   void EventDumpTrigger(void);  // dump reconstructed trigger event
48   
49           /// Return MUON data
50   AliMUONData*  GetMUONData() {return fMUONData;}
51   void SetMUONData(AliMUONData* data) {fMUONData = data;}
52
53           /// Set trigger circuit
54   void SetTriggerCircuit(TClonesArray* circuit) {fTriggerCircuit = circuit;}
55
56
57  protected:
58
59   // Defaults parameters for reconstruction
60   static const Double_t fgkDefaultMinBendingMomentum; ///< default min. bending momentum for reconstruction
61   static const Double_t fgkDefaultMaxBendingMomentum; ///< default max. bending momentum for reconstruction
62   static const Double_t fgkDefaultBendingResolution; ///< default bending coordinate resolution for reconstruction 
63   static const Double_t fgkDefaultNonBendingResolution; ///< default non bending coordinate resolution for reconstruction
64   static const Double_t fgkDefaultBendingVertexDispersion; ///< default vertex dispersion in bending plane for reconstruction
65   static const Double_t fgkDefaultNonBendingVertexDispersion; ///< default vertex dispersion in non bending plane for reconstruction
66   static const Double_t fgkDefaultMaxNormChi2MatchTrigger; ///< default maximum normalized chi2 of tracking/trigger track matching
67   
68   // Parameters for track reconstruction
69   Double_t fMinBendingMomentum; ///< minimum value (GeV/c) of momentum in bending plane
70   Double_t fMaxBendingMomentum; ///< maximum value (GeV/c) of momentum in bending plane
71   Double_t fBendingResolution; ///< chamber resolution (cm) in bending plane
72   Double_t fNonBendingResolution; ///< chamber resolution (cm) in non bending plane
73   Double_t fBendingVertexDispersion; ///< vextex dispersion (cm) in bending plane
74   Double_t fNonBendingVertexDispersion; ///< vextex dispersion (cm) in non bending plane
75   Double_t fMaxNormChi2MatchTrigger; ///< maximum normalized chi2 of tracking/trigger track matching
76   
77   TClonesArray* fHitsForRecPtr; ///< pointer to the array of hits for reconstruction
78   Int_t fNHitsForRec; ///< number of hits for reconstruction
79   Int_t* fNHitsForRecPerChamber; ///< number of HitsForRec
80   Int_t* fIndexOfFirstHitForRecPerChamber; ///< index (0...) of first HitForRec
81
82   // Reconstructed tracks
83   TClonesArray *fRecTracksPtr; ///< pointer to array of reconstructed tracks
84   Int_t fNRecTracks; ///< number of reconstructed tracks
85
86   // data container
87   AliMUONData* fMUONData; ///< Data container for MUON subsystem 
88
89   // Functions
90   AliMUONVTrackReconstructor (const AliMUONVTrackReconstructor& rhs); ///< copy constructor
91   AliMUONVTrackReconstructor& operator=(const AliMUONVTrackReconstructor& rhs); ///< assignment operator
92   
93   void SortHitsForRecWithIncreasingChamber();
94   TClonesArray *MakeSegmentsInStation(Int_t station);
95
96   virtual void AddHitsForRecFromRawClusters() = 0;
97   virtual void MakeTracks(void) = 0;
98   virtual void MakeTrackCandidates(void) = 0;
99   virtual void FollowTracks(void) = 0;
100   virtual void RemoveDoubleTracks(void) = 0;
101   virtual void FillMUONTrack(void) = 0;
102
103  private:
104   
105   AliMUONTriggerTrack* fTriggerTrack; ///< Trigger track structure
106
107   TClonesArray* fTriggerCircuit;      //!< trigger circuit array
108   
109   // Functions
110   void ResetTracks(void);
111   void ResetHitsForRec(void);
112   
113   void ValidateTracksWithTrigger(void);
114   
115   Bool_t MakeTriggerTracks(void);
116
117
118   ClassDef(AliMUONVTrackReconstructor, 0) // MUON track reconstructor in ALICE
119 };
120         
121 #endif