G4UA::MaterialStepRecorder Class Reference

#include <MaterialStepRecorder.h>

Inheritance diagram for G4UA::MaterialStepRecorder:

Collaboration diagram for G4UA::MaterialStepRecorder:

Public Member Functions
	MaterialStepRecorder ()
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. 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
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
ServiceHandle< StoreGateSvc >	m_evtStore
	Pointer to StoreGate (event store by default) More...
Trk::MaterialStepCollection *	m_matStepCollection
std::string	m_matStepCollectionName
bool	m_recordComposition
size_t	m_totalSteps
size_t	m_eventID
Trk::ElementTable *	m_elementTable
std::string	m_elementTableName
Trk::ElementTable *	m_runElementTable
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 38 of file MaterialStepRecorder.h.

Constructor & Destructor Documentation

MaterialStepRecorder()

MaterialStepRecorder::MaterialStepRecorder

(

)

Definition at line 33 of file MaterialStepRecorder.cxx.

                                            :
    AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >( "MessageSvc" ),"MaterialStepRecorder"),
    m_evtStore("StoreGateSvc/StoreGateSvc","MaterialStepRecorder"), //FIXME name should be passed in via a Config struct rather than hardcoded.
    m_matStepCollection(nullptr),
    m_matStepCollectionName("MaterialStepRecords"), //FIXME should be passed in via a Config struct rather than hardcoded.
    m_recordComposition(true), //FIXME should be passed in via a Config struct rather than hardcoded.
    m_totalSteps(0),
    m_eventID(0),
    m_elementTable(nullptr),
    m_elementTableName("ElementTable"),
    m_runElementTable(nullptr)
  {
  }

Member Function Documentation

BeginOfEventAction()

void MaterialStepRecorder::BeginOfEventAction ( const G4Event *  )

overridevirtual

Definition at line 47 of file MaterialStepRecorder.cxx.

  {
    ATH_MSG_DEBUG(" BeginOfEventAction");
 
    // create a new Collection
    m_matStepCollection = new Trk::MaterialStepCollection;
    //    m_eventStepLength = 0;
  }

BeginOfRunAction()

void MaterialStepRecorder::BeginOfRunAction ( const G4Run *  )

overridevirtual

Definition at line 75 of file MaterialStepRecorder.cxx.

  {
    ATH_MSG_DEBUG(" BeginOfRunAction");
 
    // initialize
    m_totalSteps = 0;
    m_eventID = 0;
  }

EndOfEventAction()

void MaterialStepRecorder::EndOfEventAction ( const G4Event *  )

overridevirtual

Definition at line 56 of file MaterialStepRecorder.cxx.

  {
    ATH_MSG_DEBUG(" EndOfEventAction");
 
    ++m_eventID;
    // write the Collection to StoreGate
    if(m_evtStore->record(m_matStepCollection, m_matStepCollectionName, false).isFailure())
      {
        ATH_MSG_ERROR("cannot record step collection to StoreGate");
      }
    // write out the ElementTable of this event
    if ( m_evtStore->record(m_elementTable, m_elementTableName, false).isFailure() )
      {
        ATH_MSG_ERROR("EndOfEventAction : recording ElementTable in StoreGate FAILED");
        delete m_elementTable;
      }
    m_elementTable = nullptr;
  }

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

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 MaterialStepRecorder::UserSteppingAction ( const G4Step *  aStep )

overridevirtual

Definition at line 84 of file MaterialStepRecorder.cxx.

  {
    // kill secondaries
    if (aStep->GetTrack()->GetParentID()) {
      aStep->GetTrack()->SetTrackStatus(fStopAndKill);
      return;
    }
 
    // ElementTable preparation
    if (m_recordComposition && !m_elementTable) {
      m_elementTable = new Trk::ElementTable();
      m_runElementTable = new Trk::ElementTable();
    }
 
    // the material information
    const G4TouchableHistory* touchHist = static_cast<const G4TouchableHistory*>(aStep->GetPreStepPoint()->GetTouchable());
    // G4LogicalVolume
    const G4LogicalVolume *lv= touchHist ? touchHist->GetVolume()->GetLogicalVolume() : nullptr;
    const G4Material *mat    = lv ? lv->GetMaterial() : nullptr;
    
    std::vector<unsigned char> elements;
    std::vector<unsigned char> fractions;
 
    // log the information // cut off air
    if (mat && mat->GetRadlen() < 200000.) {
 
      ++m_totalSteps;
 
      // the step information
      double steplength     = aStep->GetStepLength();
 
      // the position information
      G4ThreeVector pos     = aStep->GetPreStepPoint()->GetPosition();
 
      double X0             = mat->GetRadlen();
      double L0             = mat->GetNuclearInterLength();
      double A              = 0.;
      double Z              = 0.;
      //        double totAtoms       = 0.;
 
      double rho            = mat->GetDensity()*CLHEP::mm3/CLHEP::gram;
 
      // get the number of Elements
      size_t                 elNumber = mat->GetNumberOfElements();
      const G4ElementVector* elVector = mat->GetElementVector();
      double                 totAtoms = mat->GetTotNbOfAtomsPerVolume();
 
      // reserve the right number of elements
      elements.reserve(elNumber);
      fractions.reserve(elNumber);
 
      if (1 == elNumber) {
 
        A   = mat->GetA()/CLHEP::gram;
        Z   = mat->GetZ();
 
        unsigned int Zint = (unsigned int)Z;
        // the element and fraction vector
        elements.push_back(static_cast<unsigned char>(Z));
        fractions.push_back(UCHAR_MAX);
        // record the Element
        if (m_recordComposition && !m_elementTable->contains(Zint)){
          // the element Material
          Trk::Material elMat(X0,L0,A,Z,rho);
          G4String      elName =  (*elVector)[0]->GetName();
          // add it to the table
          m_elementTable->addElement(elMat, elName);
          m_runElementTable->addElement(elMat,elName);
        }
 
 
      } else {
 
        const G4double*   atVector = mat->GetVecNbOfAtomsPerVolume();
        double totalFrac           = 0.;
 
        for (size_t iel = 0; iel < elNumber; ++iel) {
 
          const G4Element*  currentEl  = (*elVector)[iel];
          double      currentNum = atVector ? atVector[iel] : 1.;
          double      relNbAtoms = currentNum/totAtoms;
 
          double currentZ = currentEl->GetZ();
 
          A += relNbAtoms*currentEl->GetA()/CLHEP::gram;
          Z += relNbAtoms*currentEl->GetZ();
          unsigned int Zint = (unsigned int)(currentEl->GetZ());
 
          // the element and fraction vector
          elements.push_back(int(currentZ));
          // calculate the fraction with a accuracy of 1/256.
          unsigned int relNbAtomsChar = (unsigned int)(relNbAtoms*(UCHAR_MAX));
          relNbAtomsChar = relNbAtomsChar > UCHAR_MAX ? UCHAR_MAX : relNbAtomsChar;
 
          // smaller components than 0.5 % are automatically ignored
          totalFrac     += relNbAtoms;
          if (relNbAtomsChar) {
            fractions.push_back(relNbAtomsChar);
            // record composition
            if (m_recordComposition && !m_elementTable->contains(Zint)){
              double curA          =  currentEl->GetA()/CLHEP::gram;
              double curZ          =  currentEl->GetZ();
              // approximate formulas for X0 and L0
              // X0 from : PH-EP-Tech-Note-2010-013 g/cm3 -> g/mm3
              // L0 from :
              double curX0         =  1432.8*curA/(curZ*(curZ+1)*(11.319-std::log(curZ)));
              double curL0         =  0.;
              double curRho        =  rho*relNbAtoms;
              Trk::Material elMat(curX0,curL0,curA,curZ,curRho);
              const G4String&      elName =  currentEl->GetName();
              // add it to the table
              m_elementTable->addElement(elMat, elName);
              m_runElementTable->addElement(elMat,elName);
            }
          }
        }
        if ((totalFrac-1.)*(totalFrac-1.) > 10e-4 )
          ATH_MSG_DEBUG("Total fractions do not add up to one at INPUT (" << totalFrac << ") !");
      }
 
      // is it a Geantino?
      if (aStep->GetTrack()->GetParticleDefinition()->GetPDGEncoding() == 0) {
        if (m_recordComposition)
          m_matStepCollection->push_back(new Trk::MaterialStep(pos.x(), pos.y(), pos.z(), steplength, X0, L0, A, Z, rho, elements, fractions));
        else
          m_matStepCollection->push_back(new Trk::MaterialStep(pos.x(), pos.y(), pos.z(), steplength, X0, L0, A, Z, rho));
      }
    }
     }

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_elementTable

Trk::ElementTable* G4UA::MaterialStepRecorder::m_elementTable

private

Definition at line 61 of file MaterialStepRecorder.h.

m_elementTableName

std::string G4UA::MaterialStepRecorder::m_elementTableName

private

Definition at line 62 of file MaterialStepRecorder.h.

m_eventID

size_t G4UA::MaterialStepRecorder::m_eventID

private

Definition at line 59 of file MaterialStepRecorder.h.

m_evtStore

ServiceHandle<StoreGateSvc> G4UA::MaterialStepRecorder::m_evtStore

private

Pointer to StoreGate (event store by default)

Definition at line 51 of file MaterialStepRecorder.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_matStepCollection

Trk::MaterialStepCollection* G4UA::MaterialStepRecorder::m_matStepCollection

private

Definition at line 53 of file MaterialStepRecorder.h.

m_matStepCollectionName

std::string G4UA::MaterialStepRecorder::m_matStepCollectionName

private

Definition at line 54 of file MaterialStepRecorder.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_recordComposition

bool G4UA::MaterialStepRecorder::m_recordComposition

private

Definition at line 56 of file MaterialStepRecorder.h.

m_runElementTable

Trk::ElementTable* G4UA::MaterialStepRecorder::m_runElementTable

private

Definition at line 64 of file MaterialStepRecorder.h.

m_totalSteps

size_t G4UA::MaterialStepRecorder::m_totalSteps

private

Definition at line 58 of file MaterialStepRecorder.h.

---

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

• MaterialStepRecorder.h
• MaterialStepRecorder.cxx