Updated comments (Raffaele)
authorhristov <hristov@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 17 Oct 2006 15:58:36 +0000 (15:58 +0000)
committerhristov <hristov@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 17 Oct 2006 15:58:36 +0000 (15:58 +0000)
STEER/AliAlignObj.h
STEER/AliAlignObjAngles.cxx
STEER/AliAlignObjMatrix.cxx

index 7c507d4..aea6f09 100644 (file)
@@ -2,11 +2,14 @@
 #define ALIALIGNOBJ_H
 
 //************************************************************************
-// AliAlignObj: alignment base class for the storage of alignment        *
-//   information for a single volume, that is a displacement (a shift    *
-//   a rotation) plus the identity of the volume itself in form of a     *
-//   symbolic volume name (eventually a TGeo path) and as a unique       *
-//   integer identifier                                                  *
+// AliAlignObj: alignment base class for the storage of the alignment    *
+//   constants for a single volume:                                      *
+//   -  a displacement (a shift and a rotation) either as                *
+//      - the 6 doubles which identify it or as                          *
+//      - the matrix which identifies it                                 *
+//   -  the identity of the volume itself in form of a symbolic volume   *
+//      name for alignable volumes, in form of a TGeo path otherwise,    *
+//      and as a unique integer identifier                               *
 //************************************************************************
 #include "TObject.h"
 #include "TString.h"
@@ -101,7 +104,7 @@ class AliAlignObj : public TObject {
 
   //Volume identifiers
   TString  fVolPath; // Symbolic volume name; in case could coincide with
-                     // the volume path inside TGeo geometry
+      // the volume path inside TGeo geometry (for non-alignable volumes)
   UShort_t fVolUID;  // Unique volume ID
 
   static Int_t       fgLayerSize[kLastLayer - kFirstLayer]; // Size of layers
index 8e73b1c..704e858 100644 (file)
@@ -21,7 +21,6 @@
 
 #include "AliAlignObj.h"
 #include "AliAlignObjAngles.h"
-//#include "AliLog.h"
 
 ClassImp(AliAlignObjAngles)
 
@@ -109,6 +108,9 @@ AliAlignObjAngles::~AliAlignObjAngles()
 //_____________________________________________________________________________
 void AliAlignObjAngles::SetTranslation(const TGeoMatrix& m)
 {
+  // set the translation parameters extracting them from the matrix
+  // passed as argument
+  // 
   if(m.IsTranslation()){
     const Double_t* tr = m.GetTranslation();
     fTranslation[0]=tr[0];  fTranslation[1]=tr[1]; fTranslation[2]=tr[2];
@@ -120,6 +122,9 @@ void AliAlignObjAngles::SetTranslation(const TGeoMatrix& m)
 //_____________________________________________________________________________
 Bool_t AliAlignObjAngles::SetRotation(const TGeoMatrix& m)
 {
+  // set the rotation parameters extracting them from the matrix
+  // passed as argument
+  // 
   if(m.IsRotation()){
     const Double_t* rot = m.GetRotationMatrix();
     return MatrixToAngles(rot,fRotation);
@@ -132,6 +137,7 @@ Bool_t AliAlignObjAngles::SetRotation(const TGeoMatrix& m)
 //_____________________________________________________________________________
 void AliAlignObjAngles::GetMatrix(TGeoHMatrix& m) const
 {
+  // get the transformation matrix from the data memebers parameters
   m.SetTranslation(&fTranslation[0]);
   Double_t rot[9];
   AnglesToMatrix(fRotation,rot);
@@ -141,8 +147,9 @@ void AliAlignObjAngles::GetMatrix(TGeoHMatrix& m) const
 //_____________________________________________________________________________
 AliAlignObj& AliAlignObjAngles::Inverse() const
 {
-  // Return a temporary inverse of the alignment
-  // object. This means 'mis
+  // Return a temporary "inverse" of the alignment object, that is return
+  // an object with inverted transformation matrix.
+  //
    static AliAlignObjAngles a;
    a = *this;
 
index 6dfe9e8..f1052c6 100644 (file)
@@ -21,7 +21,6 @@
 
 #include "AliAlignObj.h"
 #include "AliAlignObjMatrix.h"
-//#include "AliLog.h"
 
 ClassImp(AliAlignObjMatrix)
 
@@ -115,6 +114,9 @@ AliAlignObjMatrix::~AliAlignObjMatrix()
 //_____________________________________________________________________________
 void AliAlignObjMatrix::SetTranslation(Double_t x, Double_t y, Double_t z)
 {
+  // set the translation coefficients of the data member matrix
+  // from the parameters passed as arguments
+  // 
   Double_t tr[3];
   tr[0]=x; tr[1]=y; tr[2]=z;
   fMatrix.SetTranslation(tr);
@@ -123,6 +125,9 @@ void AliAlignObjMatrix::SetTranslation(Double_t x, Double_t y, Double_t z)
 //_____________________________________________________________________________
 void AliAlignObjMatrix::SetTranslation(const TGeoMatrix& m)
 {
+  // set the translation coefficients of the data member matrix
+  // from the matrix passed as argument
+  // 
   const Double_t *tr = m.GetTranslation();
   fMatrix.SetTranslation(tr);
 }
@@ -130,6 +135,8 @@ void AliAlignObjMatrix::SetTranslation(const TGeoMatrix& m)
 //_____________________________________________________________________________
 void AliAlignObjMatrix::SetRotation(Double_t psi, Double_t theta, Double_t phi)
 {
+  // set the rotation parameters from the parameters passed as arguments
+  // 
   Double_t angles[3] = {psi, theta, phi};
   Double_t rot[9];
   AnglesToMatrix(angles,rot);
@@ -139,6 +146,9 @@ void AliAlignObjMatrix::SetRotation(Double_t psi, Double_t theta, Double_t phi)
 //_____________________________________________________________________________
 Bool_t AliAlignObjMatrix::SetRotation(const TGeoMatrix& m)
 {
+  // set the rotation coefficients of the data member matrix
+  // from the matrix passed as argument
+  // 
   const Double_t* rot = m.GetRotationMatrix();
   fMatrix.SetRotation(rot);
   return kTRUE;
@@ -176,8 +186,9 @@ void AliAlignObjMatrix::GetMatrix(TGeoHMatrix& m) const
 //_____________________________________________________________________________
 AliAlignObj& AliAlignObjMatrix::Inverse() const
 {
-  // Return a temporary inverse of the alignment
-  // object. This means 'mis
+  // Return a temporary "inverse" of the alignment object, that is return
+  // an object with inverted transformation matrix.
+  //
    static AliAlignObjMatrix a;
    a = *this;