GeometryTGeo.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef ALICEO2_TRK_GEOMETRYTGEO_H
#define ALICEO2_TRK_GEOMETRYTGEO_H
 
#include <memory>
#include <DetectorsCommonDataFormats/DetMatrixCache.h>
#include "DetectorsCommonDataFormats/DetID.h"
#include "TRKBase/TRKBaseParam.h"
 
namespace o2
{
namespace trk
{
class GeometryTGeo : public o2::detectors::DetMatrixCache
{
 public:
  using Mat3D = o2::math_utils::Transform3D;
  using DetMatrixCache::getMatrixL2G;
  using DetMatrixCache::getMatrixT2GRot;
  using DetMatrixCache::getMatrixT2L;
  // this method is not advised for ITS: for barrel detectors whose tracking frame is just a rotation
  // it is cheaper to use T2GRot
  using DetMatrixCache::getMatrixT2G;
  GeometryTGeo(bool build = false, int loadTrans = 0);
  ~GeometryTGeo();
  void Build(int loadTrans);
  void fillMatrixCache(int mask);
  static GeometryTGeo* Instance()
  {
    if (!sInstance) {
      sInstance = std::make_unique<GeometryTGeo>(true, 0);
    }
    return sInstance.get();
  };
 
  static const char* getFT3VolPattern() { return sFT3VolumeName.c_str(); }
  static const char* getFT3InnerVolPattern() { return sFT3InnerVolumeName.c_str(); }
  static const char* getFT3LayerPattern() { return sFT3LayerName.c_str(); }
  static const char* getFT3ChipPattern() { return sFT3ChipName.c_str(); }
  static const char* getFT3PassivePattern() { return sFT3PassiveName.c_str(); }
  static const char* getFT3SensorPattern() { return sFT3SensorName.c_str(); }
  static const char* getTRKVolPattern() { return sVolumeName.c_str(); }
  static const char* getTRKServiceVolPattern() { return sServiceVolName.c_str(); }
  static const char* getTRKLayerPattern() { return sLayerName.c_str(); }
  static const char* getTRKPetalAssemblyPattern() { return sPetalAssemblyName.c_str(); }
  static const char* getTRKPetalPattern() { return sPetalName.c_str(); }
  static const char* getTRKPetalDiskPattern() { return sPetalDiskName.c_str(); }
  static const char* getTRKPetalLayerPattern() { return sPetalLayerName.c_str(); }
  static const char* getTRKStavePattern() { return sStaveName.c_str(); }
  static const char* getTRKHalfStavePattern() { return sHalfStaveName.c_str(); }
  static const char* getTRKModulePattern() { return sModuleName.c_str(); }
  static const char* getTRKChipPattern() { return sChipName.c_str(); }
  static const char* getTRKSensorPattern() { return sSensorName.c_str(); }
  static const char* getTRKDeadzonePattern() { return sDeadzoneName.c_str(); }
  static const char* getTRKMetalStackPattern() { return sMetalStackName.c_str(); }
 
  static const char* getTRKWrapVolPattern() { return sWrapperVolumeName.c_str(); }
 
  int getNumberOfChips() const { return mSize; }
 
  int extractNumberOfDisksMLOT(int dir) const;
  int extractNumberOfLayersMLOT();
  int extractNumberOfLayersVD() const;
  int extractNumberOfPetalsVD() const;
  int extractNumberOfActivePartsVD() const;
  int extractNumberOfDisksVD() const;
  int extractNumberOfChipsPerPetalVD() const;
  int extractNumberOfStavesMLOT(int lay) const;
  int extractNumberOfHalfStavesMLOT(int lay) const;
  int extractNumberOfModulesMLOT(int lay) const;
  int extractNumberOfChipsMLOT(int lay) const;
 
  void extractChipIdsFT3(std::string const volName, int& layer, int& stave, int& chip) const;
  int extractVolumeCopy(const char* name, const char* prefix) const;
 
  int getNumberOfLayersMLOT() const { return mNumberOfLayersMLOT; }
  int getNumberOfActivePartsVD() const { return mNumberOfActivePartsVD; }
  int getNumberOfHalfStaves(int lay) const { return mNumberOfHalfStaves[lay]; }
 
  int getNumberOfDisksMLOT() const { return mNumberOfDisksMLOT; }
  int getNumberOfStavesInDisk(int lay) const { return mFirstStaveIndexDisc[lay + 1] - mFirstStaveIndexDisc[lay]; }
  bool isOwner() const { return mOwner; }
  void setOwner(bool v) { mOwner = v; }
 
  void Print(Option_t* opt = "") const;
  void PrintChipID(int index, int subDetID, int petalcase, int disk, int lay, int stave, int halfstave, int mod, int chip) const;
 
  int getSubDetID(int index) const;
  int getPetalCase(int index) const;
  int getDisk(int index) const;
  int getLayer(int index) const;    
  int getLayerTRK(int index) const; 
  int getStave(int index) const;
  int getHalfStave(int index) const;
  int getModule(int index) const;
  int getChip(int index) const;
 
  void defineMLOTSensors();
  int getBarrelLayer(int) const;
 
  // sensor ref X and alpha for ML & OT
  void extractSensorXAlphaMLOT(int, float&, float&);
 
  // cache for tracking frames (ML & OT)
  bool isTrackingFrameCachedMLOT() const { return !mCacheRefXMLOT.empty(); }
  void fillTrackingFramesCacheMLOT();
 
  float getSensorRefAlphaMLOT(int chipId) const
  {
    if (getSubDetID(chipId) == 0) {
      LOG(error) << "getSensorRefAlphaMLOT(): VD layers are not supported yet! chipID = " << chipId
                 << "please provide chipId for ML/OT! ";
      return std::numeric_limits<float>::quiet_NaN();
    }
    const int local = chipId - getNumberOfActivePartsVD();
    return mCacheRefAlphaMLOT[local];
  }
 
  float getSensorXMLOT(int chipId) const
  {
    if (getSubDetID(chipId) == 0) {
      LOG(error) << "getSensorXMLOT(): VD layers are not supported yet! chipID = " << chipId
                 << "please provide chipId for ML/OT! ";
      return std::numeric_limits<float>::quiet_NaN();
    }
    const int local = chipId - getNumberOfActivePartsVD();
    return mCacheRefXMLOT[local];
  }
 
  // create matrix for tracking to local frame for MLOT
  TGeoHMatrix& createT2LMatrixMLOT(int);
 
  unsigned short getChipIndex(int subDetID, int petalcase, int disk, int lay, int stave, int halfstave, int mod, int chip) const;
 
  unsigned short getChipIndex(int subDetID, int volume, int lay, int stave, int halfstave, int mod, int chip) const;
 
  bool getChipID(int index, int& subDetID, int& petalcase, int& disk, int& lay, int& stave, int& halfstave, int& mod, int& chip) const;
 
  unsigned short getLastChipIndex(int lay) const { return mLastChipIndex[lay]; }
  unsigned short getFirstChipIndex(int lay, int petalcase, int subDetID) const
  {
    if (subDetID == 0) { // VD
      return (petalcase == 0) ? 0 : mLastChipIndexVD[petalcase - 1] + 1;
    } else if (subDetID == 1) { // MLOT
      return mLastChipIndex[lay + mNumberOfPetalsVD - 1] + 1;
    } else if (subDetID == 2) {
      return mFirstChipIndexMLOTDisc[lay];
    }
    return -1; // not found
  }
 
  TGeoHMatrix* extractMatrixSensor(int index) const;
 
  TString getMatrixPath(int index) const;
 
#ifdef ENABLE_UPGRADES
  static const char* composeSymNameTRK(int d)
  {
    return Form("%s_%d", o2::detectors::DetID(o2::detectors::DetID::TRK).getName(), d);
  }
#endif
 
  static const char* composeSymNameLayer(int d, int layer);
  static const char* composeSymNameLayerFT3(int dir, int layer);
  static const char* composeSymNameStave(int d, int layer);
  static const char* composeSymNameModule(int d, int layer);
  static const char* composeSymNameChip(int d, int layer);
  static const char* composeSymNameSensor(int d, int layer);
 
 protected:
  static constexpr int MAXLAYERS = 25; 
 
  static std::string sVolumeName;
  static std::string sServiceVolName;
  static std::string sLayerName;
  static std::string sPetalAssemblyName;
  static std::string sPetalName;
  static std::string sPetalDiskName;
  static std::string sPetalLayerName;
  static std::string sStaveName;
  static std::string sHalfStaveName;
  static std::string sModuleName;
  static std::string sChipName;
  static std::string sSensorName;
  static std::string sDeadzoneName;
  static std::string sMetalStackName;
 
  static std::string sWrapperVolumeName; 
 
  static std::string sFT3InnerVolumeName; 
  static std::string sFT3VolumeName;      
  static std::string sFT3LayerName;       
  static std::string sFT3ChipName;        
  static std::string sFT3PassiveName;     
  static std::string sFT3SensorName;      
 
  Int_t mNumberOfLayersMLOT;                   
  Int_t mNumberOfDisksMLOT;                    
  Int_t mNumberOfActivePartsVD;                
  Int_t mNumberOfLayersVD;                     
  Int_t mNumberOfPetalsVD;                     
  Int_t mNumberOfDisksVD;                      
  std::vector<int> mNumberOfStaves;            
  std::vector<int> mNumberOfStavesMLOTDDiscs;  
  std::vector<int> mNumberOfHalfStaves;        
  std::vector<int> mNumberOfModules;           
  std::vector<int> mNumberOfChips;             
  std::vector<int> mNumberOfChipsPerLayerVD;   
  std::vector<int> mNumberOfChipsPerLayerMLOT; 
  std::vector<int> mNumberOfChipPerDiskMLOT;   
  std::vector<int> mNumbersOfChipPerDiskVD;    
  std::vector<int> mNumberOfChipsPerPetalVD;   
  // std::vector<int> mNumberOfChipsPerStave;     ///< number of chips per stave in ML/OT
  // std::vector<int> mNumberOfChipsPerHalfStave; ///< number of chips per half stave in ML/OT
  // std::vector<int> mNumberOfChipsPerModule; ///< number of chips per module in ML/OT
  std::vector<unsigned short> mLastChipIndex;   
  std::vector<unsigned short> mLastChipIndexVD; 
  // std::vector<unsigned short> mLastChipIndexMLOT; ///< max ID of the detector in the layer for the MLOT
  std::vector<unsigned short> mFirstChipIndexMLOTDisc; 
  std::vector<unsigned short> mFirstStaveIndexDisc;    
  std::vector<unsigned short> mFirstChipIndexStave;    
  std::array<char, MAXLAYERS> mLayerToWrapper; 
 
  bool mOwner = true; 
 
  std::vector<int> sensorsMLOT;
  std::vector<float> mCacheRefXMLOT;     
  std::vector<float> mCacheRefAlphaMLOT; 
 
  eMLOTLayout mLayoutMLOT; // ML and OT detector layout design
 
 private:
  static std::unique_ptr<o2::trk::GeometryTGeo> sInstance;
};
 
} // namespace trk
} // namespace o2
#endif