Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t > Struct Template Reference

#include <acts/blob/sPHENIX/Fatras/include/ActsFatras/Kernel/Simulation.hpp>

+ Collaboration diagram for ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >:

Public Member Functions

 SingleParticleSimulation (propagator_t &&propagator_, std::unique_ptr< const Acts::Logger > _logger)
 Alternatively construct the simulator with an external logger.
 
template<typename generator_t >
Acts::Result< SimulationResult > simulate (const Acts::GeometryContext &geoCtx, const Acts::MagneticFieldContext &magCtx, generator_t &generator, const Particle &particle) const
 

Public Attributes

propagator_t propagator
 How and within which geometry to propagate the particle.
 
decay_t decay
 Decay module.
 
interactions_t interactions
 Interaction list containing the simulated interactions.
 
hit_surface_selector_t selectHitSurface
 Selector for surfaces that should generate hits.
 
std::unique_ptr< const
Acts::Logger > 		logger
 Logger for debug output.
 

Detailed Description

template<typename propagator_t, typename interactions_t, typename hit_surface_selector_t, typename decay_t>
struct ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >

Single particle simulation with fixed propagator, interactions, and decay.

Template Parameters
generator_trandom number generator
interactions_tinteraction list
hit_surface_selector_tselector for hit surfaces
decay_tdecay module

Definition at line 44 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 44 of file Simulation.hpp

Constructor & Destructor Documentation

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::SingleParticleSimulation ( propagator_t &&  propagator_,
std::unique_ptr< const Acts::Logger >  _logger 
)
inline

Alternatively construct the simulator with an external logger.

Definition at line 57 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 57 of file Simulation.hpp

Member Function Documentation

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
template<typename generator_t >
Acts::Result<SimulationResult> ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::simulate ( const Acts::GeometryContext &  geoCtx,
const Acts::MagneticFieldContext &  magCtx,
generator_t &  generator,
const Particle &  particle 
) const
inline

Simulate a single particle without secondaries.

Template Parameters
generator_tis the type of the random number generator
Parameters
geoCtxis the geometry context to access surface geometries
magCtxis the magnetic field context to access field values
generatoris the random number generator
particleis the initial particle state
Returns
Simulated particle state, hits, and generated particles.

Definition at line 71 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 71 of file Simulation.hpp

References testing::internal::posix::Abort(), ActsFatras::Particle::boundParameters(), ActsFatras::Particle::curvilinearParameters(), ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::decay, Fatras::Test::generator, ActsFatras::Particle::hasReferenceSurface(), ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::interactions, testing::internal::move(), ckf::options, particle, ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::propagator, ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::selectHitSurface, and value.

+ Here is the call graph for this function:

Member Data Documentation

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
decay_t ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::decay

Decay module.

Definition at line 48 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 48 of file Simulation.hpp

Referenced by ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::simulate().

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
interactions_t ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::interactions

Interaction list containing the simulated interactions.

Definition at line 50 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 50 of file Simulation.hpp

Referenced by ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::simulate().

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
std::unique_ptr<const Acts::Logger> ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::logger

Logger for debug output.

Definition at line 54 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 54 of file Simulation.hpp

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
propagator_t ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::propagator

How and within which geometry to propagate the particle.

Definition at line 46 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 46 of file Simulation.hpp

Referenced by ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::simulate().

template<typename propagator_t , typename interactions_t , typename hit_surface_selector_t , typename decay_t >
hit_surface_selector_t ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::selectHitSurface

Selector for surfaces that should generate hits.

Definition at line 52 of file Simulation.hpp.

View newest version in sPHENIX GitHub at line 52 of file Simulation.hpp

Referenced by ActsFatras::SingleParticleSimulation< propagator_t, interactions_t, hit_surface_selector_t, decay_t >::simulate().

The documentation for this struct was generated from the following file: