TGCSensitiveDetector Class Reference

#include <TGCSensitiveDetector.h>

Inheritance diagram for TGCSensitiveDetector:

Collaboration diagram for TGCSensitiveDetector:

Public Member Functions
	TGCSensitiveDetector (const std::string &name, const std::string &hitCollectionName)
	construction/destruction
void	Initialize (G4HCofThisEvent *HCE) override final
	member functions
G4bool	ProcessHits (G4Step *aStep, G4TouchableHistory *ROHist) override final

Private Member Functions
	FRIEND_TEST (TGCSensitiveDetectortest, Initialize)
	FRIEND_TEST (TGCSensitiveDetectortest, ProcessHits)

Private Attributes
std::string	m_hitCollectionName
	member data
TGCSimHitCollection *	m_myTGCHitColl {nullptr}
AtlasG4EventUserInfo *	m_g4UserEventInfo {nullptr}
const TgcHitIdHelper *	m_muonHelper

Detailed Description

Author

haseg.nosp@m.awa@.nosp@m.azusa.nosp@m..shi.nosp@m.nshu-.nosp@m.u.ac.nosp@m..jp

Class methods and properties

The method TGCSensitiveDetector::ProcessHits is executed by the G4 kernel each time a charged particle (or a geantino) crosses one of the TGC Gas volumes.

Navigating with the touchableHistory method GetHistoryDepth() through the hierarchy of the volumes crossed by the particles, the TGCSensitiveDetector determinates the correct set of geometry parameters to be folded in the Simulation Identifier associated to each hit. The TGC SimIDs are 32-bit unsigned integers, built using the MuonSimEvent/TgcHitIdHelper class which inherits from the MuonHitIdHelper base class.

We describe in the following, how each field of the identifier is retrieved.

1) stationName and stationPhi: when a volume is found in the hierarchy, whose name contains the substring "station", the stationName is extracted from the volume's name; stationPhi is calculated starting from the volume copy number assigned by MuonGeoModel. Separate cases when the station are "F" or "E" type.

2) stationEta: when a volume is found in the hierarchy, whose name contains the substring "tgccomponent", stationEta is calculated starting from the volume copy number assigned by MuonGeoModel. Possibility to calculate the stationPhi at this level, from the copy number assigned by MuonGeoModel (if the copyNo > 1000).

3) gasGap: when a volume is found in the hierarchy, whose name contains the substring "Gas Volume Layer" or "TGCGas", the gasGap is calculated from the volume copy number, according to the positive or negative Z value, in the Atlas global reference system.

@section Some notes:

1) since the volume copy numbers strongly depend on the database layout, the volume name (whether it contains the string "Q02", for instance) is used to retrieve geometry information. In the year 2018 and even some years before there are not any more other database layouts / volumes than MUONQ02 and therefore some logic was removed

2) for each hit, the time of flight (the G4 globalTime), is recorded and associated to the hit.

3) the TGCHit object contains: the SimID, the globalTime, the hit position in the local reference system, the track director cosine in the local reference system and the track identifier.

Definition at line 73 of file TGCSensitiveDetector.h.

Constructor & Destructor Documentation

TGCSensitiveDetector()

TGCSensitiveDetector::TGCSensitiveDetector	(	const std::string &	name,
		const std::string &	hitCollectionName )

construction/destruction

Definition at line 18 of file TGCSensitiveDetector.cxx.

  : G4VSensitiveDetector( name )
  , m_hitCollectionName( hitCollectionName )
{
  m_muonHelper = TgcHitIdHelper::GetHelper();
}

Member Function Documentation

FRIEND_TEST() [1/2]

TGCSensitiveDetector::FRIEND_TEST ( TGCSensitiveDetectortest , Initialize  )

private

FRIEND_TEST() [2/2]

TGCSensitiveDetector::FRIEND_TEST ( TGCSensitiveDetectortest , ProcessHits  )

private

Initialize()

void TGCSensitiveDetector::Initialize ( G4HCofThisEvent * HCE )

finaloverride

member functions

Definition at line 26 of file TGCSensitiveDetector.cxx.

{
  m_myTGCHitColl = nullptr;
  if (auto* eventInfo = AtlasG4EventUserInfo::GetEventUserInfo()) {
    m_myTGCHitColl = eventInfo->GetHitCollectionMap()->Find<TGCSimHitCollection>(m_hitCollectionName);
    m_g4UserEventInfo = eventInfo;
  }
}

ProcessHits()

G4bool TGCSensitiveDetector::ProcessHits ( G4Step * aStep, G4TouchableHistory * ROHist )

finaloverride

Definition at line 35 of file TGCSensitiveDetector.cxx.

                                                                          {
 
  if (!m_myTGCHitColl) {
    G4Exception("TGCSensitiveDetector::ProcessHits", "TGCHitCollectionMissing", FatalException,
                "Hit collection not initialized; did SetupEvent run?");
    return false;
  }
 
  G4Track* track = aStep->GetTrack();
 
  if (track->GetDefinition()->GetPDGCharge() == 0.0) {
    if (track->GetDefinition()!=G4Geantino::GeantinoDefinition()) return true;
    else if (track->GetDefinition()==G4ChargedGeantino::ChargedGeantinoDefinition()) return true;
  }
  const G4TouchableHistory* touchHist = static_cast<const G4TouchableHistory*>(aStep->GetPreStepPoint()->GetTouchable());
  G4ThreeVector           position  = aStep->GetPreStepPoint()->GetPosition();
  const G4AffineTransform trans     = track->GetTouchable()->GetHistory()->GetTopTransform();
 
  // fields for the TGC identifier construction
  std::string stationName;
  int stationEta(0);
  int stationPhi(0);
  int gasGap = 0;
 
  // TGC hit information
  double globalTime        = aStep->GetPreStepPoint()->GetGlobalTime();
  Amg::Vector3D localPosition = Amg::Hep3VectorToEigen( trans.TransformPoint(position) );
  G4ThreeVector direcos    = aStep->GetPreStepPoint()->GetMomentumDirection();
  Amg::Vector3D localDireCos  = Amg::Hep3VectorToEigen( trans.TransformAxis(direcos) );
 
  // scan geometry tree to identify hit channel
  int zside(0);
  bool isAssembly = false;
  for (int i=touchHist->GetHistoryDepth();i>=0;i--) {
 
    std::string::size_type npos;
    std::string::size_type nposStat;
    std::string volName = touchHist->GetVolume(i)->GetName();
 
    // check if this station is an assembly
    if ((npos = volName.find("av_")) != std::string::npos &&
        (npos = volName.find("impr_")) != std::string::npos)  isAssembly = true;
 
    // stationName and stationPhi
    if ((npos = volName.find("station")) != std::string::npos && (!isAssembly)) {
 
      stationName   = volName.substr(0,npos-2);
      int volCopyNo = touchHist->GetVolume(i)->GetCopyNo();
      if (volCopyNo > 0) {
        zside = 1;
      } else {
        zside = -1;
      }
      if (stationName.at(2) == 'F') {
 
        stationPhi    = (abs(volCopyNo%100)-1)*3;
        if (abs(volCopyNo/100) > 3) {
          stationPhi += abs(volCopyNo/100)-3;
        } else {
          stationPhi += abs(volCopyNo/100);
        }
 
        stationPhi -= 1;
        if (stationPhi <= 0) {
          stationPhi = 24 - stationPhi;
        }
 
      } else if (stationName.at(2) == 'E') {
        if (stationName.at(1) == '4') {
 
          stationPhi = (abs(volCopyNo%100)-1)*3+abs(volCopyNo/100);
 
          if (abs(volCopyNo%100) < 4) {
            stationPhi = stationPhi - 1;
            if (stationPhi <= 0) {
              stationPhi = 21 - stationPhi;
            }
          } else if(abs(volCopyNo%100) < 7) {
            stationPhi = stationPhi - 1 - 1;
          } else {
            stationPhi = stationPhi - 2 - 1;
          }
 
        } else {
 
          stationPhi = (abs(volCopyNo%100)-1)*6+abs(volCopyNo/100);
 
          stationPhi -= 2;
          if (stationPhi <= 0) {
            stationPhi = 48 - stationPhi;
          }
        }
      }
    } else if ((nposStat = volName.find("impr_")) != std::string::npos &&
               (npos = volName.find("TGC")) != std::string::npos  && isAssembly ) {
      // vol name for Assembly components are
      // av_WWW_impr_XXX_Muon::BMSxMDTxx_pv_ZZZ_NAME
      //         where WWW is ass. istance nr.
      //               XXX is comp. imprint nr.
      //               BMSxMDTxx is the name of the comp. log.Vol.
      //                  x station sub-type; xx technology subtype
      //               ZZZ is No of order of this daugther
      //               NAME is the comp. tag (geoIdentifierTag)
      //               for TGCs it is stPhiJob[aaa] with
      //               aaa = 1000*stationPhi+Job;
      // copy numbers for Ass.components are =
      //                CopyNoBase(= geoIdentifierTag of the assembly) + geoIdentifierTag of the component
      //                geoIdentifierTag of the component = Job
      //                geoIdentifierTag of the assembly = (sideC*10000 +
      //                             mirsign*1000 + abs(zi)*100 + fi+1)*100000;
      //                             mirsign*1000 + abs(zi)*100 + fi+1)*100000;
      //                             mirsign = 1 if zi<0 and !mirrored; otherwise 0
      std::string::size_type loc1,loc2;
      if ((loc1 = volName.find("Muon::")) != std::string::npos) {
        stationName = volName.substr(loc1+6,3); //type only
      }
 
      int volCopyNo = touchHist->GetVolume(i)->GetCopyNo();
      int copyNrBase = int(volCopyNo/100000);
      int sideC  = int(copyNrBase/10000);
      int zi     = int((copyNrBase%1000)/100);
      if (sideC == 1) zi = -zi;
      if (sideC) {
        zside = -1;
      } else {
        zside = 1;
      }
      if (stationName.at(2) == 'F') {
 
        stationPhi    = (abs(copyNrBase%100)-1)*3;
        if (abs(copyNrBase/100) > 3) {
          stationPhi += abs(copyNrBase/100)-3;
        } else {
          stationPhi += abs(copyNrBase/100);
        }
 
        stationPhi -= 1;
        if (stationPhi <= 0) {
          stationPhi = 24 - stationPhi;
        }
 
      } else if (stationName.at(2) == 'E') {
        if (stationName.at(1) == '4') {
 
          stationPhi = (abs(copyNrBase%100)-1)*3+abs(copyNrBase/100);
 
          if (abs(copyNrBase%100) < 4) {
            stationPhi = stationPhi - 1;
            if (stationPhi <= 0) {
              stationPhi = 21 - stationPhi;
            }
          } else if(abs(copyNrBase%100) < 7) {
            stationPhi = stationPhi - 1 - 1;
          } else {
            stationPhi = stationPhi - 2 - 1;
          }
        } else {
 
          stationPhi = (abs(copyNrBase%100)-1)*6+abs(copyNrBase/100);
 
          stationPhi -= 2;
          if (stationPhi <= 0) {
            stationPhi = 48 - stationPhi;
          }
        }
      }
 
      // now get the geoIdentifierTag of the rpc components
      int gmID = 0;
      if ((loc1 = volName.find('[')) != std::string::npos) {
        if ((loc2 = volName.find(']', loc1+1)) != std::string::npos) {
          std::istringstream istrvar(volName.substr(loc1+1,loc2-loc1-1));
          istrvar>>gmID;
        }
      }
      // stationEta, stationPhi
      stationEta = zside*int(gmID%100);
      if (gmID > 999) stationPhi = gmID/1000;
 
    // stationEta
    } else if ((npos = volName.find("tgccomponent")) != std::string::npos && (!isAssembly)) {
      int volCopyNo = abs(touchHist->GetVolume(i)->GetCopyNo());
      stationEta = zside*volCopyNo%100;
      if (volCopyNo > 1000) { // stationPhi overridden by the number assigned by MuonGeoModel
        stationPhi = volCopyNo/1000;
      }
    // gasGap
    } else if ((npos = volName.find("Gas Volume Layer")) != std::string::npos) {
      int volCopyNo = touchHist->GetVolume(i)->GetCopyNo();
      int iStation = atoi(stationName.substr(1,1).c_str());
      if (zside < 0) {
        if (iStation == 1)
          gasGap = 3-(volCopyNo-3)/4;
        else
          gasGap = 2-(volCopyNo-3)/4;
      } else {
//        if (iStation == 1)
          gasGap = (volCopyNo-3)/4+1;
//        else
//          gasGap = (volCopyNo-3)/4+1;
      }
    } else if ((npos = volName.find("TGCGas")) != std::string::npos) {
 
      int volCopyNo = touchHist->GetVolume(i)->GetCopyNo();
 
      if (volCopyNo != 0)
        gasGap = volCopyNo;
    }
 
  }
 
  //construct the hit identifier
  HitID TGCid = m_muonHelper->BuildTgcHitId(stationName,
                                          stationPhi,
                                          stationEta,
                                          gasGap);
  //m_muonHelper->Print(TGCid);
 
  // construct new tgc hit
  TrackHelper trHelp(aStep->GetTrack());
 
  m_myTGCHitColl->Emplace(TGCid,
                        globalTime,
                        localPosition,
                        localDireCos,
                        trHelp.GenerateParticleLink(m_g4UserEventInfo ? m_g4UserEventInfo->GetEventStore() : nullptr),
                        aStep->GetTotalEnergyDeposit(),
                        aStep->GetStepLength(),
                        track->GetDefinition()->GetPDGEncoding(),
                        aStep->GetPreStepPoint()->GetKineticEnergy());
  return true;
}

Member Data Documentation

m_g4UserEventInfo

AtlasG4EventUserInfo* TGCSensitiveDetector::m_g4UserEventInfo {nullptr}

private

Definition at line 89 of file TGCSensitiveDetector.h.

{nullptr};

m_hitCollectionName

std::string TGCSensitiveDetector::m_hitCollectionName

private

member data

Definition at line 87 of file TGCSensitiveDetector.h.

m_muonHelper

const TgcHitIdHelper* TGCSensitiveDetector::m_muonHelper

private

Definition at line 90 of file TGCSensitiveDetector.h.

m_myTGCHitColl

TGCSimHitCollection* TGCSensitiveDetector::m_myTGCHitColl {nullptr}

private

Definition at line 88 of file TGCSensitiveDetector.h.

{nullptr};

---

The documentation for this class was generated from the following files:

• TGCSensitiveDetector.h
• TGCSensitiveDetector.cxx