Inheritance diagram for evgen::TextFileGen:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	TextFileGen (fhicl::ParameterSet const &p)

void	produce (art::Event &e) override

void	beginJob () override

void	beginRun (art::Run &run) override

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Protected Member Functions
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 ()

Private Member Functions
std::pair< unsigned, unsigned >	readEventInfo (std::istream &is)

simb::MCTruth	readNextHepEvt ()

Private Attributes
unsigned long int	fOffset

std::ifstream *	fInputFile

std::string	fInputFileName
	Name of text file containing events to simulate. More...

double	fMoveY
	Project particles to a new y plane. More...

Detailed Description

This module assumes that the input file has the hepevt format for each event to be simulated. See

http://cepa.fnal.gov/psm/simulation/mcgen/lund/pythia_manual/pythia6.3/pythia6301/node39.html

for details on the format. In brief each event contains at least two lines. The first line contains two entries, the event number (which is ignored in ART/LArSoft) and the number of particles in the event. Each following line containes 15 entries to describe each particle. The entries are:

status code (should be set to 1 for any particle to be tracked, others won't be tracked)
the pdg code for the particle
the entry of the first mother for this particle in the event, 0 means no mother
the entry of the second mother for this particle in the event, 0 means no mother
the entry of the first daughter for this particle in the event, 0 means no daughter
the entry of the second daughter for this particle in the event, 0 means no daughter
x component of the particle momentum
y component of the particle momentum
z component of the particle momentum
energy of the particle
mass of the particle
x position of the particle initial position
y position of the particle initial position
z position of the particle initial position
time of the particle production

For example, if you want to simulate a single muon with a 5 GeV energy moving only in the z direction, the entry would be

0 1

1 13 0 0 0 0 0. 0. 1.0 5.0011 0.105 1.0 1.0 1.0 0.0

There are some assumptions that go into using this format that may not be obvious. The first is that only particles with status code = 1 are tracked in the LArSoft/Geant4 combination making the mother daughter relations somewhat irrelevant. That also means that you should let Geant4 handle any decays.

The units in LArSoft are cm for distances and ns for time. The use of TLorentzVector below does not imply space and time have the same units (do not use TLorentzVector::Boost()).

Definition at line 83 of file TextFileGen_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

evgen::TextFileGen::TextFileGen ( fhicl::ParameterSet const & p )

explicit

Definition at line 101 of file TextFileGen_module.cc.

References fInputFile, fInputFileName, fMoveY, and fOffset.

   : EDProducer{p}
   , fOffset{p.get<unsigned long int>("Offset")}
   , fInputFile(0)
   , fInputFileName{p.get<std::string>("InputFileName")}
   , fMoveY{p.get<double>("MoveY", -1e9)}
 {
   if (fMoveY > -1e8) {
     mf::LogWarning("TextFileGen") << "Particles will be moved to a new plane y = " << fMoveY
                                   << " cm.\n";
   }
 
   produces<std::vector<simb::MCTruth>>();
   produces<sumdata::RunData, art::InRun>();
 }

Member Function Documentation

void evgen::TextFileGen::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 118 of file TextFileGen_module.cc.

References fInputFile, fInputFileName, fOffset, and readEventInfo().

 {
   fInputFile = new std::ifstream(fInputFileName.c_str());
 
   // check that the file is a good one
   if (!fInputFile->good())
     throw cet::exception("TextFileGen")
       << "input text file " << fInputFileName << " cannot be read.\n";
 
   for (unsigned i = 0; i != fOffset; ++i) {
     auto const [eventNo, nparticles] = readEventInfo(*fInputFile);
     for (unsigned p = 0; p != nparticles; ++p) {
       constexpr auto all_chars_until = std::numeric_limits<unsigned>::max();
       fInputFile->ignore(all_chars_until, '\n');
     }
   }
 }

void evgen::TextFileGen::beginRun ( art::Run & run )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 137 of file TextFileGen_module.cc.

References geo::GeometryCore::DetectorName(), art::fullRun(), and art::Run::put().

 {
   art::ServiceHandle<geo::Geometry const> geo;
   run.put(std::make_unique<sumdata::RunData>(geo->DetectorName()), art::fullRun());
 }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::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
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

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

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void evgen::TextFileGen::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 144 of file TextFileGen_module.cc.

References fInputFile, fInputFileName, art::Event::put(), and readNextHepEvt().

 {
   // check that the file is still good
   if (!fInputFile->good())
     throw cet::exception("TextFileGen")
       << "input text file " << fInputFileName << " cannot be read in produce().\n";
 
   //Now, read the Event to be used.
 
   // check that the file is still good
   if (!fInputFile->good())
     throw cet::exception("TextFileGen")
       << "input text file " << fInputFileName << " cannot be read in produce().\n";
   auto truthcol = std::make_unique<std::vector<simb::MCTruth>>();
   truthcol->push_back(readNextHepEvt());
 
   e.put(std::move(truthcol));
 }

std::pair< unsigned, unsigned > evgen::TextFileGen::readEventInfo ( std::istream & is )

private

Definition at line 228 of file TextFileGen_module.cc.

References DEFINE_ART_MODULE.

Referenced by beginJob(), and readNextHepEvt().

 {
   std::string line;
   getline(iss, line);
   std::istringstream buffer{line};
 
   // Parse read line for the event number and particles per event
   unsigned event, nparticles;
   buffer >> event >> nparticles;
   return {event, nparticles};
 }

simb::MCTruth evgen::TextFileGen::readNextHepEvt ( )

private

Definition at line 163 of file TextFileGen_module.cc.

References simb::MCTruth::Add(), simb::MCParticle::AddTrajectoryPoint(), energy, fInputFile, fMoveY, part, and readEventInfo().

Referenced by produce().

 {
 
   // declare the variables for reading in the event record
   int status = 0;
   int pdg = 0;
   int firstMother = 0;
   int secondMother = 0;
   int firstDaughter = 0;
   int secondDaughter = 0;
   double xMomentum = 0.;
   double yMomentum = 0.;
   double zMomentum = 0.;
   double energy = 0.;
   double mass = 0.;
   double xPosition = 0.;
   double yPosition = 0.;
   double zPosition = 0.;
   double time = 0.;
 
   // read in line to get event number and number of particles
   std::string oneLine;
   std::istringstream inputLine;
   simb::MCTruth nextEvent;
   auto const [eventNo, nParticles] = readEventInfo(*fInputFile);
 
   // now read in all the lines for the particles
   // in this interaction. only particles with
   // status = 1 get tracked in Geant4.
   for (unsigned short i = 0; i < nParticles; ++i) {
     std::getline(*fInputFile, oneLine);
     inputLine.clear();
     inputLine.str(oneLine);
 
     inputLine >> status >> pdg >> firstMother >> secondMother >> firstDaughter >> secondDaughter >>
       xMomentum >> yMomentum >> zMomentum >> energy >> mass >> xPosition >> yPosition >>
       zPosition >> time;
 
     //Project the particle to a new y plane
     if (fMoveY > -1e8) {
       double totmom = sqrt(pow(xMomentum, 2) + pow(yMomentum, 2) + pow(zMomentum, 2));
       double kx = xMomentum / totmom;
       double ky = yMomentum / totmom;
       double kz = zMomentum / totmom;
       if (ky) {
         double l = (fMoveY - yPosition) / ky;
         xPosition += kx * l;
         yPosition += ky * l;
         zPosition += kz * l;
       }
     }
 
     TLorentzVector pos(xPosition, yPosition, zPosition, time);
     TLorentzVector mom(xMomentum, yMomentum, zMomentum, energy);
 
     simb::MCParticle part(i, pdg, "primary", firstMother, mass, status);
     part.AddTrajectoryPoint(pos, mom);
 
     nextEvent.Add(part);
 
   } //  end loop on particles.
 
   return nextEvent;
 }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

std::ifstream* evgen::TextFileGen::fInputFile

private

Definition at line 95 of file TextFileGen_module.cc.

Referenced by beginJob(), produce(), readNextHepEvt(), and TextFileGen().

std::string evgen::TextFileGen::fInputFileName

private

Name of text file containing events to simulate.

Definition at line 96 of file TextFileGen_module.cc.

Referenced by beginJob(), produce(), and TextFileGen().

double evgen::TextFileGen::fMoveY

private

Project particles to a new y plane.

Definition at line 97 of file TextFileGen_module.cc.

Referenced by readNextHepEvt(), and TextFileGen().

unsigned long int evgen::TextFileGen::fOffset

private

Definition at line 94 of file TextFileGen_module.cc.

Referenced by beginJob(), and TextFileGen().

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

larsim/v09_43_00/source/larsim/EventGenerator/TextFileGen_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation