MuonG4R4::RpcSensitiveDetector Class Reference

#include <RpcSensitiveDetector.h>

Inheritance diagram for MuonG4R4::RpcSensitiveDetector:

Collaboration diagram for MuonG4R4::RpcSensitiveDetector:

Public Member Functions
	RpcSensitiveDetector (const std::string &name, const std::string &output_key, const std::string &trf_storKey, const MuonGMR4::MuonDetectorManager *detMgr)
	Constructor. More...
	~RpcSensitiveDetector ()=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::RpcReadoutElement *	getReadoutElement (const G4TouchableHistory *touchHist) const
	Retrieves the matching readout element to a G4 hit. More...
Identifier	getIdentifier (const ActsGeometryContext &gctx, const MuonGMR4::RpcReadoutElement *readOutEle, const Amg::Vector3D &hitAtGapPlane, bool phiGap) const
	Extracts the gasGap Identifier of the hit expressed at the origin of the local gasGap system. 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 93 of file RpcSensitiveDetector.h.

Constructor & Destructor Documentation

RpcSensitiveDetector()

MuonG4R4::RpcSensitiveDetector::RpcSensitiveDetector	(	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 30 of file RpcSensitiveDetector.cxx.

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

~RpcSensitiveDetector()

MuonG4R4::RpcSensitiveDetector::~RpcSensitiveDetector ( )

default

Member Function Documentation

getIdentifier()

Identifier MuonG4R4::RpcSensitiveDetector::getIdentifier ( const ActsGeometryContext &  gctx, const MuonGMR4::RpcReadoutElement *  readOutEle, const Amg::Vector3D &  hitAtGapPlane, bool  phiGap  ) const

private

Extracts the gasGap Identifier of the hit expressed at the origin of the local gasGap system.

Definition at line 135 of file RpcSensitiveDetector.cxx.

                                                                                                    {
  const RpcIdHelper& idHelper{m_detMgr->idHelperSvc()->rpcIdHelper()};
 
  const Identifier firstChan = idHelper.channelID(readOutEle->identify(),
                                                  readOutEle->doubletZ(),
                                                  readOutEle->doubletPhi(), 1, phiGap, 1);
  
  const Amg::Vector3D locHitPos{readOutEle->globalToLocalTrans(gctx, firstChan) * 
                                hitAtGapPlane};
  const double gapHalfWidth = readOutEle->stripEtaLength() / 2;
  const double gapHalfLength = readOutEle->stripPhiLength()/ 2;
  ATH_MSG_VERBOSE("Detector element: "<<m_detMgr->idHelperSvc()->toStringDetEl(firstChan)
                <<" locPos: "<<Amg::toString(locHitPos, 2)
                <<" gap thickness "<<readOutEle->gasGapPitch()
                <<" gap width: "<<gapHalfWidth
                <<" gap length: "<<gapHalfLength);
  const int doubletPhi = std::abs(locHitPos.y()) > gapHalfWidth ? readOutEle->doubletPhiMax() :
                                                                  readOutEle->doubletPhi();
  const int gasGap = std::round(std::abs(locHitPos.z()) /  readOutEle->gasGapPitch()) + 1;
 
  return idHelper.channelID(readOutEle->identify(),
                            readOutEle->doubletZ(),
                            doubletPhi, gasGap, phiGap, 1);
}

getReadoutElement()

const MuonGMR4::RpcReadoutElement * MuonG4R4::RpcSensitiveDetector::getReadoutElement ( const G4TouchableHistory *  touchHist ) const

private

Retrieves the matching readout element to a G4 hit.

The fourth volume is the envelope volume of the rpc gas gap

Find the Detector element from the Identifier

<STATIONETA>_<STATIONPHI>_<DOUBLETR>_<DOUBLETPHI>_<DOUBLETZ>

Definition at line 161 of file RpcSensitiveDetector.cxx.

                                                                                                                  {
   const std::string stationVolume = touchHist->GetVolume(3)->GetName();
   
   const std::vector<std::string> volumeTokens = tokenize(stationVolume, "_");
   ATH_MSG_VERBOSE("Name of the station volume is "<<stationVolume);
   if (volumeTokens.size() != 7) {
      THROW_EXCEPTION(" Cannot deduce the station name from "<<stationVolume);
   }
   const std::string stName = volumeTokens[0].substr(0,3);
   const int stationEta = atoi(volumeTokens[2]);
   const int stationPhi = atoi(volumeTokens[3]);
   const int doubletR = atoi(volumeTokens[4]);
   const int doubletPhi = atoi(volumeTokens[5]);
   const int doubletZ = atoi(volumeTokens[6]);
   const RpcIdHelper& idHelper{m_detMgr->idHelperSvc()->rpcIdHelper()};
 
   const Identifier detElId = idHelper.padID(idHelper.stationNameIndex(stName), 
                                             stationEta, stationPhi, doubletR, doubletZ, doubletPhi);
   const RpcReadoutElement* readOutElem = m_detMgr->getRpcReadoutElement(detElId);
   if (!readOutElem) {
      THROW_EXCEPTION(" Failed to retrieve a valid detector element from "
                    <<m_detMgr->idHelperSvc()->toStringDetEl(detElId)<<" "<<stationVolume);
   }
   return readOutElem;
}

Initialize()

void MuonG4R4::RpcSensitiveDetector::Initialize ( G4HCofThisEvent *  HCE )

finaloverride

member functions

Definition at line 42 of file RpcSensitiveDetector.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 MuonG4R4::RpcSensitiveDetector::ProcessHits ( G4Step *  aStep, G4TouchableHistory *  ROhist  )

finaloverride

Reject secondary particles

Final check that the hit is located at zero

Definition at line 54 of file RpcSensitiveDetector.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;
 
  const G4TouchableHistory* touchHist = static_cast<const G4TouchableHistory*>(currentTrack->GetTouchable());
  const MuonGMR4::RpcReadoutElement* readOutEle = getReadoutElement(touchHist);
  if (!readOutEle) {
      return false;
  }
 
  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 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 etaHitID = getIdentifier(gctx, readOutEle, gapCenterCross, false);
  if (!etaHitID.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, etaHitID)};
  const Amg::Vector3D locHitDir = gapTrans.linear() * Amg::Hep3VectorToEigen(currentTrack->GetMomentumDirection());
  const Amg::Vector3D locHitPos = gapTrans * gapCenterCross;
  
  if (std::abs(locHitPos.z()) > tolerance) {
      ATH_MSG_FATAL("The hit "<<Amg::toString(locHitPos)<<" doest not match "<<m_detMgr->idHelperSvc()->toString(etaHitID));
      throw std::runtime_error("Picked wrong gas gap");
  }
 
  xAOD::MuonSimHit* hit = new xAOD::MuonSimHit();
  m_writeHandle->push_back(hit);  
  
  TrackHelper trHelp(aStep->GetTrack());
  hit->setIdentifier(etaHitID); 
  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::RpcSensitiveDetector::m_detMgr {nullptr}

private

Pointer to the underlying detector manager.

Definition at line 134 of file RpcSensitiveDetector.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::RpcSensitiveDetector::m_trfCacheKey

private

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

Definition at line 131 of file RpcSensitiveDetector.h.

m_writeHandle

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

private

Definition at line 126 of file RpcSensitiveDetector.h.

---

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

• RpcSensitiveDetector.h
• RpcSensitiveDetector.cxx