evgen::SingleGen Class Reference

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
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	SingleGen (Parameters const &config)
void	produce (art::Event &evt)
void	beginRun (art::Run &run)
template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const
template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
bool	modifiesEvent () const
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)
base_engine_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

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	setup ()
	Performs checks and initialization based on the current configuration. More...

Static Private Member Functions
static std::map< int, std::string >	makeParticleSelectionModeNames ()
	actual TH2 for angle distributions - Xz on x axis . 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...

Static Private Attributes
static const std::map< int, std::string >	ParticleSelectionModeNames = SingleGen::makeParticleSelectionModeNames()
	Names of all particle selection modes. More...
static const std::map< int, std::string >	DistributionNames = SingleGen::makeDistributionNames()
	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 = 1
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 72 of file SingleGen_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

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

Definition at line 234 of file SingleGen_module.cc.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

evgen::SingleGen::SingleGen ( Parameters const &  config )

explicit

Definition at line 475 of file SingleGen_module.cc.

References art::EngineCreator::createEngine(), seed, and setup().

    : 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))
    , fTheta0XZ     (config().Theta0XZ())
    , fTheta0YZ     (config().Theta0YZ())
    , fSigmaThetaXZ (config().SigmaThetaXZ())
    , fSigmaThetaYZ (config().SigmaThetaYZ())
    , fAngleDist    (selectOption(config().AngleDist(), DistributionNames))
    , fHistFileName (config().HistogramFile())
    , fPHist        (config().PHist())
//    , fThetaPhiHist (config().ThetaPhiHist())
    , fThetaXzYzHist(config().ThetaXzYzHist())
  {
    setup();
    
    // create a default random engine; obtain the random seed from NuRandomService,
    // unless overridden in configuration with key "Seed"
    art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this);
    rndm::NuRandomService::seed_t seed;
    if (config().Seed(seed)) {
      art::ServiceHandle<art::RandomNumberGenerator>()->getEngine().setSeed
        (seed, 0 /* dummy? */);
    }

    produces< std::vector<simb::MCTruth> >();
    //    produces< sumdata::RunData, art::InRun >();

  }

Member Function Documentation

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

virtual

Reimplemented from art::EDProducer.

Definition at line 722 of file SingleGen_module.cc.

  {

    // grab the geometry object to see what geometry we are using
    //    art::ServiceHandle<geo::Geometry> geo;
    // std::unique_ptr<sumdata::RunData> runcol(new sumdata::RunData(geo->DetectorName()));

    //run.put(std::move(runcol));

    return;
  }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return rng()->createEngine(placeholder_schedule_id(), seed);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make  )

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make, label_t const &  engine_label  )

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
}

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

  {
    return current_context_.get();
  }

EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset, char const  key[] = "seed", seed_t const  implicit_seed = -1  )

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

{
  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
}

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const &  instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

  {
    return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                               instanceName);
  }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription, std::string const &  instanceName  ) const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

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

staticprivate

Returns a vector with the name of distribution keywords.

Definition at line 395 of file SingleGen_module.cc.

                                                          {
    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

actual TH2 for angle distributions - Xz on x axis .

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

Definition at line 388 of file SingleGen_module.cc.

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

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

    {
      return true;
    }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

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 459 of file SingleGen_module.cc.

Referenced by 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 695 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;
  }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

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 438 of file SingleGen_module.cc.

References n, and util::flags::to_string().

    {
    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 371 of file SingleGen_module.cc.

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

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

private

Definition at line 1021 of file SingleGen_module.cc.

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

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 )

virtual

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

Implements art::EDProducer.

Definition at line 735 of file SingleGen_module.cc.

References simb::kSingleParticle, 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);

    LOG_DEBUG("SingleGen") << truth;

    truthcol->push_back(truth);

    evt.put(std::move(truthcol));

    return;
  }

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

private

Definition at line 985 of file SingleGen_module.cc.

References fMode, fPDG, fSingleVertex, art::RandomNumberGenerator::getEngine(), art::EngineCreator::rng(), 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
      {
        art::ServiceHandle<art::RandomNumberGenerator> rng;
        CLHEP::HepRandomEngine &engine = rng->getEngine();
        CLHEP::RandFlat flat(engine);

        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 871 of file SingleGen_module.cc.

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

Referenced by Sample().

                                            {

    // get the random number generator service and make some CLHEP generators
    art::ServiceHandle<art::RandomNumberGenerator> rng;
    CLHEP::HepRandomEngine &engine = rng->getEngine();
    CLHEP::RandFlat   flat(engine);
    CLHEP::RandGaussQ gauss(engine);

    // 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 757 of file SingleGen_module.cc.

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

Referenced by Sample().

                                                           {

    // get the random number generator service and make some CLHEP generators
    art::ServiceHandle<art::RandomNumberGenerator> rng;
    CLHEP::HepRandomEngine &engine = rng->getEngine();
    CLHEP::RandFlat   flat(engine);
    CLHEP::RandGaussQ gauss(engine);

    // 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 1070 of file SingleGen_module.cc.

References art::RandomNumberGenerator::getEngine(), and art::EngineCreator::rng().

Referenced by SampleMany(), and SampleOne().

  {
    art::ServiceHandle<art::RandomNumberGenerator> rng;
    CLHEP::HepRandomEngine &engine = rng->getEngine();
    CLHEP::RandFlat   flat(engine);
    
    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 1087 of file SingleGen_module.cc.

References DEFINE_ART_MODULE, art::RandomNumberGenerator::getEngine(), and art::EngineCreator::rng().

  {
    art::ServiceHandle<art::RandomNumberGenerator> rng;
    CLHEP::HepRandomEngine &engine = rng->getEngine();
    CLHEP::RandFlat   flat(engine);
    
    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 411 of file SingleGen_module.cc.

References evd::details::end(), and s.

  {
    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 evgen::SingleGen::setup ( )

private

Performs checks and initialization based on the current configuration.

Definition at line 520 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::flags::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::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Member Data Documentation

const std::map< int, std::string > evgen::SingleGen::DistributionNames = SingleGen::makeDistributionNames()

staticprivate

Names of all distribution modes.

Definition at line 248 of file SingleGen_module.cc.

Referenced by setup().

int evgen::SingleGen::fAngleDist

private

How to distribute angles (gaus, uniform)

Definition at line 300 of file SingleGen_module.cc.

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

std::string evgen::SingleGen::fHistFileName

private

Filename containing histogram of momenta.

Definition at line 301 of file SingleGen_module.cc.

Referenced by setup().

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 274 of file SingleGen_module.cc.

Referenced by Sample().

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

private

Central momentum (GeV/c) to generate.

Definition at line 282 of file SingleGen_module.cc.

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

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 277 of file SingleGen_module.cc.

Referenced by PadVector(), and setup().

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

private

PDG code of particles to generate.

Definition at line 281 of file SingleGen_module.cc.

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

int evgen::SingleGen::fPDist

private

How to distribute momenta (gaus or uniform)

Definition at line 284 of file SingleGen_module.cc.

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

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

private

name of histogram of momenta

Definition at line 302 of file SingleGen_module.cc.

Referenced by setup().

int evgen::SingleGen::fPosDist

private

How to distribute xyz (gaus, or uniform)

Definition at line 293 of file SingleGen_module.cc.

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

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

private

Variation in momenta (GeV/c)

Definition at line 283 of file SingleGen_module.cc.

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

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

private

Variation in t position (s)

Definition at line 292 of file SingleGen_module.cc.

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

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

private

Variation in angle in XZ plane.

Definition at line 298 of file SingleGen_module.cc.

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

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

private

Variation in angle in YZ plane.

Definition at line 299 of file SingleGen_module.cc.

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

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

private

Variation in x position (cm)

Definition at line 289 of file SingleGen_module.cc.

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

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

private

Variation in y position (cm)

Definition at line 290 of file SingleGen_module.cc.

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

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

private

Variation in z position (cm)

Definition at line 291 of file SingleGen_module.cc.

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

bool evgen::SingleGen::fSingleVertex

private

if true - all particles produced at the same location

Definition at line 295 of file SingleGen_module.cc.

Referenced by Sample().

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

private

Central t position (s) in world coordinates.

Definition at line 288 of file SingleGen_module.cc.

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

int evgen::SingleGen::fTDist

private

How to distribute t (gaus, or uniform)

Definition at line 294 of file SingleGen_module.cc.

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

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

private

Angle in XZ plane (degrees)

Definition at line 296 of file SingleGen_module.cc.

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

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

private

Angle in YZ plane (degrees)

Definition at line 297 of file SingleGen_module.cc.

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

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

private

name of histogram for thetaxz/thetayz distribution

Definition at line 304 of file SingleGen_module.cc.

Referenced by setup().

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

private

Central x position (cm) in world coordinates.

Definition at line 285 of file SingleGen_module.cc.

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

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

private

Central y position (cm) in world coordinates.

Definition at line 286 of file SingleGen_module.cc.

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

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

private

Central z position (cm) in world coordinates.

Definition at line 287 of file SingleGen_module.cc.

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

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

private

Definition at line 306 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 308 of file SingleGen_module.cc.

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

constexpr int evgen::SingleGen::kGAUS = 1

staticprivate

Gaussian distribution.

Definition at line 270 of file SingleGen_module.cc.

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

constexpr int evgen::SingleGen::kHIST = 2

staticprivate

Distribution from histograms.

Definition at line 271 of file SingleGen_module.cc.

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

constexpr int evgen::SingleGen::kSelectAllParts = 0

staticprivate

One particle per entry is generated.

Definition at line 262 of file SingleGen_module.cc.

constexpr int evgen::SingleGen::kSelectOneRandPart = 1

staticprivate

One particle is generated, extracted from the provided options.

Definition at line 263 of file SingleGen_module.cc.

constexpr int evgen::SingleGen::kUNIF = 0

staticprivate

Uniform distribution.

Definition at line 269 of file SingleGen_module.cc.

Referenced by setup().

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

staticprivate

Names of all particle selection modes.

Definition at line 246 of file SingleGen_module.cc.

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/EventGenerator/SingleGen_module.cc