New classes for shuttle (Laurent)

[u/mrichter/AliRoot.git] / MUON / AliMUONGeometryMisAligner.h

diff --git a/MUON/AliMUONGeometryMisAligner.h b/MUON/AliMUONGeometryMisAligner.h
index e22b6e3788f07607a88d2cd136654a8549eef70a..c862880a701e7a905d92dc0fe900ad6ef18a664b 100644 (file)
--- a/MUON/AliMUONGeometryMisAligner.h
+++ b/MUON/AliMUONGeometryMisAligner.h
@@ -6,8 +6,8 @@
 /// \ingroup geometry
 /// \class AliMUONGeometryMisAligner
 /// \brief Class for misalignment of geometry transformations
-///
-/// Authors: Bruce Becker, Javier Castillo
+//
+//  Authors: Bruce Becker, Javier Castillo
 
 
 #ifndef ALI_MUON_GEOMETRY_MIS_ALIGNER_H
@@ -36,28 +36,35 @@ class AliMUONGeometryMisAligner:public TObject
   AliMUONGeometryTransformer* MisAlign(const AliMUONGeometryTransformer* transformer, 
                                        Bool_t verbose = kFALSE);
   
+  /// Set cartesian displacement parameters different along x, y
   void SetCartMisAlig(Double_t xmean, Double_t xwidth, Double_t ymean, Double_t ywidth)
     {fCartXMisAligM = xmean; fCartXMisAligW = xwidth; fCartYMisAligM = ymean; fCartYMisAligW = ywidth;}
 
+  /// Set cartesian displacement parameters, the same along x, y
   void SetCartMisAlig(Double_t mean, Double_t width)
     {fCartXMisAligM = mean; fCartXMisAligW = width; fCartYMisAligM = mean; fCartYMisAligW = width;}
   
+  /// Set angular displacement
   void SetAngMisAlig(Double_t mean, Double_t width)
     {fAngMisAligM = mean; fAngMisAligW = width;}
   
-  void SetMaxCartMisAlig(Double_t width) // Kept for backward compatibility
+  /// Set cartesian displacement (Kept for backward compatibility)
+  void SetMaxCartMisAlig(Double_t width) 
     {fCartXMisAligM = 0.0; fCartXMisAligW = width; fCartYMisAligM = 0.0; fCartYMisAligW = width;}
   
-  void SetMaxAngMisAlig(Double_t width) // Kept for backward compatibility
+  /// Set angular displacement (Kept for backward compatibility)
+  void SetMaxAngMisAlig(Double_t width) 
     {fAngMisAligM = 0.0; fAngMisAligW = width;}
 
   void SetXYAngMisAligFactor(Double_t factor);
 
   void SetZCartMisAligFactor(Double_t factor);
 
+  /// Set option for gaussian distribution 
   void SetUseGaus(Bool_t usegaus)
     {fUseGaus=usegaus; fUseUni=!usegaus;}
 
+  /// Set option for uniform distribution 
   void SetUseUni(Bool_t useuni)
     {fUseGaus=!useuni; fUseUni=useuni;}
   
@@ -72,17 +79,17 @@ class AliMUONGeometryMisAligner:public TObject
   void GetUniMisAlign(Double_t cartMisAlig[3], Double_t angMisAlig[3]) const;
   void GetGausMisAlign(Double_t cartMisAlig[3], Double_t angMisAlig[3]) const;
 
-  Bool_t fUseUni;            // use uniform distribution for misaligmnets
-  Bool_t fUseGaus;            // use gaussian distribution for misaligmnets
-  Double_t fCartXMisAligM;   // cartesian displacement mean along x,  (translations)
-  Double_t fCartXMisAligW;   // cartesian displacement width along x,  (translations)
-  Double_t fCartYMisAligM;   // cartesian displacement mean along y,  (translations)
-  Double_t fCartYMisAligW;   // cartesian displacement width along y,  (translations)
-  Double_t fAngMisAligM;    // Angular displacement mean (rotations)
-  Double_t fAngMisAligW;    // Angular displacement range (rotations)
-  Double_t fXYAngMisAligFactor; // factor (<1) to apply to angular misalignment range since range of motion is restricted out of the xy plane
-  Double_t fZCartMisAligFactor; // factor (<1) to apply to cartetian misalignment range since range of motion is restricted in z direction
-  TRandom *fDisplacementGenerator;  // random number generator for the displacements
+  Bool_t fUseUni;            ///< use uniform distribution for misaligmnets
+  Bool_t fUseGaus;           ///< use gaussian distribution for misaligmnets
+  Double_t fCartXMisAligM;   ///< cartesian displacement mean along x,  (translations)
+  Double_t fCartXMisAligW;   ///< cartesian displacement width along x,  (translations)
+  Double_t fCartYMisAligM;   ///< cartesian displacement mean along y,  (translations)
+  Double_t fCartYMisAligW;   ///< cartesian displacement width along y,  (translations)
+  Double_t fAngMisAligM;     ///< Angular displacement mean (rotations)
+  Double_t fAngMisAligW;     ///< Angular displacement range (rotations)
+  Double_t fXYAngMisAligFactor; ///< factor (<1) to apply to angular misalignment range since range of motion is restricted out of the xy plane
+  Double_t fZCartMisAligFactor; ///< factor (<1) to apply to cartetian misalignment range since range of motion is restricted in z direction
+  TRandom *fDisplacementGenerator;  ///< random number generator for the displacements
   
   ClassDef(AliMUONGeometryMisAligner,3)        // Geometry parametrisation
 };