G4UA::AthenaTrackingAction Class Reference

User action for pre/post tracking truth handling. More...

#include <AthenaTrackingAction.h>

Inheritance diagram for G4UA::AthenaTrackingAction:

Collaboration diagram for G4UA::AthenaTrackingAction:

Public Member Functions
	AthenaTrackingAction (MSG::Level lvl, int secondarySavingLevel, int subDetVolLevel)
	Constructor.
virtual void	PreUserTrackingAction (const G4Track *) override final
	Called before tracking a new particle.
virtual void	PostUserTrackingAction (const G4Track *) override final
	Called after tracking a particle.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
int	m_secondarySavingLevel
	The saving level for secondaries.
int	m_subDetVolLevel
	The level in the G4 volume hierarchy at which can we find the sub-detector name.
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

User action for pre/post tracking truth handling.

Definition at line 18 of file AthenaTrackingAction.h.

Constructor & Destructor Documentation

AthenaTrackingAction()

G4UA::AthenaTrackingAction::AthenaTrackingAction	(	MSG::Level	lvl,
		int	secondarySavingLevel,
		int	subDetVolLevel )

Constructor.

Definition at line 24 of file AthenaTrackingAction.cxx.

    : AthMessaging("AthenaTrackingAction")
    , m_secondarySavingLevel(secondarySavingLevel)
    , m_subDetVolLevel(subDetVolLevel)
  {
    setLevel(lvl);
  }

Member Function Documentation

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    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 163 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 178 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_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

PostUserTrackingAction()

void G4UA::AthenaTrackingAction::PostUserTrackingAction ( const G4Track * )

finaloverridevirtual

Called after tracking a particle.

Here we reset the AtlasTrajectory if it was created.

Definition at line 77 of file AthenaTrackingAction.cxx.

  {
    ATH_MSG_DEBUG("Finished tracking a particle");
 
    // We are done tracking this particle, so reset the trajectory.
    // TODO: consider caching the tracking manager once to reduce overhead.
    G4EventManager::GetEventManager()->GetTrackingManager()->
      SetStoreTrajectory(false);
  }

PreUserTrackingAction()

void G4UA::AthenaTrackingAction::PreUserTrackingAction ( const G4Track * track )

finaloverridevirtual

Called before tracking a new particle.

If the track meets certain conditions, we save it in the AtlasG4EventUserInfo and possibly construct a new AtlasTrajectory which will be used for writing out truth particles later.

Definition at line 36 of file AthenaTrackingAction.cxx.

  {
    ATH_MSG_DEBUG("Starting to track a new particle");
 
    // Use the TrackHelper code to identify the kind of particle.
    TrackHelper trackHelper(track);
 
    // Condition for storing the GenParticle in the AtlasG4EventUserInfo for later.
    if (trackHelper.IsPrimary() || trackHelper.IsRegisteredSecondary())
    {
      HepMC::GenParticlePtr currentGenParticle = trackHelper.GetTrackInformation()->GetCurrentGenParticle();
 
      // Assign the GenParticle to the AtlasG4EventUserInfo.
      AtlasG4EventUserInfo* atlasG4EvtUserInfo = static_cast<AtlasG4EventUserInfo*>
        (G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetUserInformation());
      if (trackHelper.IsPrimary()) atlasG4EvtUserInfo->SetCurrentPrimaryGenParticle(currentGenParticle);
      atlasG4EvtUserInfo->SetCurrentGenParticle(std::move(currentGenParticle));
    }
 
    // Condition for creating a trajectory object to store truth.
    if (trackHelper.IsPrimary() ||
        (trackHelper.IsRegisteredSecondary() && m_secondarySavingLevel>1) ||
        (trackHelper.IsSecondary() && m_secondarySavingLevel>2))
    {
      ATH_MSG_DEBUG("Preparing an AtlasTrajectory for saving truth");
 
      // Create a new AtlasTrajectory for this particle
      AtlasTrajectory* trajectory = new AtlasTrajectory(track, m_subDetVolLevel);
 
      // Assign the trajectory to the tracking manager.
      // TODO: consider caching the tracking manager once to reduce overhead.
      auto trkMgr = G4EventManager::GetEventManager()->GetTrackingManager();
      //trajectory->setTrackingManager(trkMgr);
      trkMgr->SetStoreTrajectory(true);
      trkMgr->SetTrajectory(trajectory);
    }
  }

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_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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_secondarySavingLevel

int G4UA::AthenaTrackingAction::m_secondarySavingLevel

private

The saving level for secondaries.

Definition at line 41 of file AthenaTrackingAction.h.

m_subDetVolLevel

int G4UA::AthenaTrackingAction::m_subDetVolLevel

private

The level in the G4 volume hierarchy at which can we find the sub-detector name.

Definition at line 43 of file AthenaTrackingAction.h.

---

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

• AthenaTrackingAction.h
• AthenaTrackingAction.cxx