ROOT » GEOM » GEOM » TGeoHMatrix

class TGeoHMatrix: public TGeoMatrix

 Geometrical transformation package.

   All geometrical transformations handled by the modeller are provided as a
 built-in package. This was designed to minimize memory requirements and
 optimize performance of point/vector master-to-local and local-to-master
 computation. We need to have in mind that a transformation in TGeo has 2
 major use-cases. The first one is for defining the placement of a volume
 with respect to its container reference frame. This frame will be called
 'master' and the frame of the positioned volume - 'local'. If T is a
 transformation used for positioning volume daughters, then:

          MASTER = T * LOCAL

   Therefore a local-to-master conversion will be performed by using T, while
 a master-to-local by using its inverse. The second use case is the computation
 of the global transformation of a given object in the geometry. Since the
 geometry is built as 'volumes-inside-volumes', this global transformation
 represent the pile-up of all local transformations in the corresponding
 branch. The conversion from the global reference frame and the given object
 is also called master-to-local, but it is handled by the manager class.
   A general homogenous transformation is defined as a 4x4 matrix embeeding
 a rotation, a translation and a scale. The advantage of this description
 is that each basic transformation can be represented as a homogenous matrix,
 composition being performed as simple matrix multiplication.
   Rotation:                      Inverse rotation:
         r11  r12  r13   0              r11  r21  r31   0
         r21  r22  r23   0              r12  r22  r32   0
         r31  r32  r33   0              r13  r23  r33   0
          0    0    0    1               0    0    0    1

   Translation:                   Inverse translation:
          1    0    0    tx               1    0    0   -tx
          0    1    0    ty               0    1    0   -ty
          0    0    1    tz               0    0    1   -tz
          0    0    0    1                0    0    0   1

   Scale:                         Inverse scale:
          sx   0    0    0              1/sx  0    0    0
          0    sy   0    0               0   1/sy  0    0
          0    0    sz   0               0    0   1/sz  0
          0    0    0    1               0    0    0    1

  where: rij are the 3x3 rotation matrix components,
         tx, ty, tz are the translation components
         sx, sy, sz are arbitrary scale constants on the eacks axis,

   The disadvantage in using this approach is that computation for 4x4 matrices
 is expensive. Even combining two translation would become a multiplication
 of their corresponding matrices, which is quite an undesired effect. On the
 other hand, it is not a good idea to store a translation as a block of 16
 numbers. We have therefore chosen to implement each basic transformation type
 as a class deriving from the same basic abstract class and handling its specific
 data and point/vector transformation algorithms.

/* */

 The base class TGeoMatrix defines abstract metods for:

 - translation, rotation and scale getters. Every derived class stores only
   its specific data, e.g. a translation stores an array of 3 doubles and a
   rotation an array of 9. However, asking which is the rotation array of a
   TGeoTranslation through the base TGeoMatrix interface is a legal operation.
   The answer in this case is a pointer to a global constant array representing
   an identity rotation.
      Double_t *TGeoMatrix::GetTranslation()
      Double_t *TGeoMatrix::GetRotation()
      Double_t *TGeoMatrix::GetScale()

 - MasterToLocal() and LocalToMaster() point and vector transformations :
      void      TGeoMatrix::MasterToLocal(const Double_t *master, Double_t *local)
      void      TGeoMatrix::LocalToMaster(const Double_t *local, Double_t *master)
      void      TGeoMatrix::MasterToLocalVect(const Double_t *master, Double_t *local)
      void      TGeoMatrix::LocalToMasterVect(const Double_t *local, Double_t *master)
   These allow correct conversion also for reflections.
 - Transformation type getters :
      Bool_t    TGeoMatrix::IsIdentity()
      Bool_t    TGeoMatrix::IsTranslation()
      Bool_t    TGeoMatrix::IsRotation()
      Bool_t    TGeoMatrix::IsScale()
      Bool_t    TGeoMatrix::IsCombi() (translation + rotation)
      Bool_t    TGeoMatrix::IsGeneral() (translation + rotation + scale)

   Combinations of basic transformations are represented by specific classes
 deriving from TGeoMatrix. In order to define a matrix as a combination of several
 others, a special class TGeoHMatrix is provided. Here is an example of matrix
 creation :

 Matrix creation example:

   root[0] TGeoRotation r1,r2;
           r1.SetAngles(90,0,30);        // rotation defined by Euler angles
           r2.SetAngles(90,90,90,180,0,0); // rotation defined by GEANT3 angles
           TGeoTranslation t1(-10,10,0);
           TGeoTranslation t2(10,-10,5);
           TGeoCombiTrans c1(t1,r1);
           TGeoCombiTrans c2(t2,r2);
           TGeoHMatrix h = c1 * c2; // composition is done via TGeoHMatrix class
   root[7] TGeoHMatrix *ph = new TGeoHMatrix(hm); // this is the one we want to
                                                // use for positioning a volume
   root[8] ph->Print();

           pVolume->AddNode(pVolDaughter,id,ph) // now ph is owned by the manager

 Rule for matrix creation:
  - unless explicitly used for positioning nodes (TGeoVolume::AddNode()) all
 matrices deletion have to be managed by users. Matrices passed to geometry
 have to be created by using new() operator and their deletion is done by
 TGeoManager class.

 Available geometrical transformations

   1. TGeoTranslation - represent a (dx,dy,dz) translation. Data members:
 Double_t fTranslation[3]. Translations can be added/subtracted.
         TGeoTranslation t1;
         TGeoTranslation *t2 = new TGeoTranslation(4,3,10);

   2. Rotations - represent a pure rotation. Data members: Double_t fRotationMatrix[3*3].
 Rotations can be defined either by Euler angles, either, by GEANT3 angles :
         TGeoRotation *r1 = new TGeoRotation();
         r1->SetAngles(phi, theta, psi); // all angles in degrees
      This represent the composition of : first a rotation about Z axis with
      angle phi, then a rotation with theta about the rotated X axis, and
      finally a rotation with psi about the new Z axis.

         r1->SetAngles(th1,phi1, th2,phi2, th3,phi3)
      This is a rotation defined in GEANT3 style. Theta and phi are the spherical
      angles of each axis of the rotated coordinate system with respect to the
      initial one. This construction allows definition of malformed rotations,
      e.g. not orthogonal. A check is performed and an error message is issued
      in this case.

      Specific utilities : determinant, inverse.

   3. Scale transformations - represent a scale shrinking/enlargement. Data
      members :Double_t fScale[3]. Not fully implemented yet.

   4. Combined transformations - represent a rotation folowed by a translation.
      Data members: Double_t fTranslation[3], TGeoRotation *fRotation.
         TGeoRotation *rot = new TGeoRotation("rot",10,20,30);
         TGeoTranslation trans;

         TGeoCombiTrans *c1 = new TGeoCombiTrans(trans, rot);
         TGeoCombiTrans *c2 = new TGeoCombiTrans("somename",10,20,30,rot)

   5. TGeoGenTrans - combined transformations including a scale. Not implemented.
   6. TGeoIdentity - a generic singleton matrix representing a identity transformation
       NOTE: identified by the global variable gGeoIdentity.

Function Members (Methods)

voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidClear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
voidCopyFrom(const TGeoMatrix* other)
virtual voidTObject::Delete(Option_t* option = "")MENU
Double_tDeterminant() const
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
voidFastRotZ(const Double_t* sincos)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Int_tTGeoMatrix::GetByteCount() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
voidTGeoMatrix::GetHomogenousMatrix(Double_t* hmat) const
virtual const char*TObject::GetIconName() const
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
char*TGeoMatrix::GetPointerName() const
virtual const Double_t*GetRotationMatrix() const
virtual Double_t*GetRotationMatrix()
virtual const Double_t*GetScale() const
virtual Double_t*GetScale()
virtual const char*TNamed::GetTitle() const
virtual const Double_t*GetTranslation() const
virtual Double_t*GetTranslation()
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
virtual TGeoMatrix&Inverse() const
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
Bool_tTGeoMatrix::IsCombi() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTGeoMatrix::IsGeneral() const
Bool_tTGeoMatrix::IsIdentity() const
Bool_tTObject::IsOnHeap() const
Bool_tTGeoMatrix::IsReflection() const
Bool_tTGeoMatrix::IsRegistered() const
Bool_tTGeoMatrix::IsRotAboutZ() const
Bool_tTGeoMatrix::IsRotation() const
Bool_tTGeoMatrix::IsScale() const
Bool_tTGeoMatrix::IsShared() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTGeoMatrix::IsTranslation() const
Bool_tTObject::IsZombie() const
virtual voidTGeoMatrix::LocalToMaster(const Double_t* local, Double_t* master) const
virtual voidTGeoMatrix::LocalToMasterBomb(const Double_t* local, Double_t* master) const
virtual voidTGeoMatrix::LocalToMasterVect(const Double_t* local, Double_t* master) const
virtual voidTNamed::ls(Option_t* option = "") const
virtual TGeoMatrix*MakeClone() const
virtual voidTGeoMatrix::MasterToLocal(const Double_t* master, Double_t* local) const
virtual voidTGeoMatrix::MasterToLocalBomb(const Double_t* master, Double_t* local) const
virtual voidTGeoMatrix::MasterToLocalVect(const Double_t* master, Double_t* local) const
voidTObject::MayNotUse(const char* method) const
voidMultiply(const TGeoMatrix* right)
voidMultiplyLeft(const TGeoMatrix* left)
static voidTGeoMatrix::Normalize(Double_t* vect)
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
voidTObject::operator delete(void* ptr)
voidTObject::operator delete(void* ptr, void* vp)
voidTObject::operator delete[](void* ptr)
voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TGeoMatrix&TGeoMatrix::operator*(const TGeoMatrix& right) const
TGeoHMatrix&operator*=(const TGeoMatrix& matrix)
TGeoHMatrix&operator=(const TGeoMatrix* matrix)
TGeoHMatrix&operator=(const TGeoMatrix& matrix)
TGeoHMatrix&operator=(const TGeoHMatrix& other)
Bool_tTGeoMatrix::operator==(const TGeoMatrix& other) const
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTGeoMatrix::Print(Option_t* option = "") constMENU
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
virtual voidReflectX(Bool_t leftside, Bool_t rotonly = kFALSE)
virtual voidReflectY(Bool_t leftside, Bool_t rotonly = kFALSE)
virtual voidReflectZ(Bool_t leftside, Bool_t rotonly = kFALSE)
virtual voidTGeoMatrix::RegisterYourself()
voidTObject::ResetBit(UInt_t f)
virtual voidRotateX(Double_t angle)
virtual voidRotateY(Double_t angle)
virtual voidRotateZ(Double_t angle)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidSavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
virtual voidSetDx(Double_t dx)
virtual voidSetDy(Double_t dy)
virtual voidSetDz(Double_t dz)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetRotation(const Double_t* matrix)
voidSetScale(const Double_t* scale)
voidTGeoMatrix::SetShared(Bool_t flag = kTRUE)
virtual voidTNamed::SetTitle(const char* title = "")MENU
voidSetTranslation(const Double_t* vect)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp) const
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
TGeoHMatrix(const TGeoMatrix& matrix)
TGeoHMatrix(const char* name)
TGeoHMatrix(const TGeoHMatrix&)
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const

Data Members

static TObject::(anonymous)TObject::kBitMask
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoCombiTrans
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoGenTrans
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoIdentity
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoMatrixOwned
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoReflection
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoRegistered
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoRotation
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoSavePrimitive
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoScale
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoShared
static TGeoMatrix::EGeoTransfTypesTGeoMatrix::kGeoTranslation
static TObject::EStatusBitsTObject::kHasUUID
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TObject::EStatusBitsTObject::kMustCleanup
static TObject::EStatusBitsTObject::kNoContextMenu
static TObject::(anonymous)TObject::kNotDeleted
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TObject::(anonymous)TObject::kSingleKey
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie
TStringTNamed::fNameobject identifier
TStringTNamed::fTitleobject title
Double_tfRotationMatrix[9]rotation matrix
Double_tfScale[3]scale component
Double_tfTranslation[3]translation component

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

 dummy ctor
TGeoHMatrix(const char* name)
TGeoHMatrix(const TGeoMatrix& matrix)
TGeoHMatrix & operator=(const TGeoMatrix* matrix)
TGeoHMatrix & operator=(const TGeoMatrix& matrix)
void CopyFrom(const TGeoMatrix* other)
 Fast copy method.
void Clear(Option_t* option = "")
 clear the data for this matrix
TGeoMatrix * MakeClone() const
 Make a clone of this matrix.
void FastRotZ(const Double_t* sincos)
 Perform a rotation about Z having the sine/cosine of the rotation angle.
TGeoMatrix& Inverse() const
 Return a temporary inverse of this.
Double_t Determinant() const
 computes determinant of the rotation matrix
void Multiply(const TGeoMatrix* right)
 multiply to the right with an other transformation
 if right is identity matrix, just return
void MultiplyLeft(const TGeoMatrix* left)
 multiply to the left with an other transformation
 if right is identity matrix, just return
void RotateX(Double_t angle)
 Rotate about X axis with angle expressed in degrees.
void RotateY(Double_t angle)
 Rotate about Y axis with angle expressed in degrees.
void RotateZ(Double_t angle)
 Rotate about Z axis with angle expressed in degrees.
void ReflectX(Bool_t leftside, Bool_t rotonly = kFALSE)
 Multiply by a reflection respect to YZ.
void ReflectY(Bool_t leftside, Bool_t rotonly = kFALSE)
 Multiply by a reflection respect to ZX.
void ReflectZ(Bool_t leftside, Bool_t rotonly = kFALSE)
 Multiply by a reflection respect to XY.
void SavePrimitive(ostream& out, Option_t* option = "")
 Save a primitive as a C++ statement(s) on output stream "out".
TGeoMatrix& operator=(const TGeoMatrix& matrix)
 Preventing warnings with -Weffc++ in GCC since the behaviour of operator * was chosen so by design.
const Double_t * GetTranslation() const
const Double_t * GetRotationMatrix() const
const Double_t * GetScale() const
void SetDx(Double_t dx)
void SetDy(Double_t dy)
void SetDz(Double_t dz)
void SetTranslation(Double_t dx, Double_t dy, Double_t dz)
const Double_t * GetTranslation() const
{return &fTranslation[0];}
const Double_t * GetRotationMatrix() const
{return &kIdentityMatrix[0];}
const Double_t * GetScale() const
{return &kUnitScale[0];}
void SetRotation(const Double_t* matrix)
void SetScale(Double_t sx, Double_t sy, Double_t sz)
TGeoHMatrix& operator*=(const TGeoMatrix& matrix)