ISF::FatrasSimTool Class Reference

#include <FatrasSimTool.h>

Inheritance diagram for ISF::FatrasSimTool:

Collaboration diagram for ISF::FatrasSimTool:

Public Member Functions
	FatrasSimTool (const std::string &type, const std::string &name, const IInterface *parent)
	~FatrasSimTool ()
virtual StatusCode	initialize () override
virtual StatusCode	simulate (ISFParticle &isp, ISFParticleContainer &, McEventCollection *) override
virtual StatusCode	setupEvent (const EventContext &) override
	Setup Event chain - in case of a begin-of event action is needed. More...
virtual StatusCode	releaseEvent (const EventContext &) override
	Release Event chain - in case of an end-of event action is needed. More...
virtual ISF::SimulationFlavor	simFlavor () const override
virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() methods. More...
virtual StatusCode	setupEventST () override
	Setup Event chain - in case of a begin-of event action is needed (called by ISimulationSvc) More...
virtual StatusCode	simulateVector (const ISFParticleVector &particles, ISFParticleContainer &secondaries, McEventCollection *mcEventCollection, McEventCollection *) override
	Simulation call for vectors of particles. More...
virtual StatusCode	releaseEventST () override
	Release Event chain - in case of an end-of event action is needed (called by ISimulationSvc) More...
const ChronoEntity *	chronoStart (const IChronoSvc::ChronoTag &tag)
	wrapper call to start chrono with given tag More...
const ChronoEntity *	chronoStop (const IChronoSvc::ChronoTag &tag)
	wrapper call to stop chrono with given tag More...

Protected Attributes
std::string	m_chronoSvcName {"ChronoStatSvc"}
	Name of the timing service - can be set by declareProperty() More...
IChronoStatSvc *	m_chrono {}
	The timing service for general usage. More...

Private Attributes
PublicToolHandle< ISF::IParticleProcessor >	m_IDsimulationTool {this, "IDSimulationTool", "", ""}
	Track Creation & transport. More...
bool	m_useExtrapolator {true}
	Boolean used to run with the old extrapolator setup. More...
PublicToolHandle< ISF::IParticleProcessor >	m_simulationTool {this, "SimulationTool", "", ""}
	Pointer to the transport AlgTool. More...
PublicToolHandle< ISF::IParticleFilter >	m_particleFilter {this, "ParticleFilter", "", ""}
	the particle filter concerning kinematic cuts, etc. More...

Detailed Description

Definition at line 22 of file FatrasSimTool.h.

Constructor & Destructor Documentation

FatrasSimTool()

ISF::FatrasSimTool::FatrasSimTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 7 of file FatrasSimTool.cxx.

  : BaseSimulatorTool(type, name, parent)
{
  declareProperty("UseSimulationTool",  m_useExtrapolator);
}

~FatrasSimTool()

ISF::FatrasSimTool::~FatrasSimTool

(

)

Definition at line 13 of file FatrasSimTool.cxx.

                                 {
 
}

Member Function Documentation

chronoStart()

const ChronoEntity* ISF::BaseSimulatorTool::chronoStart ( const IChronoSvc::ChronoTag &  tag )

inlineinherited

wrapper call to start chrono with given tag

Definition at line 100 of file BaseSimulatorTool.h.

                                                                     {
      if (m_chrono) return m_chrono->chronoStart( tag);
      return nullptr;
    }

chronoStop()

const ChronoEntity* ISF::BaseSimulatorTool::chronoStop ( const IChronoSvc::ChronoTag &  tag )

inlineinherited

wrapper call to stop chrono with given tag

Definition at line 106 of file BaseSimulatorTool.h.

                                                                    {
      if (m_chrono) return m_chrono->chronoStop( tag);
      return nullptr;
    }

initialize()

StatusCode ISF::FatrasSimTool::initialize ( )

overridevirtual

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 17 of file FatrasSimTool.cxx.

                                        {
 
  ATH_CHECK( BaseSimulatorTool::initialize() );
 
  // retrieve simulation tool
  ATH_CHECK( m_IDsimulationTool.retrieve() );
 
  // retrieve simulation tool
  if ( m_useExtrapolator ) {
    ATH_CHECK( m_simulationTool.retrieve() );
  }
  else {
    m_simulationTool.disable();
    ATH_MSG_INFO ( "Using only Extrapolation Engine Tools...");
  }
 
  // retrieve particle filter
  if ( !m_particleFilter.empty() ) {
    ATH_CHECK( m_particleFilter.retrieve() );
  }
  return StatusCode::SUCCESS;
}

releaseEvent()

virtual StatusCode ISF::FatrasSimTool::releaseEvent ( const EventContext &  )

inlineoverridevirtual

Release Event chain - in case of an end-of event action is needed.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 34 of file FatrasSimTool.h.

{ return StatusCode::SUCCESS; };

releaseEventST()

virtual StatusCode ISF::BaseSimulatorTool::releaseEventST ( )

inlineoverridevirtualinherited

Release Event chain - in case of an end-of event action is needed (called by ISimulationSvc)

Reimplemented in ISF::FastCaloSimV2Tool.

Definition at line 96 of file BaseSimulatorTool.h.

    { return releaseEvent(Gaudi::Hive::currentContext()); }

setupEvent()

virtual StatusCode ISF::FatrasSimTool::setupEvent ( const EventContext &  )

inlineoverridevirtual

Setup Event chain - in case of a begin-of event action is needed.

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 32 of file FatrasSimTool.h.

{ return StatusCode::SUCCESS; };

setupEventST()

virtual StatusCode ISF::BaseSimulatorTool::setupEventST ( )

inlineoverridevirtualinherited

Setup Event chain - in case of a begin-of event action is needed (called by ISimulationSvc)

Reimplemented in ISF::FastCaloSimV2Tool.

Definition at line 69 of file BaseSimulatorTool.h.

    { return setupEvent(Gaudi::Hive::currentContext()); }

simFlavor()

virtual ISF::SimulationFlavor ISF::FatrasSimTool::simFlavor ( ) const

inlineoverridevirtual

Definition at line 36 of file FatrasSimTool.h.

{ return ISF::Fatras; };

simulate()

StatusCode ISF::FatrasSimTool::simulate ( ISFParticle &  isp, ISFParticleContainer &  secondaries, McEventCollection *    )

overridevirtual

Process Particle from particle broker

Reimplemented from ISF::BaseSimulatorTool.

Definition at line 40 of file FatrasSimTool.cxx.

                                                                                                               {
 
  // give a screen output that you entered FatrasSimSvc
  ATH_MSG_VERBOSE( "Particle " << isp << " received for simulation." );
 
  // now decide what to do with the particle
  if (!m_particleFilter.empty() && !m_particleFilter->passFilter(isp)){
      ATH_MSG_VERBOSE( "ISFParticle " << isp << " does not pass selection. Ignore.");
      return StatusCode::SUCCESS;
  }
  ISF::ISFParticle* newIsp = (isp.nextGeoID()==AtlasDetDescr::fAtlasID || isp.nextGeoID()==AtlasDetDescr::fAtlasForward) ? m_IDsimulationTool->process(isp) : m_simulationTool->process(isp);
  ATH_MSG_VERBOSE( "Simulation created : " << ( newIsp ? "" : "no") << " new particle");
 
  if (newIsp) {
    // new particle into the stack
    secondaries.push_back(newIsp);
  }
 
  // Fatras call done
  return StatusCode::SUCCESS;
}

simulateVector()

virtual StatusCode ISF::BaseSimulatorTool::simulateVector ( const ISFParticleVector &  particles, ISFParticleContainer &  secondaries, McEventCollection *  mcEventCollection, McEventCollection *    )

inlineoverridevirtualinherited

Simulation call for vectors of particles.

Reimplemented in ISF::ActsFatrasSimTool, ISF::ParticleKillerSimTool, iGeant4::G4TransportTool, and iGeant4::G4LegacyTransportTool.

Definition at line 77 of file BaseSimulatorTool.h.

    {
      // this implementation is a wrapper in case the simulator does
      // implement particle-vector input
 
      // simulate each particle individually
      for (auto* cisp : particles) {
        ATH_MSG_VERBOSE( "Starting simulation of particle: " << (*cisp) );
        ATH_CHECK(this->simulate(*cisp, secondaries, mcEventCollection));
      }
      return StatusCode::SUCCESS;
 
    }

sysInitialize()

virtual StatusCode ISF::BaseSimulatorTool::sysInitialize ( )

inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 51 of file BaseSimulatorTool.h.

    {
      ATH_CHECK( AthAlgTool::sysInitialize() );
      ATH_CHECK( serviceLocator()->service(m_chronoSvcName, m_chrono ) );
      return StatusCode::SUCCESS;
    }

Member Data Documentation

m_chrono

IChronoStatSvc* ISF::BaseSimulatorTool::m_chrono {}

protectedinherited

The timing service for general usage.

Definition at line 120 of file BaseSimulatorTool.h.

m_chronoSvcName

std::string ISF::BaseSimulatorTool::m_chronoSvcName {"ChronoStatSvc"}

protectedinherited

Name of the timing service - can be set by declareProperty()

Definition at line 117 of file BaseSimulatorTool.h.

m_IDsimulationTool

PublicToolHandle<ISF::IParticleProcessor> ISF::FatrasSimTool::m_IDsimulationTool {this, "IDSimulationTool", "", ""}

private

Track Creation & transport.

Pointer to the transport AlgTool

Definition at line 41 of file FatrasSimTool.h.

m_particleFilter

PublicToolHandle<ISF::IParticleFilter> ISF::FatrasSimTool::m_particleFilter {this, "ParticleFilter", "", ""}

private

the particle filter concerning kinematic cuts, etc.

Definition at line 44 of file FatrasSimTool.h.

m_simulationTool

PublicToolHandle<ISF::IParticleProcessor> ISF::FatrasSimTool::m_simulationTool {this, "SimulationTool", "", ""}

private

Pointer to the transport AlgTool.

Definition at line 43 of file FatrasSimTool.h.

m_useExtrapolator

bool ISF::FatrasSimTool::m_useExtrapolator {true}

private

Boolean used to run with the old extrapolator setup.

Definition at line 42 of file FatrasSimTool.h.

---

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

• FatrasSimTool.h
• FatrasSimTool.cxx