module to produce single or multiple specified particles in the detector More...

Inheritance diagram for evgen::SingleGen:

Classes
struct	Config

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

using	ModuleType = EDProducer

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

Public Member Functions
	SingleGen (Parameters const &config)

void	produce (art::Event &evt) 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
void	SampleOne (unsigned int i, simb::MCTruth &mct)

void	SampleMany (simb::MCTruth &mct)

void	Sample (simb::MCTruth &mct)

void	printVecs (std::vector< std::string > const &list)

bool	PadVector (std::vector< double > &vec)

double	SelectFromHist (const TH1 &h)

void	SelectFromHist (const TH2 &h, double &x, double &y)

void	beginRun (art::Run &run) override
	Act on begin of run: write "RunData" information (`sumdata::RunData`). More...

void	setup ()
	Performs checks and initialization based on the current configuration. More...

Static Private Member Functions
static std::map< int, std::string >	makeParticleSelectionModeNames ()
	Returns a vector with the name of particle selection mode keywords. More...

static std::map< int, std::string >	makeDistributionNames ()
	Returns a vector with the name of distribution keywords. More...

template<typename OptionList >
static auto	selectOption (std::string Option, OptionList const &allowedOptions) -> decltype(auto)
	Parses an option string and returns the corresponding option number. More...

template<typename OptionList >
static std::string	presentOptions (OptionList const &allowedOptions, bool printKey, std::initializer_list< typename OptionList::value_type::first_type > exclude)
	Returns a string describing all options in the list. More...

template<typename OptionList >
static std::string	presentOptions (OptionList const &allowedOptions, bool printKey=true)

template<typename OptionList >
static std::string	optionName (typename OptionList::value_type::first_type optionKey, OptionList const &allowedOptions, std::string defName="<unknown>")
	Returns the name of the specified option key, or `defName` if not known. More...

Private Attributes
int	fMode

bool	fPadOutVectors

std::vector< int >	fPDG
	PDG code of particles to generate. More...

std::vector< double >	fP0
	Central momentum (GeV/c) to generate. More...

std::vector< double >	fSigmaP
	Variation in momenta (GeV/c) More...

int	fPDist
	How to distribute momenta (gaus or uniform) More...

std::vector< double >	fX0
	Central x position (cm) in world coordinates. More...

std::vector< double >	fY0
	Central y position (cm) in world coordinates. More...

std::vector< double >	fZ0
	Central z position (cm) in world coordinates. More...

std::vector< double >	fT0
	Central t position (s) in world coordinates. More...

std::vector< double >	fSigmaX
	Variation in x position (cm) More...

std::vector< double >	fSigmaY
	Variation in y position (cm) More...

std::vector< double >	fSigmaZ
	Variation in z position (cm) More...

std::vector< double >	fSigmaT
	Variation in t position (s) More...

int	fPosDist
	How to distribute xyz (gaus, or uniform) More...

int	fTDist
	How to distribute t (gaus, or uniform) More...

bool	fSingleVertex
	if true - all particles produced at the same location More...

std::vector< double >	fTheta0XZ
	Angle in XZ plane (degrees) More...

std::vector< double >	fTheta0YZ
	Angle in YZ plane (degrees) More...

std::vector< double >	fSigmaThetaXZ
	Variation in angle in XZ plane. More...

std::vector< double >	fSigmaThetaYZ
	Variation in angle in YZ plane. More...

int	fAngleDist
	How to distribute angles (gaus, uniform) More...

std::string	fHistFileName
	Filename containing histogram of momenta. More...

std::vector< std::string >	fPHist
	name of histogram of momenta More...

std::vector< std::string >	fThetaXzYzHist
	name of histogram for thetaxz/thetayz distribution More...

std::vector< std::unique_ptr< TH1 > >	hPHist

std::vector< std::unique_ptr< TH2 > >	hThetaXzYzHist
	actual TH1 for momentum distributions More...

CLHEP::HepRandomEngine &	fEngine
	actual TH2 for angle distributions - Xz on x axis . More...

Static Private Attributes
static const std::map< int, std::string >	ParticleSelectionModeNames
	Names of all particle selection modes. More...

static const std::map< int, std::string >	DistributionNames
	Names of all distribution modes. More...

Constants for particle type extraction mode (`ParticleSelectionMode` parameter).
static constexpr int	kSelectAllParts = 0
	One particle per entry is generated. More...

static constexpr int	kSelectOneRandPart

Constants for kinematic distribution options.
static constexpr int	kUNIF = 0
	Uniform distribution. More...

static constexpr int	kGAUS = 1
	Gaussian distribution. More...

static constexpr int	kHIST = 2

Detailed Description

module to produce single or multiple specified particles in the detector

Definition at line 61 of file SingleGen_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

using evgen::SingleGen::Parameters = art::EDProducer::Table<Config>

Definition at line 187 of file SingleGen_module.cc.

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::SingleGen::SingleGen ( Parameters const & config )

explicit

Definition at line 423 of file SingleGen_module.cc.

References art::detail::EngineCreator::createEngine(), DistributionNames, fAngleDist, fEngine, fHistFileName, fMode, fP0, fPadOutVectors, fPDG, fPDist, fPHist, fPosDist, fSigmaP, fSigmaT, fSigmaThetaXZ, fSigmaThetaYZ, fSigmaX, fSigmaY, fSigmaZ, fSingleVertex, fT0, fTDist, fTheta0XZ, fTheta0YZ, fThetaXzYzHist, fX0, fY0, fZ0, ParticleSelectionModeNames, seed, selectOption(), and setup().

     : EDProducer{config}
     , fMode(selectOption(config().ParticleSelectionMode(), ParticleSelectionModeNames))
     , fPadOutVectors(config().PadOutVectors())
     , fPDG(config().PDG())
     , fP0(config().P0())
     , fSigmaP(config().SigmaP())
     , fPDist(selectOption(config().PDist(), DistributionNames))
     , fX0(config().X0())
     , fY0(config().Y0())
     , fZ0(config().Z0())
     , fT0(config().T0())
     , fSigmaX(config().SigmaX())
     , fSigmaY(config().SigmaY())
     , fSigmaZ(config().SigmaZ())
     , fSigmaT(config().SigmaT())
     , fPosDist(selectOption(config().PosDist(), DistributionNames))
     , fTDist(selectOption(config().TDist(), DistributionNames))
     , fSingleVertex(config().SingleVertex())
     , fTheta0XZ(config().Theta0XZ())
     , fTheta0YZ(config().Theta0YZ())
     , fSigmaThetaXZ(config().SigmaThetaXZ())
     , fSigmaThetaYZ(config().SigmaThetaYZ())
     , fAngleDist(selectOption(config().AngleDist(), DistributionNames))
     , fHistFileName(config().HistogramFile())
     , fPHist(config().PHist())
     , fThetaXzYzHist(config().ThetaXzYzHist())
     , fEngine(createEngine(0))
   {
     setup();
     rndm::NuRandomService::seed_t seed;
     if (config().Seed(seed)) { fEngine.setSeed(seed, 0 /* dummy? */); }
 
     produces<std::vector<simb::MCTruth>>();
     produces<sumdata::RunData, art::InRun>();
   }

Member Function Documentation

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

overrideprivatevirtual

Act on begin of run: write "RunData" information (sumdata::RunData).

Reimplemented from art::EDProducer.

Definition at line 461 of file SingleGen_module.cc.

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

   {
     geo::GeometryCore const& geom = *(lar::providerFrom<geo::Geometry>());
     run.put(std::make_unique<sumdata::RunData>(geom.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::map< int, std::string > evgen::SingleGen::makeDistributionNames ( )

staticprivate

Returns a vector with the name of distribution keywords.

Definition at line 346 of file SingleGen_module.cc.

References DistributionNames, kGAUS, kHIST, kUNIF, makeParticleSelectionModeNames(), and ParticleSelectionModeNames.

   {
     std::map<int, std::string> names;
     names[int(kUNIF)] = "uniform";
     names[int(kGAUS)] = "Gaussian";
     names[int(kHIST)] = "histograms";
     return names;
   } // SingleGen::makeDistributionNames()

std::map< int, std::string > evgen::SingleGen::makeParticleSelectionModeNames ( )

staticprivate

Returns a vector with the name of particle selection mode keywords.

Definition at line 338 of file SingleGen_module.cc.

References kSelectAllParts, and kSelectOneRandPart.

Referenced by makeDistributionNames().

   {
     std::map<int, std::string> names;
     names[int(kSelectAllParts)] = "all";
     names[int(kSelectOneRandPart)] = "singleRandom";
     return names;
   } // SingleGen::makeParticleSelectionModeNames()

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

template<typename OptionList >

std::string evgen::SingleGen::optionName	(	typename OptionList::value_type::first_type	optionKey,
		OptionList const &	allowedOptions,
		std::string	defName = `"<unknown>"`
	)

staticprivate

Returns the name of the specified option key, or defName if not known.

Definition at line 407 of file SingleGen_module.cc.

Referenced by presentOptions(), and setup().

   {
     auto iOption = allowedOptions.find(optionKey);
     return (iOption != allowedOptions.end()) ? iOption->second : defName;
   } // SingleGen::optionName()

bool evgen::SingleGen::PadVector ( std::vector< double > & vec )

private

Definition at line 657 of file SingleGen_module.cc.

References fPadOutVectors, and fPDG.

Referenced by setup().

   {
     // check if the vec has the same size as fPDG
     if (vec.size() != fPDG.size()) {
       // if not padding out the vectors always cause an
       // exception to be thrown if the vector in question
       // is not the same size as the fPDG vector
       // the exception is thrown in the reconfigure method
       // that calls this one
       if (!fPadOutVectors)
         return false;
       else if (fPadOutVectors) {
         // if padding of vectors is desired but the vector in
         // question has more than one entry it isn't clear
         // what the padded values should be so cause
         // an exception
         if (vec.size() != 1) return false;
 
         // pad it out
         vec.resize(fPDG.size(), vec[0]);
 
       } // end if padding out vectors
     }   // end if the vector size is not the same as fPDG
 
     return true;
   }

template<typename OptionList >

std::string evgen::SingleGen::presentOptions	(	OptionList const &	allowedOptions,
		bool	printKey,
		std::initializer_list< typename OptionList::value_type::first_type >	exclude
	)

staticprivate

Returns a string describing all options in the list.

Template Parameters

OptionList type of list of options (e.g. std::map<int, std::string>)

Parameters

allowedOptions	the list of allowed options
printKey	whether to print the key of the option beside its name
excludeKeys	list of keys to be ignored (none by default)

Returns: a string with all options in a line

The result string is a list of option names, separated by commas, like in `"'apple', 'orange', 'banana'". IfprintKeyistrue`, the key of each option is also written in parentheses, like in `"'apple' (1), 'orange' (7), 'banana' (2)"`.

Definition at line 387 of file SingleGen_module.cc.

References n, and util::to_string().

Referenced by presentOptions().

   {
     std::string msg;
 
     unsigned int n = 0;
     for (auto const& option : allowedOptions) {
       auto const& key = option.first;
       if (std::find(exclude.begin(), exclude.end(), key) != exclude.end()) continue;
       if (n++ > 0) msg += ", ";
       msg += '\"' + std::string(option.second) + '\"';
       if (printKey) msg += " (" + std::to_string(key) + ")";
     } // for
     return msg;
   } // SingleGen::presentOptions()

template<typename OptionList >

static std::string evgen::SingleGen::presentOptions	(	OptionList const &	allowedOptions,
		bool	printKey = `true`
	)

inlinestaticprivate

Definition at line 322 of file SingleGen_module.cc.

References optionName(), and presentOptions().

     {
       return presentOptions(allowedOptions, printKey, {});
     }

void evgen::SingleGen::printVecs ( std::vector< std::string > const & list )

private

Definition at line 964 of file SingleGen_module.cc.

References e, fP0, fPDG, fSigmaP, fSigmaT, fSigmaThetaXZ, fSigmaThetaYZ, fSigmaX, fSigmaY, fSigmaZ, fT0, fTheta0XZ, fTheta0YZ, fX0, fY0, fZ0, and util::values().

Referenced by setup().

   {
 
     mf::LogInfo("SingleGen") << " You are using vector values for SingleGen configuration.\n   "
                              << " Some of the configuration vectors may have been padded out ,"
                              << " because they (weren't) as long as the pdg vector"
                              << " in your configuration. \n"
                              << " The new input particle configuration is:\n";
 
     std::string values;
     for (size_t i = 0; i <= 1; ++i) { // list.size(); ++i){
 
       values.append(list[i]);
       values.append(": [ ");
 
       for (size_t e = 0; e < fPDG.size(); ++e) {
         std::stringstream buf;
         buf.width(10);
         if (i == 0) buf << fPDG[e] << ", ";
         buf.precision(5);
         if (i == 1) buf << fP0[e] << ", ";
         if (i == 2) buf << fSigmaP[e] << ", ";
         if (i == 3) buf << fX0[e] << ", ";
         if (i == 4) buf << fY0[e] << ", ";
         if (i == 5) buf << fZ0[e] << ", ";
         if (i == 6) buf << fSigmaX[e] << ", ";
         if (i == 7) buf << fSigmaY[e] << ", ";
         if (i == 8) buf << fSigmaZ[e] << ", ";
         if (i == 9) buf << fTheta0XZ[e] << ", ";
         if (i == 10) buf << fTheta0YZ[e] << ", ";
         if (i == 11) buf << fSigmaThetaXZ[e] << ", ";
         if (i == 12) buf << fSigmaThetaYZ[e] << ", ";
         if (i == 13) buf << fT0[e] << ", ";
         if (i == 14) buf << fSigmaT[e] << ", ";
         values.append(buf.str());
       }
 
       values.erase(values.find_last_of(","));
       values.append(" ] \n");
 
     } // end loop over vector names in list
 
     mf::LogInfo("SingleGen") << values;
 
     return;
   }

void evgen::SingleGen::produce ( art::Event & evt )

overridevirtual

unique_ptr allows ownership to be transferred to the art::Event after the put statement

Implements art::EDProducer.

Definition at line 685 of file SingleGen_module.cc.

References simb::kSingleParticle, MF_LOG_DEBUG, art::Event::put(), Sample(), and simb::MCTruth::SetOrigin().

   {
 
     std::unique_ptr<std::vector<simb::MCTruth>> truthcol(new std::vector<simb::MCTruth>);
 
     simb::MCTruth truth;
     truth.SetOrigin(simb::kSingleParticle);
     Sample(truth);
 
     MF_LOG_DEBUG("SingleGen") << truth;
 
     truthcol->push_back(truth);
 
     evt.put(std::move(truthcol));
 
     return;
   }

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 evgen::SingleGen::Sample ( simb::MCTruth & mct )

private

Definition at line 933 of file SingleGen_module.cc.

References fEngine, fMode, fPDG, fSingleVertex, SampleMany(), and SampleOne().

Referenced by produce().

   {
 
     switch (fMode) {
     case 0: // List generation mode: every event will have one of each
             // particle species in the fPDG array
       if (fSingleVertex) { SampleMany(mct); }
       else {
         for (unsigned int i = 0; i < fPDG.size(); ++i) {
           SampleOne(i, mct);
         } //end loop over particles
       }
       break;
     case 1: // Random selection mode: every event will exactly one particle
             // selected randomly from the fPDG array
     {
       CLHEP::RandFlat flat(fEngine);
 
       unsigned int i = flat.fireInt(fPDG.size());
       SampleOne(i, mct);
     } break;
     default:
       mf::LogWarning("UnrecognizeOption")
         << "SingleGen does not recognize ParticleSelectionMode " << fMode;
       break;
     } // switch on fMode
 
     return;
   }

void evgen::SingleGen::SampleMany ( simb::MCTruth & mct )

private

Definition at line 821 of file SingleGen_module.cc.

References simb::MCTruth::Add(), simb::MCParticle::AddTrajectoryPoint(), fAngleDist, fEngine, fP0, fPDG, fPDist, fPosDist, fSigmaP, fSigmaT, fSigmaThetaXZ, fSigmaThetaYZ, fSigmaX, fSigmaY, fSigmaZ, fT0, fTDist, fTheta0XZ, fTheta0YZ, fX0, fY0, fZ0, hPHist, hThetaXzYzHist, kGAUS, kHIST, part, SelectFromHist(), and x.

Referenced by Sample().

   {
 
     CLHEP::RandFlat flat(fEngine);
     CLHEP::RandGaussQ gauss(fEngine);
 
     // Choose position
     TVector3 x;
     if (fPosDist == kGAUS) {
       x[0] = gauss.fire(fX0[0], fSigmaX[0]);
       ;
       x[1] = gauss.fire(fY0[0], fSigmaY[0]);
       x[2] = gauss.fire(fZ0[0], fSigmaZ[0]);
     }
     else {
       x[0] = fX0[0] + fSigmaX[0] * (2.0 * flat.fire() - 1.0);
       x[1] = fY0[0] + fSigmaY[0] * (2.0 * flat.fire() - 1.0);
       x[2] = fZ0[0] + fSigmaZ[0] * (2.0 * flat.fire() - 1.0);
     }
 
     double t = 0.;
     if (fTDist == kGAUS) { t = gauss.fire(fT0[0], fSigmaT[0]); }
     else {
       t = fT0[0] + fSigmaT[0] * (2.0 * flat.fire() - 1.0);
     }
 
     TLorentzVector pos(x[0], x[1], x[2], t);
 
     // loop through particles and select momenta and angles
     for (unsigned int i(0); i < fPDG.size(); ++i) {
       // Choose momentum
       double p = 0.0;
       double m = 0.0;
       if (fPDist == kGAUS) { p = gauss.fire(fP0[i], fSigmaP[i]); }
       else if (fPDist == kHIST) {
         p = SelectFromHist(*(hPHist[i]));
       }
       else {
         p = fP0[i] + fSigmaP[i] * (2.0 * flat.fire() - 1.0);
       }
 
       static TDatabasePDG pdgt;
       TParticlePDG* pdgp = pdgt.GetParticle(fPDG[i]);
       if (pdgp) m = pdgp->Mass();
 
       // Choose angles
       double thxz = 0;
       double thyz = 0;
 
       double thyzrads = 0;
       double thyzradsplussigma = 0;
       double thyzradsminussigma = 0;
 
       if (fAngleDist == kGAUS) {
         thxz = gauss.fire(fTheta0XZ[i], fSigmaThetaXZ[i]);
         thyz = gauss.fire(fTheta0YZ[i], fSigmaThetaYZ[i]);
       }
       else if (fAngleDist == kHIST) {
         double thetaxz = 0;
         double thetayz = 0;
         SelectFromHist(*(hThetaXzYzHist[i]), thetaxz, thetayz);
         thxz = (180. / M_PI) * thetaxz;
         thyz = (180. / M_PI) * thetayz;
       }
       else {
 
         // Choose angles flat in phase space, which is flat in theta_xz
         // and flat in sin(theta_yz).
 
         thxz = fTheta0XZ[i] + fSigmaThetaXZ[i] * (2.0 * flat.fire() - 1.0);
 
         thyzrads = std::asin(std::sin(
           (M_PI / 180.) *
           (fTheta0YZ
              [i]))); //Taking asin of sin gives value between -Pi/2 and Pi/2 regardless of user input
         thyzradsplussigma =
           TMath::Min((thyzrads + ((M_PI / 180.) * fabs(fSigmaThetaYZ[i]))), M_PI / 2.);
         thyzradsminussigma =
           TMath::Max((thyzrads - ((M_PI / 180.) * fabs(fSigmaThetaYZ[i]))), -M_PI / 2.);
 
         //uncomment line to print angular variation info
         //std::cout << "Central angle: " << (180./M_PI)*thyzrads << " Max angle: " << (180./M_PI)*thyzradsplussigma << " Min angle: " << (180./M_PI)*thyzradsminussigma << std::endl;
 
         double sinthyzmin = std::sin(thyzradsminussigma);
         double sinthyzmax = std::sin(thyzradsplussigma);
         double sinthyz = sinthyzmin + flat.fire() * (sinthyzmax - sinthyzmin);
         thyz = (180. / M_PI) * std::asin(sinthyz);
       }
 
       double thxzrad = thxz * M_PI / 180.0;
       double thyzrad = thyz * M_PI / 180.0;
 
       TLorentzVector pvec(p * std::cos(thyzrad) * std::sin(thxzrad),
                           p * std::sin(thyzrad),
                           p * std::cos(thxzrad) * std::cos(thyzrad),
                           std::sqrt(p * p + m * m));
 
       // set track id to -i as these are all primary particles and have id <= 0
       int trackid = -1 * (i + 1);
       std::string primary("primary");
 
       simb::MCParticle part(trackid, fPDG[i], primary);
       part.AddTrajectoryPoint(pos, pvec);
 
       //std::cout << "Px: " <<  pvec.Px() << " Py: " << pvec.Py() << " Pz: " << pvec.Pz() << std::endl;
       //std::cout << "x: " <<  pos.X() << " y: " << pos.Y() << " z: " << pos.Z() << " time: " << pos.T() << std::endl;
       //std::cout << "YZ Angle: " << (thyzrad * (180./M_PI)) << " XZ Angle: " << (thxzrad * (180./M_PI)) << std::endl;
       mct.Add(part);
     }
   }

void evgen::SingleGen::SampleOne	(	unsigned int	i,
		simb::MCTruth &	mct
	)

private

Definition at line 707 of file SingleGen_module.cc.

References simb::MCTruth::Add(), simb::MCParticle::AddTrajectoryPoint(), fAngleDist, fEngine, fP0, fPDG, fPDist, fPosDist, fSigmaP, fSigmaT, fSigmaThetaXZ, fSigmaThetaYZ, fSigmaX, fSigmaY, fSigmaZ, fT0, fTDist, fTheta0XZ, fTheta0YZ, fX0, fY0, fZ0, hPHist, hThetaXzYzHist, kGAUS, kHIST, part, SelectFromHist(), and x.

Referenced by Sample().

   {
 
     CLHEP::RandFlat flat(fEngine);
     CLHEP::RandGaussQ gauss(fEngine);
 
     // Choose momentum
     double p = 0.0;
     double m = 0.0;
     if (fPDist == kGAUS) { p = gauss.fire(fP0[i], fSigmaP[i]); }
     else if (fPDist == kHIST) {
       p = SelectFromHist(*(hPHist[i]));
     }
     else { // if (fPDist == kUNIF) {
       p = fP0[i] + fSigmaP[i] * (2.0 * flat.fire() - 1.0);
     }
     //    else {std::cout << "do not understand the value of PDist!";}
 
     static TDatabasePDG pdgt;
     TParticlePDG* pdgp = pdgt.GetParticle(fPDG[i]);
     if (pdgp) m = pdgp->Mass();
 
     // Choose position
     TVector3 x;
     if (fPosDist == kGAUS) {
       x[0] = gauss.fire(fX0[i], fSigmaX[i]);
       ;
       x[1] = gauss.fire(fY0[i], fSigmaY[i]);
       x[2] = gauss.fire(fZ0[i], fSigmaZ[i]);
     }
     else {
       x[0] = fX0[i] + fSigmaX[i] * (2.0 * flat.fire() - 1.0);
       x[1] = fY0[i] + fSigmaY[i] * (2.0 * flat.fire() - 1.0);
       x[2] = fZ0[i] + fSigmaZ[i] * (2.0 * flat.fire() - 1.0);
     }
 
     double t = 0.;
     if (fTDist == kGAUS) { t = gauss.fire(fT0[i], fSigmaT[i]); }
     else {
       t = fT0[i] + fSigmaT[i] * (2.0 * flat.fire() - 1.0);
     }
 
     TLorentzVector pos(x[0], x[1], x[2], t);
 
     // Choose angles
     double thxz = 0;
     double thyz = 0;
 
     double thyzrads = 0;
     double thyzradsplussigma = 0;
     double thyzradsminussigma = 0;
 
     if (fAngleDist == kGAUS) {
       thxz = gauss.fire(fTheta0XZ[i], fSigmaThetaXZ[i]);
       thyz = gauss.fire(fTheta0YZ[i], fSigmaThetaYZ[i]);
     }
     else if (fAngleDist == kHIST) { // Select thetaxz and thetayz from histogram
       double thetaxz = 0;
       double thetayz = 0;
       SelectFromHist(*(hThetaXzYzHist[i]), thetaxz, thetayz);
       thxz = (180. / M_PI) * thetaxz;
       thyz = (180. / M_PI) * thetayz;
     }
     else {
 
       // Choose angles flat in phase space, which is flat in theta_xz
       // and flat in sin(theta_yz).
 
       thxz = fTheta0XZ[i] + fSigmaThetaXZ[i] * (2.0 * flat.fire() - 1.0);
 
       thyzrads = std::asin(std::sin(
         (M_PI / 180.) *
         (fTheta0YZ
            [i]))); //Taking asin of sin gives value between -Pi/2 and Pi/2 regardless of user input
       thyzradsplussigma =
         TMath::Min((thyzrads + ((M_PI / 180.) * fabs(fSigmaThetaYZ[i]))), M_PI / 2.);
       thyzradsminussigma =
         TMath::Max((thyzrads - ((M_PI / 180.) * fabs(fSigmaThetaYZ[i]))), -M_PI / 2.);
 
       //uncomment line to print angular variation info
       //std::cout << "Central angle: " << (180./M_PI)*thyzrads << " Max angle: " << (180./M_PI)*thyzradsplussigma << " Min angle: " << (180./M_PI)*thyzradsminussigma << std::endl;
 
       double sinthyzmin = std::sin(thyzradsminussigma);
       double sinthyzmax = std::sin(thyzradsplussigma);
       double sinthyz = sinthyzmin + flat.fire() * (sinthyzmax - sinthyzmin);
       thyz = (180. / M_PI) * std::asin(sinthyz);
     }
 
     double thxzrad = thxz * M_PI / 180.0;
     double thyzrad = thyz * M_PI / 180.0;
 
     TLorentzVector pvec(p * std::cos(thyzrad) * std::sin(thxzrad),
                         p * std::sin(thyzrad),
                         p * std::cos(thxzrad) * std::cos(thyzrad),
                         std::sqrt(p * p + m * m));
 
     // set track id to -i as these are all primary particles and have id <= 0
     int trackid = -1 * (i + 1);
     std::string primary("primary");
 
     simb::MCParticle part(trackid, fPDG[i], primary);
     part.AddTrajectoryPoint(pos, pvec);
 
     //std::cout << "Px: " <<  pvec.Px() << " Py: " << pvec.Py() << " Pz: " << pvec.Pz() << std::endl;
     //std::cout << "x: " <<  pos.X() << " y: " << pos.Y() << " z: " << pos.Z() << " time: " << pos.T() << std::endl;
     //std::cout << "YZ Angle: " << (thyzrad * (180./M_PI)) << " XZ Angle: " << (thxzrad * (180./M_PI)) << std::endl;
 
     mct.Add(part);
   }

double evgen::SingleGen::SelectFromHist ( const TH1 & h )

private

Definition at line 1012 of file SingleGen_module.cc.

References fEngine.

Referenced by SampleMany(), and SampleOne().

   {
     CLHEP::RandFlat flat(fEngine);
 
     double throw_value = h.Integral() * flat.fire();
     double cum_value(0);
     for (int i(0); i < h.GetNbinsX() + 1; ++i) {
       cum_value += h.GetBinContent(i);
       if (throw_value < cum_value) { return flat.fire() * h.GetBinWidth(i) + h.GetBinLowEdge(i); }
     }
     return throw_value; // for some reason we've gone through all bins and failed?
   }

void evgen::SingleGen::SelectFromHist	(	const TH2 &	h,
		double &	x,
		double &	y
	)

private

Definition at line 1025 of file SingleGen_module.cc.

References DEFINE_ART_MODULE, and fEngine.

   {
     CLHEP::RandFlat flat(fEngine);
 
     double throw_value = h.Integral() * flat.fire();
     double cum_value(0);
     for (int i(0); i < h.GetNbinsX() + 1; ++i) {
       for (int j(0); j < h.GetNbinsY() + 1; ++j) {
         cum_value += h.GetBinContent(i, j);
         if (throw_value < cum_value) {
           x = flat.fire() * h.GetXaxis()->GetBinWidth(i) + h.GetXaxis()->GetBinLowEdge(i);
           y = flat.fire() * h.GetYaxis()->GetBinWidth(j) + h.GetYaxis()->GetBinLowEdge(j);
           return;
         }
       }
     }
     return; // for some reason we've gone through all bins and failed?
   }

template<typename OptionList >

auto evgen::SingleGen::selectOption	(	std::string	Option,
		OptionList const &	allowedOptions
	)		-> decltype(auto)

staticprivate

Parses an option string and returns the corresponding option number.

Template Parameters

OptionList type of list of options (e.g. std::map<int, std::string>)

Parameters

Option	the string of the option to be parsed
allowedOptions	list of valid options, as key/name pairs

Returns: the key of the Option string from allowedOptions

Exceptions

std::runtime_error if Option is not in the option list

The option string Option represent a single one among the supported options as defined in allowedOptions. The option string can be either one of the option names (the matching is not case-sensitive) or the number of the option itself.

`OptionList` requirements

OptionList must behave like a sequence with forward iterators. Each element must behave as a pair, whose first element is the option key and the second element is the option name, equivalent to a string in that it must be forward-iterable and its elements can be converted by std::tolower(). The key type has no requirements beside being copiable.

Definition at line 361 of file SingleGen_module.cc.

References util::end().

Referenced by evgen::SingleGen::Config::fromHistogram(), and SingleGen().

   {
     using key_type = typename OptionList::value_type::first_type;
     using tolower_type = int (*)(int);
     auto toLower = [](auto const& S) {
       std::string s;
       s.reserve(S.size());
       std::transform(S.cbegin(), S.cend(), std::back_inserter(s), (tolower_type)&std::tolower);
       return s;
     };
     auto option = toLower(Option);
     for (auto const& candidate : allowedOptions) {
       if (toLower(candidate.second) == option) return candidate.first;
     }
     try {
       std::size_t end;
       key_type num = std::stoi(Option, &end);
       if (allowedOptions.count(num) && (end == Option.length())) return num;
     }
     catch (std::invalid_argument const&) {
     }
     throw std::runtime_error("Option '" + Option + "' not supported.");
   } // SingleGen::selectOption()

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void evgen::SingleGen::setup ( )

private

Performs checks and initialization based on the current configuration.

Definition at line 468 of file SingleGen_module.cc.

References art::errors::Configuration, DistributionNames, fAngleDist, fHistFileName, fP0, fPadOutVectors, fPDG, fPDist, fPHist, fPosDist, fSigmaP, fSigmaT, fSigmaThetaXZ, fSigmaThetaYZ, fSigmaX, fSigmaY, fSigmaZ, fT0, fTDist, fTheta0XZ, fTheta0YZ, fThetaXzYzHist, fX0, fY0, fZ0, hPHist, hThetaXzYzHist, kGAUS, kHIST, kUNIF, art::errors::NotFound, optionName(), PadVector(), printVecs(), and util::to_string().

Referenced by SingleGen().

   {
     // do not put seed in reconfigure because we don't want to reset
     // the seed midstream
     std::vector<std::string> vlist(15);
     vlist[0] = "PDG";
     vlist[1] = "P0";
     vlist[2] = "SigmaP";
     vlist[3] = "X0";
     vlist[4] = "Y0";
     vlist[5] = "Z0";
     vlist[6] = "SigmaX";
     vlist[7] = "SigmaY";
     vlist[8] = "SigmaZ";
     vlist[9] = "Theta0XZ";
     vlist[10] = "Theta0YZ";
     vlist[11] = "SigmaThetaXZ";
     vlist[12] = "SigmaThetaYZ";
     vlist[13] = "T0";
     vlist[14] = "SigmaT";
 
     //    vlist[15] = "PHist";
     //    vlist[16] = "ThetaHist";
     //    vlist[17] = "PhiHist";
 
     // begin tests for multiple particle error possibilities
     std::string list;
     if (fPDist != kHIST) {
       if (!this->PadVector(fP0)) { list.append(vlist[1].append(", \n")); }
       if (!this->PadVector(fSigmaP)) { list.append(vlist[2].append(", \n")); }
     }
     if (!this->PadVector(fX0)) { list.append(vlist[3].append(", \n")); }
     if (!this->PadVector(fY0)) { list.append(vlist[4].append(", \n")); }
     if (!this->PadVector(fZ0)) { list.append(vlist[5].append(", \n")); }
     if (!this->PadVector(fSigmaX)) { list.append(vlist[6].append(", \n")); }
     if (!this->PadVector(fSigmaY)) { list.append(vlist[7].append(", \n")); }
     if (!this->PadVector(fSigmaZ)) { list.append(vlist[8].append(", \n")); }
     if (!this->PadVector(fTheta0XZ)) { list.append(vlist[9].append(", \n")); }
     if (!this->PadVector(fTheta0YZ)) { list.append(vlist[10].append(", \n")); }
     if (!this->PadVector(fSigmaThetaXZ)) { list.append(vlist[11].append(", \n")); }
     if (!this->PadVector(fSigmaThetaYZ)) { list.append(vlist[12].append("  \n")); }
     if (!this->PadVector(fT0)) { list.append(vlist[13].append(", \n")); }
     if (!this->PadVector(fSigmaT)) { list.append(vlist[14].append(", \n")); }
 
     if (list.size() > 0)
       throw cet::exception("SingleGen")
         << "The " << list << "\n vector(s) defined in the fhicl files has/have "
         << "a different size than the PDG vector "
         << "\n and it has (they have) more than one value, "
         << "\n disallowing sensible padding "
         << " and/or you have set fPadOutVectors to false. \n";
 
     if (fPDG.size() > 1 && fPadOutVectors) this->printVecs(vlist);
 
     // If needed, get histograms for momentum and angle distributions
     TFile* histFile = nullptr;
     if (!fHistFileName.empty()) {
       if (fHistFileName[0] == '/') {
         // We have an absolute path, use given name exactly.
         if (cet::file_exists(fHistFileName)) {
           histFile = new TFile(fHistFileName.c_str());
           if (!histFile || histFile->IsZombie() || !histFile->IsOpen()) {
             delete histFile;
             histFile = nullptr;
             throw art::Exception(art::errors::NotFound)
               << "Cannot open ROOT file specified in parameter HistogramFile: \"" << fHistFileName
               << "\"";
           }
         }
         else {
           throw art::Exception(art::errors::NotFound)
             << "ROOT file specified in parameter HistogramFile: \"" << fHistFileName
             << "\" does not exist!";
         }
       }
       else {
         // We have a relative path, search starting from current directory.
         std::string relative_filename{"./"};
         relative_filename += fHistFileName;
         if (cet::file_exists(relative_filename)) {
           histFile = new TFile(relative_filename.c_str());
           if (!histFile || histFile->IsZombie() || !histFile->IsOpen()) {
             delete histFile;
             histFile = nullptr;
             throw art::Exception(art::errors::NotFound)
               << "Cannot open ROOT file found using relative path and originally specified in "
                  "parameter HistogramFile: \""
               << relative_filename << '"';
           }
         }
         else {
           cet::search_path sp{"FW_SEARCH_PATH"};
           std::string found_filename;
           auto found = sp.find_file(fHistFileName, found_filename);
           if (!found) {
             throw art::Exception(art::errors::NotFound)
               << "Cannot find ROOT file in current directory nor on FW_SEARCH_PATH specified in "
                  "parameter HistogramFile: \""
               << fHistFileName << '"';
           }
           histFile = new TFile(found_filename.c_str());
           if (!histFile || histFile->IsZombie() || !histFile->IsOpen()) {
             delete histFile;
             histFile = nullptr;
             throw art::Exception(art::errors::NotFound)
               << "Cannot open ROOT file found on FW_SEARCH_PATH and originally specified in "
                  "parameter HistogramFile: \""
               << found_filename << '"';
           }
         }
       }
     }
 
     //
     // deal with position distribution
     //
     switch (fPosDist) {
     case kGAUS:
     case kUNIF: break; // supported, no further action needed
     default:
       throw art::Exception(art::errors::Configuration)
         << "Position distribution of type '" << optionName(fPosDist, DistributionNames) << "' ("
         << std::to_string(fPosDist) << ") is not supported.";
     } // switch(fPosDist)
 
     //
     // deal with time distribution
     //
     switch (fTDist) {
     case kGAUS:
     case kUNIF: break; // supported, no further action needed
     default:
       throw art::Exception(art::errors::Configuration)
         << "Time distribution of type '" << optionName(fTDist, DistributionNames) << "' ("
         << std::to_string(fTDist) << ") is not supported.";
     } // switch(fTDist)
 
     //
     // deal with momentum distribution
     //
     switch (fPDist) {
     case kHIST:
       if (fPHist.size() != fPDG.size()) {
         throw art::Exception(art::errors::Configuration)
           << fPHist.size() << " momentum histograms to describe " << fPDG.size()
           << " particle types...";
       }
       hPHist.reserve(fPHist.size());
       for (auto const& histName : fPHist) {
         TH1* pHist = dynamic_cast<TH1*>(histFile->Get(histName.c_str()));
         if (!pHist) {
           throw art::Exception(art::errors::NotFound)
             << "Failed to read momentum histogram '" << histName << "' from '"
             << histFile->GetPath() << "\'";
         }
         pHist->SetDirectory(nullptr); // make it independent of the input file
         hPHist.emplace_back(pHist);
       } // for
       break;
     default: // supported, no further action needed
       break;
     } // switch(fPDist)
 
     switch (fAngleDist) {
     case kHIST:
       if (fThetaXzYzHist.size() != fPDG.size()) {
         throw art::Exception(art::errors::Configuration)
           << fThetaXzYzHist.size() << " direction histograms to describe " << fPDG.size()
           << " particle types...";
       }
       hThetaXzYzHist.reserve(fThetaXzYzHist.size());
       for (auto const& histName : fThetaXzYzHist) {
         TH2* pHist = dynamic_cast<TH2*>(histFile->Get(histName.c_str()));
         if (!pHist) {
           throw art::Exception(art::errors::NotFound)
             << "Failed to read direction histogram '" << histName << "' from '"
             << histFile->GetPath() << "\'";
         }
         pHist->SetDirectory(nullptr); // make it independent of the input file
         hThetaXzYzHist.emplace_back(pHist);
       }      // for
     default: // supported, no further action needed
       break;
     } // switch(fAngleDist)
 
     delete histFile;
   }

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

const std::map< int, std::string > evgen::SingleGen::DistributionNames

staticprivate

Initial value:

=

SingleGen::makeDistributionNames()

Names of all distribution modes.

Definition at line 198 of file SingleGen_module.cc.

Referenced by evgen::SingleGen::Config::fromHistogram(), makeDistributionNames(), setup(), and SingleGen().

int evgen::SingleGen::fAngleDist

private

How to distribute angles (gaus, uniform)

Definition at line 250 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), setup(), and SingleGen().

CLHEP::HepRandomEngine& evgen::SingleGen::fEngine

private

actual TH2 for angle distributions - Xz on x axis .

art-managed random-number engine

Definition at line 262 of file SingleGen_module.cc.

Referenced by Sample(), SampleMany(), SampleOne(), SelectFromHist(), and SingleGen().

std::string evgen::SingleGen::fHistFileName

private

Filename containing histogram of momenta.

Definition at line 251 of file SingleGen_module.cc.

Referenced by setup(), and SingleGen().

int evgen::SingleGen::fMode

private

Particle Selection Mode 0–generate a list of all particles, 1–generate a single particle selected randomly from the list

Definition at line 224 of file SingleGen_module.cc.

Referenced by Sample(), and SingleGen().

std::vector<double> evgen::SingleGen::fP0

private

Central momentum (GeV/c) to generate.

Definition at line 232 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

bool evgen::SingleGen::fPadOutVectors

private

Select to pad out configuration vectors if they are not of of the same length as PDG false: don't pad out - all values need to specified true: pad out - default values assumed and printed out

Definition at line 227 of file SingleGen_module.cc.

Referenced by PadVector(), setup(), and SingleGen().

std::vector<int> evgen::SingleGen::fPDG

private

PDG code of particles to generate.

Definition at line 231 of file SingleGen_module.cc.

Referenced by PadVector(), printVecs(), Sample(), SampleMany(), SampleOne(), setup(), and SingleGen().

int evgen::SingleGen::fPDist

private

How to distribute momenta (gaus or uniform)

Definition at line 234 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<std::string> evgen::SingleGen::fPHist

private

name of histogram of momenta

Definition at line 252 of file SingleGen_module.cc.

Referenced by setup(), and SingleGen().

int evgen::SingleGen::fPosDist

private

How to distribute xyz (gaus, or uniform)

Definition at line 243 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaP

private

Variation in momenta (GeV/c)

Definition at line 233 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaT

private

Variation in t position (s)

Definition at line 242 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaThetaXZ

private

Variation in angle in XZ plane.

Definition at line 248 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaThetaYZ

private

Variation in angle in YZ plane.

Definition at line 249 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaX

private

Variation in x position (cm)

Definition at line 239 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaY

private

Variation in y position (cm)

Definition at line 240 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fSigmaZ

private

Variation in z position (cm)

Definition at line 241 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

bool evgen::SingleGen::fSingleVertex

private

if true - all particles produced at the same location

Definition at line 245 of file SingleGen_module.cc.

Referenced by Sample(), and SingleGen().

std::vector<double> evgen::SingleGen::fT0

private

Central t position (s) in world coordinates.

Definition at line 238 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

int evgen::SingleGen::fTDist

private

How to distribute t (gaus, or uniform)

Definition at line 244 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fTheta0XZ

private

Angle in XZ plane (degrees)

Definition at line 246 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fTheta0YZ

private

Angle in YZ plane (degrees)

Definition at line 247 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<std::string> evgen::SingleGen::fThetaXzYzHist

private

name of histogram for thetaxz/thetayz distribution

Definition at line 253 of file SingleGen_module.cc.

Referenced by setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fX0

private

Central x position (cm) in world coordinates.

Definition at line 235 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fY0

private

Central y position (cm) in world coordinates.

Definition at line 236 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<double> evgen::SingleGen::fZ0

private

Central z position (cm) in world coordinates.

Definition at line 237 of file SingleGen_module.cc.

Referenced by printVecs(), SampleMany(), SampleOne(), setup(), and SingleGen().

std::vector<std::unique_ptr<TH1> > evgen::SingleGen::hPHist

private

Definition at line 255 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), and setup().

std::vector<std::unique_ptr<TH2> > evgen::SingleGen::hThetaXzYzHist

private

actual TH1 for momentum distributions

Definition at line 257 of file SingleGen_module.cc.

Referenced by SampleMany(), SampleOne(), and setup().

constexpr int evgen::SingleGen::kGAUS = 1

staticprivate

Gaussian distribution.

Definition at line 220 of file SingleGen_module.cc.

Referenced by makeDistributionNames(), SampleMany(), SampleOne(), and setup().

constexpr int evgen::SingleGen::kHIST = 2

staticprivate

Distribution from histograms.

Definition at line 221 of file SingleGen_module.cc.

Referenced by evgen::SingleGen::Config::fromHistogram(), makeDistributionNames(), SampleMany(), SampleOne(), and setup().

constexpr int evgen::SingleGen::kSelectAllParts = 0

staticprivate

One particle per entry is generated.

Definition at line 211 of file SingleGen_module.cc.

Referenced by makeParticleSelectionModeNames().

constexpr int evgen::SingleGen::kSelectOneRandPart

staticprivate

Initial value:

=

1

One particle is generated, extracted from the provided options.

Definition at line 212 of file SingleGen_module.cc.

Referenced by makeParticleSelectionModeNames().

constexpr int evgen::SingleGen::kUNIF = 0

staticprivate

Uniform distribution.

Definition at line 219 of file SingleGen_module.cc.

Referenced by makeDistributionNames(), and setup().

const std::map< int, std::string > evgen::SingleGen::ParticleSelectionModeNames

staticprivate

Initial value:

=

SingleGen::makeParticleSelectionModeNames()

Names of all particle selection modes.

Definition at line 196 of file SingleGen_module.cc.

Referenced by makeDistributionNames(), and SingleGen().

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

larsim/v09_43_00/source/larsim/EventGenerator/SingleGen_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

OptionList requirements

Member Data Documentation

`OptionList` requirements