Inheritance diagram for evgen::TextFileGen:

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

void	produce (art::Event &e) override

void	beginJob () override

void	beginRun (art::Run &run) override

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::ifstream *	fInputFile

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

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

Additional Inherited Members
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 >

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

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 79 of file TextFileGen_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 95 of file TextFileGen_module.cc.

   : EDProducer{p}
   , 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 111 of file TextFileGen_module.cc.

 {
   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";
 }

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

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 123 of file TextFileGen_module.cc.

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

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

overridevirtual

Implements art::EDProducer.

Definition at line 130 of file TextFileGen_module.cc.

 {
   // check that the file is still good
   if( !fInputFile->good() )
     throw cet::exception("TextFileGen") << "input text file "
                                         << fInputFileName
                                         << " cannot be read in produce().\n";
 
 
   std::unique_ptr< std::vector<simb::MCTruth> > truthcol(new std::vector<simb::MCTruth>);
   simb::MCTruth truth;
 
   // declare the variables for reading in the event record
   int            event          = 0;
   unsigned short nParticles     = 0;
   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::getline(*fInputFile, oneLine);
   std::istringstream inputLine;
   inputLine.str(oneLine);
 
   inputLine >> event >> nParticles;
 
   // 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);
 
     truth.Add(part);
   }
 
   truthcol->push_back(truth);
 
   e.put(std::move(truthcol));
 }

Member Data Documentation

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

private

Definition at line 89 of file TextFileGen_module.cc.

std::string evgen::TextFileGen::fInputFileName

private

Name of text file containing events to simulate.

Definition at line 90 of file TextFileGen_module.cc.

double evgen::TextFileGen::fMoveY

private

Project particles to a new y plane.

Definition at line 91 of file TextFileGen_module.cc.

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

larsim/larsim/EventGenerator/TextFileGen_module.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation