Creates a collection of simulated particles. More...

Inheritance diagram for lar::example::tests::ParticleMaker:

Classes
struct	Config

struct	ParticleConfig

struct	ParticleSpecs

Public Types
using	Parameters = art::EDProducer::Table< Config >

Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	ParticleMaker (Parameters const &config)
	Constructor; see the class documentation for the configuration. More...

virtual void	produce (art::Event &event) override
	Create and add the particles (the same for all events). More...

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
std::vector< ParticleSpecs >	fParticleSpecs
	Settings for particles. More...

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Creates a collection of simulated particles.

A collection of simb::MCParticle is added to the event. The particles are one starting where the previous one ended (starting from the origin). The configuration specifies the number, type and energy of the particles, and their path length.

Configuration parameters

particles (list of structures, mandatory): each element in the list is a table with entries:
- length (real, mandatory): particle path length [cm]
- energy (real, mandatory): particle energy [GeV]
- type (integer, mandatory): particle type as PDG ID

Definition at line 60 of file ParticleMaker_module.cc.

Member Typedef Documentation

using lar::example::tests::ParticleMaker::Parameters = art::EDProducer::Table<Config>

Definition at line 98 of file ParticleMaker_module.cc.

Constructor & Destructor Documentation

lar::example::tests::ParticleMaker::ParticleMaker ( Parameters const & config )

explicit

Constructor; see the class documentation for the configuration.

Definition at line 138 of file ParticleMaker_module.cc.

   : EDProducer{config}
 {
 
   auto const& particleSpecs = config().particles();
   fParticleSpecs.assign(particleSpecs.begin(), particleSpecs.end());
 
   // consumes: nothing
 
   // produces:
   produces<std::vector<simb::MCParticle>>();
 
 } // lar::example::tests::ParticleMaker::ParticleMaker()

Member Function Documentation

void lar::example::tests::ParticleMaker::produce ( art::Event & event )

overridevirtual

Create and add the particles (the same for all events).

Implements art::EDProducer.

Definition at line 154 of file ParticleMaker_module.cc.

                                                           {
 
   //
   // set up
   //
 
   // container for the data product
   auto particles = std::make_unique<std::vector<simb::MCParticle>>();
 
   //
   // creation of the particles
   //
   static std::array<TVector3, 6U> const Dirs = {{
     geo::vect::rounded01( geo::Xaxis<TVector3>(), 1e-8),
     geo::vect::rounded01( geo::Yaxis<TVector3>(), 1e-8),
     geo::vect::rounded01( geo::Zaxis<TVector3>(), 1e-8),
     geo::vect::rounded01(-geo::Xaxis<TVector3>(), 1e-8),
     geo::vect::rounded01(-geo::Yaxis<TVector3>(), 1e-8),
     geo::vect::rounded01(-geo::Zaxis<TVector3>(), 1e-8)
   }}; // Dirs
 
   int trackID = 0;
   TLorentzVector pos;
   for (auto const& specs: fParticleSpecs) {
 
     int const motherID = trackID - 1;
     if (motherID >= 0) (*particles)[motherID].AddDaughter(trackID);
 
     particles->emplace_back(
         trackID           // track ID
       , specs.type        // pdg
       , "magic"           // process
       , motherID          // mother
       );
     simb::MCParticle& particle = particles->back();
 
     auto const& dir = Dirs[trackID % 6];
     TLorentzVector const mom{ specs.energy * dir, specs.energy };
     unsigned int const nSteps = std::ceil(specs.length);
     particle.AddTrajectoryPoint(pos, mom);
     for (unsigned int i = 1; i <= nSteps; ++i) {
       double const stepSize = std::min(specs.length - double(i - 1), 1.0);
       pos += TLorentzVector{ dir * stepSize, 1.0 };
       particle.AddTrajectoryPoint(pos, mom);
     } // for
 
     ++trackID;
 
   } // for specs
 
   //
   // result storage
   //
   mf::LogInfo("ParticleMaker")
     << "Created " << particles->size() << " space points.";
 
   event.put(std::move(particles));
 
 } // lar::example::tests::ParticleMaker::produce()

Member Data Documentation

std::vector<ParticleSpecs> lar::example::tests::ParticleMaker::fParticleSpecs

private

Settings for particles.

Definition at line 120 of file ParticleMaker_module.cc.

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

larexamples/test/Algorithms/TotallyCheatTracks/ParticleMaker_module.cc

Classes

Public Types

Public Member Functions