Modifying/adding comments for Doxygen
authorivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 26 Oct 2006 11:45:53 +0000 (11:45 +0000)
committerivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 26 Oct 2006 11:45:53 +0000 (11:45 +0000)
MUON/AliMUONResponseTriggerV1.h
MUON/AliMUONResponseV0.h
MUON/AliMUONTrackReconstructor.h
MUON/AliMUONTriggerElectronics.h

index f48762b..c7200f1 100644 (file)
@@ -19,7 +19,7 @@ class AliMUONResponseTriggerV1 : public AliMUONResponseTrigger
     // default constructor
     AliMUONResponseTriggerV1();
     AliMUONResponseTriggerV1(Float_t hv);
-    virtual ~AliMUONResponseTriggerV1(){} 
+    virtual ~AliMUONResponseTriggerV1();
 
     // Set the GenerCluster parameter       
     virtual Int_t SetGenerCluster();
@@ -27,10 +27,10 @@ class AliMUONResponseTriggerV1 : public AliMUONResponseTrigger
     virtual void DisIntegrate(const AliMUONHit& hit, TList& digits);
 
   protected:
-    Float_t fGenerCluster;   // Random number  
-    Float_t fA;              // first parameter  of the cluster-size param
-    Float_t fB;              // second parameter of the cluster-size param
-    Float_t fC;              // third parameter  of the cluster-size param
+    Float_t fGenerCluster;   ///< Random number  
+    Float_t fA;              ///< first parameter  of the cluster-size param
+    Float_t fB;              ///< second parameter of the cluster-size param
+    Float_t fC;              ///< third parameter  of the cluster-size param
 
   private:
     // initialize parameters
index 88db999..1ec6dce 100644 (file)
@@ -21,62 +21,62 @@ class AliMUONResponseV0 : public AliMUONResponse
     //
     // Configuration methods
     //
-    // Set number of sigmas over which cluster didintegration is performed
+    /// Set number of sigmas over which cluster didintegration is performed
     virtual void    SetSigmaIntegration(Float_t p1) {fSigmaIntegration=p1;}
-    // Get number of sigmas over which cluster didintegration is performed   
+    /// Get number of sigmas over which cluster didintegration is performed   
     virtual Float_t SigmaIntegration() const {return fSigmaIntegration;}    
-    // Set single electron pulse height (ADCcounts/e)
+    /// Set single electron pulse height (ADCcounts/e)
     virtual void    SetChargeSlope(Float_t p1) {fChargeSlope=p1;}
-    // Get Set single electron pulse height (ADCcounts/e)
+    /// Get Set single electron pulse height (ADCcounts/e)
     virtual Float_t ChargeSlope() const     {return fChargeSlope;}
-    // Set sigmas of the charge spread function
+    /// Set sigmas of the charge spread function
     virtual void    SetChargeSpread(Float_t p1, Float_t p2)
        {fChargeSpreadX=p1; fChargeSpreadY=p2;}
-    // Get sigma_X of the charge spread function
+    /// Get sigma_X of the charge spread function
     virtual Float_t ChargeSpreadX() const    {return fChargeSpreadX;}
-    // Get sigma_Y of the charge spread function
+    /// Get sigma_Y of the charge spread function
     virtual Float_t ChargeSpreadY() const    {return fChargeSpreadY;}        
-    // Set maximum Adc-count value
+    /// Set maximum Adc-count value
     virtual void    SetMaxAdc(Int_t p1) {fMaxAdc=p1;}
-    // Set saturation value
+    /// Set saturation value
     virtual void    SetSaturation(Int_t p1) {fSaturation=p1;}
-    // Set zero suppression threshold
+    /// Set zero suppression threshold
     virtual void    SetZeroSuppression(Int_t p1) {fZeroSuppression=p1;}
-    // Get maximum Adc-count value   
+    /// Get maximum Adc-count value   
     virtual Int_t   MaxAdc() const          {return fMaxAdc;}
-    // Get saturation value   
+    /// Get saturation value   
     virtual Int_t   Saturation() const      {return fSaturation;}
 
-    // Get zero suppression threshold
+    /// Get zero suppression threshold
     virtual Int_t   ZeroSuppression() const {return fZeroSuppression;}
-    // Set the charge correlation
+    /// Set the charge correlation
     virtual void SetChargeCorrel(Float_t correl){fChargeCorrel = correl;}
-    // Get the charge correlation
+    /// Get the charge correlation
     virtual Float_t ChargeCorrel() const {return fChargeCorrel;}
 
 
-    // Set anode cathode Pitch
+    /// Set anode cathode Pitch
     virtual Float_t Pitch() const           {return fMathieson->Pitch();}
-    // Get anode cathode Pitch
+    /// Get anode cathode Pitch
     virtual void    SetPitch(Float_t p1)    {fMathieson->SetPitch(p1);};
 
-    // Set Mathieson parameters
-    // Mathieson \sqrt{Kx3} and derived Kx2 and Kx4 
-    // passing pointer to class Mathieson for backward compatibility
+    /// Set Mathieson parameters
+    /// Mathieson \sqrt{Kx3} and derived Kx2 and Kx4 
+    /// passing pointer to class Mathieson for backward compatibility
     virtual void    SetSqrtKx3AndDeriveKx2Kx4(Float_t SqrtKx3);
-    // Mathieson \sqrt{Kx3}
+    /// Mathieson \sqrt{Kx3}
     virtual void    SetSqrtKx3(Float_t p1) {fMathieson->SetSqrtKx3(p1);};
-    // Mathieson Kx2
+    /// Mathieson Kx2
     virtual void    SetKx2(Float_t p1)     {fMathieson->SetKx2(p1);};
-    // Mathieson Kx4
+    /// Mathieson Kx4
     virtual void    SetKx4(Float_t p1)     {fMathieson->SetKx4(p1);};
-    // Mathieson \sqrt{Ky3} and derived Ky2 and Ky4
+    /// Mathieson \sqrt{Ky3} and derived Ky2 and Ky4
     virtual void SetSqrtKy3AndDeriveKy2Ky4(Float_t SqrtKy3);
-    // Mathieson \sqrt{Ky3}
+    /// Mathieson \sqrt{Ky3}
     virtual void    SetSqrtKy3(Float_t p1) {fMathieson->SetSqrtKy3(p1);};
-    // Mathieson Ky2
+    /// Mathieson Ky2
     virtual void    SetKy2(Float_t p1)     {fMathieson->SetKy2(p1);};
-    // Mathieson Ky4
+    /// Mathieson Ky4
       virtual void SetKy4(Float_t p1)     {fMathieson->SetKy4(p1);};
     //  
     // Chamber response methods
index 774abca..189ab4c 100644 (file)
@@ -35,37 +35,76 @@ class AliMUONTrackReconstructor : public TObject {
 
   // Parameters for track reconstruction: public methods
   // Get and Set, Set to defaults
+
+           /// Return minimum value (GeV/c) of momentum in bending plane
   Double_t GetMinBendingMomentum(void) const {return fMinBendingMomentum;}
+           /// Set minimum value (GeV/c) of momentum in bending plane
   void SetMinBendingMomentum(Double_t MinBendingMomentum) {fMinBendingMomentum = MinBendingMomentum;}
+
+           /// Return maximum value (GeV/c) of momentum in bending plane
   Double_t GetMaxBendingMomentum(void) const {return fMaxBendingMomentum;}
+           /// Set maximum value (GeV/c) of momentum in bending plane
   void SetMaxBendingMomentum(Double_t MaxBendingMomentum) {fMaxBendingMomentum = MaxBendingMomentum;}
+
+           /// Return maximum Chi2 per degree of Freedom
   Double_t GetMaxChi2(void) const {return fMaxChi2;}
+           /// Set maximum Chi2 per degree of Freedom
   void SetMaxChi2(Double_t MaxChi2) {fMaxChi2 = MaxChi2;}
+
+           /// Return maximum square distance in units of the variance (maximum chi2)
   Double_t GetMaxSigma2Distance(void) const {return fMaxSigma2Distance;}
+           /// Set maximum square distance in units of the variance (maximum chi2)
   void SetMaxSigma2Distance(Double_t MaxSigma2Distance) {fMaxSigma2Distance = MaxSigma2Distance;}
+
+           /// Return chamber resolution (cm) in bending plane
   Double_t GetBendingResolution(void) const {return fBendingResolution;}
+           /// Set chamber resolution (cm) in bending plane
   void SetBendingResolution(Double_t BendingResolution) {fBendingResolution = BendingResolution;}
+
+           /// Return chamber resolution (cm) in non-bending plane
   Double_t GetNonBendingResolution(void) const {return fNonBendingResolution;}
+           /// set chamber resolution (cm) in non-bending plane
   void SetNonBendingResolution(Double_t NonBendingResolution) {fNonBendingResolution = NonBendingResolution;}
+
+           /// Return chamber thickness in number of radiation lengths
   Double_t GetChamberThicknessInX0(void) const {return fChamberThicknessInX0;}
+           /// Set chamber thickness in number of radiation lengths
   void SetChamberThicknessInX0(Double_t ChamberThicknessInX0) {fChamberThicknessInX0 = ChamberThicknessInX0;}
+
+           /// Return simple magnetic field: value (kG)
   Double_t GetSimpleBValue(void) const {return fSimpleBValue;}
+           /// Set simple magnetic field: value (kG)
   void SetSimpleBValue(Double_t SimpleBValue) {fSimpleBValue = SimpleBValue;}
+
+           /// Return simple magnetic field: length (cm)
   Double_t GetSimpleBLength(void) const {return fSimpleBLength;}
+           /// Set simple magnetic field: length (cm)
   void SetSimpleBLength(Double_t SimpleBLength) {fSimpleBLength = SimpleBLength;}
+
+           /// Return simple magnetic field: Z central position (cm)
   Double_t GetSimpleBPosition(void) const {return fSimpleBPosition;}
+           /// Set simple magnetic field: Z central position (cm)
   void SetSimpleBPosition(Double_t SimpleBPosition) {fSimpleBPosition = SimpleBPosition;}
+
+           /// Return chamber efficiency (used for track ref. hits only
   Double_t GetEfficiency(void) const {return fEfficiency;}
+           /// Set chamber efficiency (used for track ref. hits only
   void SetEfficiency(Double_t Efficiency) {fEfficiency = Efficiency;}
+
   void SetReconstructionParametersToDefaults(void);
+
+           /// Return track fitter
   static TVirtualFitter* Fitter(void) {return fgFitter;}
 
-  // Hits for reconstruction
+           /// Return number of hits for reconstruction
   Int_t GetNHitsForRec(void) const {return fNHitsForRec;} // Number
 
-  // Reconstructed tracks
+           /// Return number of reconstructed tracks
   Int_t GetNRecTracks() const {return fNRecTracks;} // Number
+           /// Set number of reconstructed tracks
   void SetNRecTracks(Int_t NRecTracks) {fNRecTracks = NRecTracks;}
+
+           /// Return array of reconstructed tracks
   TClonesArray* GetRecTracksPtr(void) const {return fRecTracksPtr;} // Array
  
   // Functions
@@ -77,12 +116,15 @@ class AliMUONTrackReconstructor : public TObject {
   void EventDumpTrigger(void);  // dump reconstructed trigger event
   //PH  void FillEvent();      // fill and write tree of reconstructed events
   void SetTrackMethod(Int_t iTrackMethod); //AZ
-  Int_t GetTrackMethod(void) const {return fTrackMethod;} 
+          /// Return track method
+  Int_t GetTrackMethod(void) const {return fTrackMethod;}   
   void FillMUONTrack(void); // set track parameters at hits for Kalman track
   //Int_t fMuons; // AZ - number of muons within acceptance - just for tests
 
+          /// Return MUON data
   AliMUONData*  GetMUONData() {return fMUONData;}
 
+          /// Set trigger circuit
   void SetTriggerCircuit(TClonesArray* circuit) {fTriggerCircuit = circuit;}
 
 
index bd8b48e..1012a67 100644 (file)
@@ -42,7 +42,7 @@ class AliMUONTriggerElectronics : public TTask
 
       virtual void Exec(Option_t*);
       
-//    CRATE CONFIG FROM ASCII FILE
+      /// Set Crate config from ascii file
       virtual void SetDataSource(TString SourceFile = 
                                  "$ALICE_ROOT/MUON/mapping/data/stationTrigger/crate.dat") 
       {fSourceFileName = SourceFile;}