Collects the G4 steps and writes out RecordedMaterialTrackCollection to a store gate. More...

#include <MaterialTrackRecorder.h>

Inheritance diagram for ActsTrk::MaterialTrackRecorder:

Collaboration diagram for ActsTrk::MaterialTrackRecorder:

Classes
struct	Config

Public Member Functions
	MaterialTrackRecorder (const Config &config)
virtual void	BeginOfEventAction (const G4Event *) override
virtual void	EndOfEventAction (const G4Event *) override
virtual void	BeginOfRunAction (const G4Run *) override
virtual void	UserSteppingAction (const G4Step *) override
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
Acts::Vector3	convertPosition (const G4ThreeVector &g4vec)
	Useful fuction for position coversion.
Acts::Vector3	convertDirection (const G4ThreeVector &g4vec)
	Useful fuction for direction coversion.
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
RecordedMaterialTrackCollection *	m_rmtCollection {nullptr}
	Pointer to the collection, non-owning.
Config	m_cfg
	The config class.
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)

Static Private Attributes
static constexpr double	s_convertLength = Acts::UnitConstants::mm / CLHEP::mm
	Conversion constants.
static constexpr double	s_convertDensity

Detailed Description

Collects the G4 steps and writes out RecordedMaterialTrackCollection to a store gate.

Handles the MaterialTrackRecorder G4UA.

It writes out a MaterialTrack which is usually generated from MaterialTrackRecorder G4UA

Definition at line 34 of file MaterialTrackRecorder.h.

Constructor & Destructor Documentation

◆ MaterialTrackRecorder()

ActsTrk::MaterialTrackRecorder::MaterialTrackRecorder ( const Config & config )

Definition at line 20 of file MaterialTrackRecorder.cxx.

                                                                    :
        AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >( "MessageSvc" ),"MaterialTrackRecorder"),
        m_cfg(config)
    {}

Member Function Documentation

◆ BeginOfEventAction()

void ActsTrk::MaterialTrackRecorder::BeginOfEventAction ( const G4Event * )

overridevirtual

Definition at line 25 of file MaterialTrackRecorder.cxx.

    {
        ATH_MSG_DEBUG(" BeginOfEventAction");
 
        // Get the event context for the write handle below
        const EventContext& ctx = Gaudi::Hive::currentContext();
 
        SG::WriteHandle<RecordedMaterialTrackCollection> materialTracks(m_cfg.materialTrackCollectionName, ctx);
 
        // Only record if it does NOT already exist
        if (!materialTracks.isPresent()) {
            auto coll = std::make_unique<RecordedMaterialTrackCollection>();
            if (materialTracks.record(std::move(coll)).isFailure()) {
                ATH_MSG_ERROR("Failed to record RecordedMaterialTrackCollection with key "
                              << m_cfg.materialTrackCollectionName);
                m_rmtCollection = nullptr;
                return;
          }
        } else {
            // Sanity check (should normally not happen unless someone else records it)
            ATH_MSG_DEBUG("Collection already present: " << m_cfg.materialTrackCollectionName);
        }
 
        m_rmtCollection = materialTracks.ptr();
 
        if (!m_rmtCollection) {
            ATH_MSG_ERROR("Recorded collection pointer is null right after record/present for key "
                          << m_cfg.materialTrackCollectionName);
        }
 
        ATH_MSG_DEBUG("ctx event=" << ctx.eventID().event_number()
                      << " slot=" << ctx.slot() << " key=" << m_cfg.materialTrackCollectionName);
        ATH_MSG_DEBUG("recorded? present=" << materialTracks.isPresent() << " valid=" << materialTracks.isValid());
    }

◆ BeginOfRunAction()

void ActsTrk::MaterialTrackRecorder::BeginOfRunAction ( const G4Run * )

overridevirtual

Definition at line 65 of file MaterialTrackRecorder.cxx.

    {
        ATH_MSG_DEBUG(" BeginOfRunAction");
        m_rmtCollection = nullptr;
    }

◆ convertDirection()

Acts::Vector3 ActsTrk::MaterialTrackRecorder::convertDirection ( const G4ThreeVector & g4vec )

inlineprivate

Useful fuction for direction coversion.

Definition at line 68 of file MaterialTrackRecorder.h.

                                                                     {
                return Acts::Vector3{g4vec[0], g4vec[1], g4vec[2]};
            }

◆ convertPosition()

Acts::Vector3 ActsTrk::MaterialTrackRecorder::convertPosition ( const G4ThreeVector & g4vec )

inlineprivate

Useful fuction for position coversion.

Definition at line 63 of file MaterialTrackRecorder.h.

                                                                    {
                return Acts::Vector3(g4vec[0] * s_convertLength, g4vec[1] * s_convertLength,
                                    g4vec[2] * s_convertLength);
            }

◆ EndOfEventAction()

void ActsTrk::MaterialTrackRecorder::EndOfEventAction ( const G4Event * )

overridevirtual

Definition at line 60 of file MaterialTrackRecorder.cxx.

    {
        ATH_MSG_DEBUG(" EndOfEventAction");
    }

◆ 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 167 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 182 of file AthMessaging.h.

183{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ 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 user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ 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;
}

◆ UserSteppingAction()

void ActsTrk::MaterialTrackRecorder::UserSteppingAction ( const G4Step * step )

overridevirtual

Definition at line 71 of file MaterialTrackRecorder.cxx.

    {
        ATH_MSG_DEBUG(" UserSteppingAction");
 
        if (!m_rmtCollection) {
            ATH_MSG_ERROR("No per-event collection pointer cached (m_coll is null).");
            return;
        }
 
        // Get the material & check if it is present
        G4Material* material = step->GetPreStepPoint()->GetMaterial();
        if (material == nullptr) {
            return;
        }
 
        // First check for exclusion
        std::string materialName = material->GetName();
        for (const auto& emat : m_cfg.excludeMaterials) {
            if (emat == materialName) {
                ATH_MSG_DEBUG("Exclude step in material '" << materialName << "'.");
                return;
            }
        }
 
        ATH_MSG_DEBUG("Performing a step with step size = "
        << s_convertLength * step->GetStepLength());
 
        // Quantities valid for elemental materials and mixtures
        double X0 = s_convertLength * material->GetRadlen();
        double L0 = s_convertLength * material->GetNuclearInterLength();
        double rho = s_convertDensity * material->GetDensity();
 
        // Get{A,Z} is only meaningful for single-element materials (according to
        // the Geant4 docs). Need to compute average manually.
        const G4ElementVector* elements = material->GetElementVector();
        const G4double* fraction = material->GetFractionVector();
        std::size_t nElements = material->GetNumberOfElements();
 
        double Ar = 0.;
        double Z = 0.;
        if (nElements == 1) {
            Ar = material->GetA() / (CLHEP::gram / CLHEP::mole);
            Z = material->GetZ();
        } else {
            for (std::size_t i = 0; i < nElements; i++) {
                Ar += elements->at(i)->GetA() * fraction[i] / (CLHEP::gram / CLHEP::mole);
                Z += elements->at(i)->GetZ() * fraction[i];
            }
        }
 
        // Construct passed material slab for the step
        const auto slab = Acts::MaterialSlab(Acts::Material::fromMassDensity(X0, L0, Ar, Z, rho), s_convertLength * step->GetStepLength());
 
        // Create the RecordedMaterialSlab
        Acts::MaterialInteraction mInteraction;
        mInteraction.position = convertPosition(step->GetPreStepPoint()->GetPosition());
        mInteraction.direction = convertDirection(step->GetPreStepPoint()->GetMomentum()).normalized();
        mInteraction.materialSlab = slab;
        mInteraction.pathCorrection = (step->GetStepLength() / CLHEP::mm);
 
        G4Track* g4Track = step->GetTrack();
 
        Acts::RecordedMaterialTrack rmTrack;
        Acts::Vector3 vertex = convertPosition(g4Track->GetVertexPosition());
        Acts::Vector3 direction = convertDirection(g4Track->GetMomentumDirection());
        rmTrack.first = {vertex, direction};
        rmTrack.second.materialInteractions.push_back(mInteraction);
        m_rmtCollection->push_back(rmTrack);
    }

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_cfg

Config ActsTrk::MaterialTrackRecorder::m_cfg

private

The config class.

Definition at line 60 of file MaterialTrackRecorder.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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_rmtCollection

RecordedMaterialTrackCollection* ActsTrk::MaterialTrackRecorder::m_rmtCollection {nullptr}

private

Pointer to the collection, non-owning.

Definition at line 53 of file MaterialTrackRecorder.h.

53{nullptr};

◆ s_convertDensity

double ActsTrk::MaterialTrackRecorder::s_convertDensity

staticconstexprprivate

Initial value:

=

(Acts::UnitConstants::g / Acts::UnitConstants::mm3) / (CLHEP::gram / CLHEP::mm3)

Definition at line 56 of file MaterialTrackRecorder.h.

◆ s_convertLength

double ActsTrk::MaterialTrackRecorder::s_convertLength = Acts::UnitConstants::mm / CLHEP::mm

staticconstexprprivate

Conversion constants.

Definition at line 55 of file MaterialTrackRecorder.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MaterialTrackRecorder()

Member Function Documentation

◆ BeginOfEventAction()

◆ BeginOfRunAction()

◆ convertDirection()

◆ convertPosition()

◆ EndOfEventAction()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setLevel()

◆ UserSteppingAction()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cfg

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_rmtCollection

◆ s_convertDensity

◆ s_convertLength