NEEDS DOCUMENTATION. More...

#include <FastIDKiller.h>

Inheritance diagram for G4UA::FastIDKiller:

Collaboration diagram for G4UA::FastIDKiller:

Classes
struct	Config
	Configuration parameters. More...
struct	Report
	Per-thread results for merging at end of run. More...

Public Member Functions
	FastIDKiller (const Config &config)
	Constructor.
const Report &	getReport () const
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
void	KillParticle (const G4Step *aStep)
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
Config	m_config
Report	m_report
bool	m_init
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

NEEDS DOCUMENTATION.

Definition at line 17 of file FastIDKiller.h.

Constructor & Destructor Documentation

◆ FastIDKiller()

G4UA::FastIDKiller::FastIDKiller ( const Config & config )

Constructor.

Definition at line 25 of file FastIDKiller.cxx.

                                                :
    AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >( "MessageSvc" ),"FastIDKiller"),
    m_config(config),
    m_report(),
    m_init(false)
  {
  }

Member Function Documentation

◆ BeginOfRunAction()

void G4UA::FastIDKiller::BeginOfRunAction ( const G4Run * )

overridevirtual

Definition at line 34 of file FastIDKiller.cxx.

  {
    if (m_config.isDalek==false){
      ATH_MSG_INFO( "Including the Fast Inner Detector Killer." << std::endl
                    << "\t This piece of code will kill all particles leaving the" << std::endl
                    << "\t inner detector region (which should be defined in your" << std::endl
                    << "\t job options) except those satisfying certain criteria." << std::endl
                    << "\t (e/gamma will not be killed above " << m_config.energyCut/1000. << " GeV)" );
    }
    else{
      ATH_MSG_INFO( "Including Fast Inner Detector Killer as DALEK (Domain Actuated" << std::endl
                    << "\t Low Energy Killer). It will exterminate all particles with kin." << std::endl
                    << "\t energy below " << m_config.energyCut << " MeV leaving the inner detector" << std::endl
                    << "\t region (which should be defined in your job options)." );
    }
 
 
    //FIXME need a nice way of getting the maximum size of the ID envelope in R and Z.
    // EnvelopeGeometryManager *gm=EnvelopeGeometryManager::GetGeometryManager();
 
    // // if not set through jobOptions, get values from envelope manager
    // if(m_config.R==0.)
    //   m_config.R = gm->IdetOuterRadius();
    // if(m_config.Z==0.)
    //   m_config.Z = gm->IdetMaxZ();
 
    ATH_MSG_INFO( "Fast ID Killer initialized with radius " << m_config.R << " and Z " << m_config.Z);
 
    m_init=true;
 
  }

◆ getReport()

const Report & G4UA::FastIDKiller::getReport ( ) const

inline

Definition at line 45 of file FastIDKiller.h.

46 { return m_report; }

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

◆ KillParticle()

void G4UA::FastIDKiller::KillParticle ( const G4Step * aStep )

private

Definition at line 67 of file FastIDKiller.cxx.

  {
    aStep->GetTrack()->SetTrackStatus(fStopAndKill);
    const G4TrackVector *tv = aStep->GetSecondary();
    for (unsigned int i=0;i<tv->size();i++){
      if ( (*tv)[i]->GetPosition().rho() < m_config.R &&
           (*tv)[i]->GetPosition().z() < m_config.Z &&
           (*tv)[i]->GetPosition().z() > -m_config.Z
           ) continue;
      (*tv)[i]->SetTrackStatus(fStopAndKill);
    }
    m_report.killCount++;
  }

◆ 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.

179{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:163

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

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

overridevirtual

Definition at line 83 of file FastIDKiller.cxx.

                                                          {
 
    if (msgLvl(MSG::VERBOSE)){
      ATH_MSG_DEBUG( " ===================================================== " );
      ATH_MSG_DEBUG( " Writing out Information for debugging: " );
      ATH_MSG_DEBUG( " Track-Pointer: " << aStep->GetTrack() );
      ATH_MSG_DEBUG( " GetDefinition is in the next line " );
      ATH_MSG_DEBUG( aStep->GetTrack()->GetDefinition() );
      ATH_MSG_DEBUG( " still going on ? " );
      ATH_MSG_DEBUG( " ===================================================== " );
    }
 
    // Outside DALEK mode: first ignore muons
    if ( m_config.isDalek==false &&
         ( G4MuonPlus::MuonPlusDefinition() == aStep->GetTrack()->GetDefinition() ||
           G4MuonMinus::MuonMinusDefinition() == aStep->GetTrack()->GetDefinition() ) ) return;
 
    // Now we check if the particle is outside the Z or R edges of the inner detector envelope
    if (msgLvl(MSG::VERBOSE)){
      ATH_MSG_VERBOSE( " Checking pointers ... " );
 
      if ( !aStep->GetPostStepPoint() ||
           !aStep->GetPreStepPoint() )
        {
          ATH_MSG_ERROR( " One of the pointers was null!  This should never happen!!!" );
          throw "Null position pointer";
        }
    }
 
    if ( aStep->GetPreStepPoint()->GetPosition().rho() > m_config.R ||
         aStep->GetPreStepPoint()->GetPosition().z() > m_config.Z ||
         aStep->GetPreStepPoint()->GetPosition().z() < -m_config.Z
         )
      {
        return; // We started outside the ID envelope
      }
 
    if ( aStep->GetPostStepPoint()->GetPosition().rho() < m_config.R &&
         aStep->GetPostStepPoint()->GetPosition().z() < m_config.Z &&
         aStep->GetPostStepPoint()->GetPosition().z() > -m_config.Z
         )
      {
        return; // We finished inside the ID envelope
      }
 
    // Otherwise we have a non-muon that started inside and ended outside the ID envelope!  KILL IT!
 
    ATH_MSG_VERBOSE( " We have a " << aStep->GetTrack()->GetDefinition()->GetParticleName()
                       << " going from " << std::endl
                       << " ----> " << aStep->GetPreStepPoint()->GetPhysicalVolume()->GetLogicalVolume()->GetRegion()->GetName()
                       << " to "
                       << aStep->GetPostStepPoint()->GetPhysicalVolume()->GetLogicalVolume()->GetRegion()->GetName()
                       << std::endl
                       << " with attributes: " << std::endl
                       << " Energy: " << aStep->GetTrack()->GetTotalEnergy()
                       << " Eta: " << aStep->GetTrack()->GetMomentum ().getEta()
                       << " Pt: " << aStep->GetTrack()->GetMomentum ().perp()
                       << " and at coordinates: " << std::endl
                       << " R: " << aStep->GetPostStepPoint()->GetPosition().rho()
                       << " Z: " << aStep->GetPostStepPoint()->GetPosition().z()
                       << " Phi: " << aStep->GetPostStepPoint()->GetPosition().phi() );
 
    // Outside DALEK mode: ignore electrons above a certain energy
    //  at some point it might be interesting to see what effect this has on other particles (eg pi0)
    if ( m_config.isDalek==false &&
         ( G4Electron::ElectronDefinition() == aStep->GetTrack()->GetDefinition() ||
           G4Positron::PositronDefinition() == aStep->GetTrack()->GetDefinition() ||
           G4Gamma::GammaDefinition() == aStep->GetTrack()->GetDefinition() ) &&
         m_config.energyCut < aStep->GetTrack()->GetTotalEnergy() ) return;
 
    // In DALEK mode: kill particles below threshold regardless of particle type
    if ( m_config.isDalek && m_config.energyCut < aStep->GetTrack()->GetKineticEnergy() ) return;
 
    if (msgLvl(MSG::DEBUG)){
      std::string name = aStep->GetTrack()->GetDefinition()->GetParticleName();
      ATH_MSG_DEBUG( " -------> The particle passed. It is a " << name << " and will be killed ! " );
    }
 
    // Otherwise kill the particle now
    KillParticle( aStep );
  }

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_config

Config G4UA::FastIDKiller::m_config

private

Definition at line 55 of file FastIDKiller.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_init

bool G4UA::FastIDKiller::m_init

private

Definition at line 57 of file FastIDKiller.h.

◆ 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_report

Report G4UA::FastIDKiller::m_report

private

Definition at line 56 of file FastIDKiller.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FastIDKiller()

Member Function Documentation

◆ BeginOfRunAction()

◆ getReport()

◆ initMessaging()

◆ KillParticle()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setLevel()

◆ UserSteppingAction()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_config

◆ m_imsg

◆ m_init

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_report