MuonG4R4::MdtSensitiveDetector Class Reference

#include <MdtSensitiveDetector.h>

Inheritance diagram for MuonG4R4::MdtSensitiveDetector:

Collaboration diagram for MuonG4R4::MdtSensitiveDetector:

Public Member Functions
	MdtSensitiveDetector (const std::string &name, const std::string &output_key, const std::string &trf_storKey, const MuonGMR4::MuonDetectorManager *detMgr)
	Constructor. More...
	~MdtSensitiveDetector ()=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::MdtReadoutElement *	getReadoutElement (const G4TouchableHistory *touchHist) const
	Retrieves the matching readout element to a G4 hit. More...
Identifier	getIdentifier (const ActsGeometryContext &gctx, const MuonGMR4::MdtReadoutElement *reElement, const G4TouchableHistory *touchHist) const
	Retrieves from the Readoutelement & the touchable history the Identifier. 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 86 of file MdtSensitiveDetector.h.

Constructor & Destructor Documentation

MdtSensitiveDetector()

MuonG4R4::MdtSensitiveDetector::MdtSensitiveDetector	(	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 26 of file MdtSensitiveDetector.cxx.

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

~MdtSensitiveDetector()

MuonG4R4::MdtSensitiveDetector::~MdtSensitiveDetector ( )

default

Member Function Documentation

getIdentifier()

Identifier MuonG4R4::MdtSensitiveDetector::getIdentifier ( const ActsGeometryContext &  gctx, const MuonGMR4::MdtReadoutElement *  reElement, const G4TouchableHistory *  touchHist  ) const

private

Retrieves from the Readoutelement & the touchable history the Identifier.

The Geant transform takes a hit global -> local --> inverse goes back to the global system Compose this one with the global to local transformation of the first tube in the layer -->

equilateral triangle

Update the reference tube position to be in the proper layer

It can happen that the tube is assigned to zero by numerical precision Catch these cases if the layer is fine

Definition at line 148 of file MdtSensitiveDetector.cxx.

                                                                                          {
   const Amg::Transform3D localToGlobal{getTransform(touchHist, 0)};
   Amg::Vector3D refTubePos = (readOutEle->globalToLocalTrans(gctx, readOutEle->measurementHash(1,1)) * localToGlobal).translation();
   ATH_MSG_VERBOSE("Position of the tube wire w.r.t. the first tube in the multi layer "<<Amg::toString(refTubePos, 2));
   static const double layerPitch = 1./ std::sin(60*Gaudi::Units::deg);
   const int layer = std::round(refTubePos.x() * layerPitch / readOutEle->tubePitch()) +1;
   if (layer <= 0) {
      THROW_EXCEPTION("Tube hit in nirvana -- It seems that the tube position "
                      <<Amg::toString(refTubePos, 2)<<", perp: "<<refTubePos.perp()
                      <<" is outside of the volume envelope "
                      <<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify())<<". ");      
   }
   refTubePos  = (readOutEle->globalToLocalTrans(gctx, readOutEle->measurementHash(layer,1)) * localToGlobal).translation();
   const double tubePitches = refTubePos.y() / readOutEle->tubePitch();
   unsigned int tube = std::round(tubePitches) + 1;
   tube = std::max(1u, std::min(readOutEle->numTubesInLay(), tube));
  const Amg::Transform3D closureCheck{readOutEle->globalToLocalTrans(gctx, 
                                      readOutEle->measurementHash(layer, tube))*localToGlobal};
    if (!Amg::isIdentity(closureCheck)) {
        ATH_MSG_WARNING("Correction needed "<<layer<<","<<tube<<" "<<Amg::toString(closureCheck));
        if (closureCheck.translation().y() > 0) ++tube;
        else --tube;
    }
   
   const IdentifierHash tubeHash = readOutEle->measurementHash(layer, tube);
   const Identifier tubeId = readOutEle->measurementId(tubeHash);
   {
        const Amg::Transform3D closureCheck{readOutEle->globalToLocalTrans(gctx, tubeHash)*localToGlobal};
        if (!Amg::isIdentity(closureCheck)) {
            THROW_EXCEPTION("Tube hit in Nirvana --  It seems that the tube position "
                             <<Amg::toString(refTubePos, 2)<<", perp: "<<refTubePos.perp()
                             <<" is outside of the volume envelope "
                             <<m_detMgr->idHelperSvc()->toStringDetEl(readOutEle->identify())<<". "
                             <<"Layer: "<<layer<<", tube: "<<tube<<" "
                             <<Amg::toString(closureCheck)
                             <<"tube volume : "<<touchHist->GetVolume(0)->GetName()
                             <<" mdt chamber: "<<touchHist->GetVolume(2)->GetName());    
        }
   }
   ATH_MSG_VERBOSE("Tube & layer number candidate "<<tube<<", "<<layer<<" back and forth transformation "
                     <<Amg::toString(closureCheck));
   return tubeId;  
}

getReadoutElement()

const MuonGMR4::MdtReadoutElement * MuonG4R4::MdtSensitiveDetector::getReadoutElement ( const G4TouchableHistory *  touchHist ) const

private

Retrieves the matching readout element to a G4 hit.

The third volume in the history is the volume corresponding to the Muon multilayer

Find the Detector element from the Identifier

Build first the Identifier to find the detector element

Then retrieve the Detector element

Definition at line 50 of file MdtSensitiveDetector.cxx.

                                                                                                                  {
   const std::string stationVolume = touchHist->GetVolume(2)->GetName();
   using namespace MuonGMR4;
   const std::vector<std::string> volumeTokens = tokenize(stationVolume, "_");
   ATH_MSG_VERBOSE("Name of the station volume is "<<stationVolume);
   if (volumeTokens.size() != 5) {
      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 multiLayer = atoi(volumeTokens[4]);
   const MdtIdHelper& idHelper{m_detMgr->idHelperSvc()->mdtIdHelper()};
   const Identifier detElId = idHelper.multilayerID(idHelper.elementID(stName,stationEta, stationPhi), multiLayer);
   const MdtReadoutElement* readOutEle = m_detMgr->getMdtReadoutElement(detElId);
   if (!readOutEle) {
      THROW_EXCEPTION(" Failed to retrieve a valid detector element from "
                     <<m_detMgr->idHelperSvc()->toStringDetEl(detElId)<<" "<<stationVolume);
   }
   return readOutEle;
}

Initialize()

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

finaloverride

member functions

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

finaloverride

Reject secondary particles

Calculate the closest approach of the track w.r.t the z-axis

Definition at line 76 of file MdtSensitiveDetector.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 MdtReadoutElement* reEle{getReadoutElement(touchHist)};
 
    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 Identifier HitID = getIdentifier(gctx, reEle, touchHist);
    if (!HitID.is_valid()) {
        ATH_MSG_VERBOSE("No valid hit found");
        return true;
    }
 
    const Amg::Transform3D globalToLocal{reEle->globalToLocalTrans(gctx, reEle->measurementHash(HitID))};
 
    // transform pre and post step positions to local positions
    const Amg::Vector3D trackPosition{Amg::Hep3VectorToEigen(currentTrack->GetPosition())};
    const Amg::Vector3D trackDirection{Amg::Hep3VectorToEigen(currentTrack->GetMomentumDirection())};
 
    const Amg::Vector3D trackLocPos{globalToLocal * trackPosition};  
    const Amg::Vector3D trackLocDir{globalToLocal.linear()* trackDirection};
  
    const double lambda = Amg::intersect<3>(Amg::Vector3D::Zero(), Amg::Vector3D::UnitZ(),
                                       trackLocPos, trackLocDir).value_or(0);
  
    const Amg::Vector3D driftHit{trackLocPos + lambda * trackLocDir};
 
    const double globalTime{currentTrack->GetGlobalTime() +  lambda / currentTrack->GetVelocity()};
  
    TrackHelper trHelp{currentTrack};
 
    ATH_MSG_VERBOSE(" Dumping of hit "<<m_detMgr->idHelperSvc()->toString(HitID)
                  <<", barcode: "<<trHelp.GenerateParticleLink().barcode()
                  <<", "<<(*currentTrack)
                  <<", driftCircle: "<<Amg::toString(driftHit, 2)
                  <<", direction "<<Amg::toString(trackLocDir, 2)
                  <<" to SimHit container ahead. ");
 
    xAOD::MuonSimHit* hit = new xAOD::MuonSimHit();
    m_writeHandle->push_back(hit);  
    hit->setIdentifier(HitID); 
    hit->setLocalPosition(xAOD::toStorage(driftHit));  
    hit->setLocalDirection(xAOD::toStorage(trackLocDir));
    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::MdtSensitiveDetector::m_detMgr {nullptr}

private

Pointer to the underlying detector manager.

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

private

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

Definition at line 122 of file MdtSensitiveDetector.h.

m_writeHandle

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

private

Definition at line 117 of file MdtSensitiveDetector.h.

---

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

• MdtSensitiveDetector.h
• MdtSensitiveDetector.cxx