MuonG4R4::MmSensitiveDetector Class Reference

#include <MmSensitiveDetector.h>

Inheritance diagram for MuonG4R4::MmSensitiveDetector:

Collaboration diagram for MuonG4R4::MmSensitiveDetector:

Public Member Functions
	MmSensitiveDetector (const std::string &name, const std::string &output_key, const std::string &trf_storKey, const MuonGMR4::MuonDetectorManager *detMgr)
	Constructor. More...
	~MmSensitiveDetector ()=default
void	Initialize (G4HCofThisEvent *HCE) override final
	member functions More...
G4bool	ProcessHits (G4Step *aStep, G4TouchableHistory *ROhist) override final
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
const MuonGMR4::MmReadoutElement *	getReadoutElement (const ActsGeometryContext &gctx, const G4TouchableHistory *touchHist) const
	Retrieves the matching readout element to a G4 hit. More...
Identifier	getIdentifier (const ActsGeometryContext &gctx, const MuonGMR4::MmReadoutElement *readOutEle, const Amg::Vector3D &hitAtGapPlane) const
	Identify the gasGap layer of the hit. More...
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
SG::WriteHandle< xAOD::MuonSimHitContainer >	m_writeHandle
SG::ReadHandleKey< ActsTrk::DetectorAlignStore >	m_trfCacheKey
	ReadHandleKey to the DetectorAlignmentStore caching the relevant transformations needed in this event. More...
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}
	Pointer to the underlying detector manager. More...
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Definition at line 32 of file MmSensitiveDetector.h.

Constructor & Destructor Documentation

MmSensitiveDetector()

MmSensitiveDetector::MmSensitiveDetector	(	const std::string &	name,
		const std::string &	output_key,
		const std::string &	trf_storKey,
		const MuonGMR4::MuonDetectorManager *	detMgr
	)

Constructor.

Parameters

name	Name of the Sensitive detctor / AthMessaging module
output_key	Key under which the sim hits are written into store gate
trf_storeKey	Location of the DetctorAlignmentStore holding the transformations per event
detMgr	Pointer to the run-4 detector manager

Definition at line 32 of file MmSensitiveDetector.cxx.

                                                                                   :
    G4VSensitiveDetector{name},
    AthMessaging{name},
    m_writeHandle{output_key},
    m_trfCacheKey{trf_storeKey},
    m_detMgr{detMgr} {
    m_trfCacheKey.initialize().ignore();
}

~MmSensitiveDetector()

MuonG4R4::MmSensitiveDetector::~MmSensitiveDetector ( )

default

Member Function Documentation

getIdentifier()

Identifier MmSensitiveDetector::getIdentifier ( const ActsGeometryContext &  gctx, const MuonGMR4::MmReadoutElement *  readOutEle, const Amg::Vector3D &  hitAtGapPlane  ) const

private

Identify the gasGap layer of the hit.

that's the poor man's solution to find out in which gas gap we're

Definition at line 127 of file MmSensitiveDetector.cxx.

                                                                                      {
  for (unsigned int gap = 1; gap <= readOutEle->nGasGaps(); ++gap){
     const Amg::Vector3D gapCentre = readOutEle->center(gctx, MmReadoutElement::createHash(gap, 0));
     ATH_MSG_VERBOSE("Try to match "<<Amg::toString(hitAtGapPlane)<<" to "<<Amg::toString(gapCentre)
                  <<" in "<<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify())<<" dZ: "
                  <<std::abs(gapCentre.z() - hitAtGapPlane.z()));
     if (std::abs(gapCentre.z() - hitAtGapPlane.z()) < tolerance) {
         ATH_MSG_VERBOSE("Assign hit "<<Amg::toString(hitAtGapPlane)<<" to "
                        <<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify())<<" gasGap: "<<gap);
         return readOutEle->measurementId(MmReadoutElement::createHash(gap, 1));
     }
  }
  THROW_EXCEPTION("Invalid gasgap matching for hit "<<Amg::toString(hitAtGapPlane)<<" and detector element "
                  <<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify()));
  return Identifier{};
}

getReadoutElement()

const MuonGMR4::MmReadoutElement * MmSensitiveDetector::getReadoutElement ( const ActsGeometryContext &  gctx, const G4TouchableHistory *  touchHist  ) const

private

Retrieves the matching readout element to a G4 hit.

The fourth volume is the envelope volume of the NSW station. It will tell us the sector and station eta

av_4375_impr_1_MuonR4::NSW_SM2_StationMuonStation_pv_9_NSW_SM2_Station_-2_1

Find the Detector element from the Identifier

retrieve the translation of the transformation going into the current current gasVolume

Let's use the position of the first gasGap in the second quad as a reference. If the absolute z value is smaller than its z value the hit must be located in quad number one

Definition at line 146 of file MmSensitiveDetector.cxx.

                                                                                                                    {
   const std::string& stationVolume = touchHist->GetVolume(4)->GetName();
   const std::vector<std::string> volumeTokens = tokenize(stationVolume.substr(stationVolume.rfind("NSW") + 4), "_");
   ATH_MSG_VERBOSE("Name of the station volume is "<<volumeTokens);
   if (volumeTokens.size() != 4) {
      THROW_EXCEPTION(" Cannot deduce the station name from "<<stationVolume);
   }
   const std::string stName = volumeTokens[0][0] == 'S' ? "MMS" : "MML";
   const int stationEta = atoi(volumeTokens[2]);
   const int stationPhi = atoi(volumeTokens[3]);
 
   const MmIdHelper& idHelper{m_detMgr->idHelperSvc()->mmIdHelper()};
   const Identifier detElIdMl1 = idHelper.channelID(idHelper.stationNameIndex(stName), stationEta, stationPhi, 1, 1, 1);
   const Identifier detElIdMl2 = idHelper.multilayerID(detElIdMl1, 2);
   const MmReadoutElement* readOutElemMl1 = m_detMgr->getMmReadoutElement(detElIdMl1);
   const MmReadoutElement* readOutElemMl2 = m_detMgr->getMmReadoutElement(detElIdMl2);
   if (!readOutElemMl1 || !readOutElemMl2) {
      THROW_EXCEPTION(" Failed to retrieve a valid detector element from "
                    <<m_detMgr->idHelperSvc()->toStringDetEl(detElIdMl1)<<" "<<stationVolume);    
   }
   const Amg::Vector3D transformCenter = getTransform(touchHist, 0).translation();
   const Amg::Vector3D centerMl2 = readOutElemMl2->center(gctx, detElIdMl2);
   ATH_MSG_VERBOSE("Local gap position "<<Amg::toString(centerMl2)<<" transform center "<<Amg::toString(transformCenter));
   return std::abs(centerMl2.z())  - tolerance <= std::abs(transformCenter.z()) ? readOutElemMl2 : readOutElemMl1;
}

Initialize()

void MmSensitiveDetector::Initialize ( G4HCofThisEvent *  HCE )

finaloverride

member functions

Definition at line 44 of file MmSensitiveDetector.cxx.

                                                     {
  if (m_writeHandle.isValid()) {
      ATH_MSG_VERBOSE("Simulation hit container "<<m_writeHandle.fullKey()<<" is already written");
      return;
  }
  if (!m_writeHandle.recordNonConst(std::make_unique<xAOD::MuonSimHitContainer>(),
                                    std::make_unique<xAOD::MuonSimHitAuxContainer>()).isSuccess()) {
      THROW_EXCEPTION("Failed to record "<<m_writeHandle.fullKey());
  }
  ATH_MSG_DEBUG("Output container "<<m_writeHandle.fullKey()<<" has been successfully created");
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level  lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (!m_initialized.test_and_set()) initMessaging();
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

ProcessHits()

G4bool MmSensitiveDetector::ProcessHits ( G4Step *  aStep, G4TouchableHistory *  ROhist  )

finaloverride

Reject secondary particles

Definition at line 56 of file MmSensitiveDetector.cxx.

                                                                         {
 
  G4Track* currentTrack = aStep->GetTrack();
  // MDTs sensitive to charged particle only
  if (currentTrack->GetDefinition()->GetPDGCharge() == 0.0) {
    if (currentTrack->GetDefinition()!= G4Geantino::GeantinoDefinition()) return true;
    else if (currentTrack->GetDefinition()==G4ChargedGeantino::ChargedGeantinoDefinition()) return true;
  }
 
  constexpr double velCutOff = 10.*Gaudi::Units::micrometer / Gaudi::Units::second;
  if (currentTrack->GetVelocity() < velCutOff) return true;
 
  ActsGeometryContext gctx{};
 
  SG::ReadHandle<DetectorAlignStore> trfStoreHandle{m_trfCacheKey};
  if (!trfStoreHandle.isValid()) {
    ATH_MSG_FATAL("Failed to retrieve "<<m_trfCacheKey.fullKey()<<".");
    return false;
  }
  gctx.setStore(std::make_unique<DetectorAlignStore>(*trfStoreHandle));
 
  const G4TouchableHistory* touchHist = static_cast<const G4TouchableHistory*>(currentTrack->GetTouchable());
  const MuonGMR4::MmReadoutElement* readOutEle = getReadoutElement(gctx, touchHist);
  
 
  const Amg::Transform3D globalToLocal = getTransform(touchHist, 0).inverse();
  ATH_MSG_VERBOSE(" Track is inside volume "
                 << touchHist->GetHistory()->GetTopVolume()->GetName()
                 <<" transformation: "<<Amg::toString(globalToLocal));
  // transform pre and post step positions to local positions
  
  const Amg::Vector3D localPos{globalToLocal*Amg::Hep3VectorToEigen(currentTrack->GetPosition())};
  const Amg::Vector3D localDir{globalToLocal.linear()*Amg::Hep3VectorToEigen(currentTrack->GetMomentumDirection())};
  ATH_MSG_VERBOSE("Entry / exit point in "<<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify())
               <<" "<<Amg::toString(localPos, 2)<<" / "<<Amg::toString(localDir, 2));
  
  
  // The middle of the gas gap is at X= 0
  std::optional<double> travelDist = Amg::intersect<3>(localPos, localDir, Amg::Vector3D::UnitX(), 0.);
  if (!travelDist) return true;
  const Amg::Vector3D locGapCross = localPos + (*travelDist) * localDir;
  ATH_MSG_VERBOSE("Propagation to the gas gap center: "<<Amg::toString(locGapCross, 2));
  const Amg::Vector3D gapCenterCross = globalToLocal.inverse() * locGapCross;
 
  const Identifier hitID = getIdentifier(gctx, readOutEle, gapCenterCross);
  if (!hitID.is_valid()) {
      ATH_MSG_VERBOSE("No valid hit found");
      return true;
  }
  const double globalTime = currentTrack->GetGlobalTime() + (*travelDist) / currentTrack->GetVelocity();
  const Amg::Transform3D gapTrans{readOutEle->globalToLocalTrans(gctx, hitID)};
  const Amg::Vector3D locHitDir = gapTrans.linear() * Amg::Hep3VectorToEigen(currentTrack->GetMomentumDirection());
  const Amg::Vector3D locHitPos = gapTrans * gapCenterCross;
 
  xAOD::MuonSimHit* hit = new xAOD::MuonSimHit();
  m_writeHandle->push_back(hit);  
  
  TrackHelper trHelp(aStep->GetTrack());
  hit->setIdentifier(hitID); 
  hit->setLocalPosition(xAOD::toStorage(locHitPos));  
  hit->setLocalDirection(xAOD::toStorage(locHitDir));
  hit->setMass(currentTrack->GetDefinition()->GetPDGMass());
  hit->setGlobalTime(globalTime);
  hit->setPdgId(currentTrack->GetDefinition()->GetPDGEncoding());
  hit->setEnergyDeposit(aStep->GetTotalEnergyDeposit());
  hit->setKineticEnergy(currentTrack->GetKineticEnergy());
  hit->setGenParticleLink(trHelp.GenerateParticleLink());
  return true;
}

setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_detMgr

const MuonGMR4::MuonDetectorManager* MuonG4R4::MmSensitiveDetector::m_detMgr {nullptr}

private

Pointer to the underlying detector manager.

Definition at line 74 of file MmSensitiveDetector.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_trfCacheKey

SG::ReadHandleKey<ActsTrk::DetectorAlignStore> MuonG4R4::MmSensitiveDetector::m_trfCacheKey

private

ReadHandleKey to the DetectorAlignmentStore caching the relevant transformations needed in this event.

Definition at line 71 of file MmSensitiveDetector.h.

m_writeHandle

SG::WriteHandle<xAOD::MuonSimHitContainer> MuonG4R4::MmSensitiveDetector::m_writeHandle

private

Definition at line 66 of file MmSensitiveDetector.h.

---

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

• MmSensitiveDetector.h
• MmSensitiveDetector.cxx