Inheritance diagram for evgen::NeutronOsc:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

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

	NeutronOsc (NeutronOsc const &)=delete

	NeutronOsc (NeutronOsc &&)=delete

NeutronOsc &	operator= (NeutronOsc const &)=delete

NeutronOsc &	operator= (NeutronOsc &&)=delete

void	produce (art::Event &e) override

void	beginJob () override

void	beginRun (art::Run &run) override

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
int	SelectAnnihilationMode (int pdg_code)

Private Attributes
const genie::EventRecordVisitorI *	mcgen

genie::NeutronOscMode_t	gOptDecayMode = genie::kNONull

Detailed Description

Definition at line 73 of file NeutronOsc_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

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::NeutronOsc::NeutronOsc ( fhicl::ParameterSet const & p )

explicit

Definition at line 103 of file NeutronOsc_module.cc.

References art::EngineCreator::createEngine(), fhicl::ParameterSet::get(), gOptDecayMode, mcgen, and seed.

 {
   genie::PDGLibrary::Instance(); //Ensure Messenger is started first in GENIE.
 
   string sname   = "genie::EventGenerator";
   string sconfig = "NeutronOsc";
   genie::AlgFactory * algf = genie::AlgFactory::Instance();
   mcgen =
     dynamic_cast<const genie::EventRecordVisitorI *> (algf->GetAlgorithm(sname,sconfig));
   if(!mcgen) {
     throw cet::exception("NeutronOsc") << "Couldn't instantiate the neutron-antineutron oscillation generator"; 
   }
   int fDecayMode = p.get<int>("DecayMode");
   gOptDecayMode = (genie::NeutronOscMode_t) fDecayMode;
 
   produces< std::vector<simb::MCTruth> >();
   produces< sumdata::RunData, art::InRun >();
   
   // create a default random engine; obtain the random seed from NuRandomService,
   // unless overridden in configuration with key "Seed"
   art::ServiceHandle<rndm::NuRandomService>()
     ->createEngine(*this, p, "Seed");
 
   unsigned int seed = art::ServiceHandle<rndm::NuRandomService>()->getSeed();
   genie::utils::app_init::RandGen(seed);
 }

evgen::NeutronOsc::NeutronOsc ( NeutronOsc const & )

delete

evgen::NeutronOsc::NeutronOsc ( NeutronOsc && )

delete

Member Function Documentation

void evgen::NeutronOsc::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 232 of file NeutronOsc_module.cc.

 {
   // Implementation of optional member function here.
 }

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

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 219 of file NeutronOsc_module.cc.

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

 {
     
   // 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(), NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::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();
   }

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.

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

NeutronOsc& evgen::NeutronOsc::operator= ( NeutronOsc const & )

delete

NeutronOsc& evgen::NeutronOsc::operator= ( NeutronOsc && )

delete

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

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

overridevirtual

Implements art::EDProducer.

Definition at line 130 of file NeutronOsc_module.cc.

References simb::MCTruth::Add(), art::RandomNumberGenerator::getEngine(), simb::kUnknown, LOG_DEBUG, geo::BoxBoundedGeo::MaxX(), geo::BoxBoundedGeo::MaxY(), geo::BoxBoundedGeo::MaxZ(), mcgen, geo::BoxBoundedGeo::MinX(), geo::BoxBoundedGeo::MinY(), geo::BoxBoundedGeo::MinZ(), geo::GeometryCore::NTPC(), part, art::Event::put(), art::EngineCreator::rng(), SelectAnnihilationMode(), simb::MCTruth::SetOrigin(), target, and geo::GeometryCore::TPC().

 {
   // Implementation of required member function here.
   genie::EventRecord * event = new genie::EventRecord;
   int target = 1000180400;  //Only use argon target
   int decay  = SelectAnnihilationMode(target);
   genie::Interaction * interaction = genie::Interaction::NOsc(target,decay);
   event->AttachSummary(interaction);
   
   // Simulate decay     
   mcgen->ProcessEventRecord(event);
 
 //  genie::Interaction *inter = event->Summary();
 //  const genie::InitialState &initState = inter->InitState();
 //  std::cout<<"initState = "<<initState.AsString()<<std::endl;
 //  const genie::ProcessInfo &procInfo = inter->ProcInfo();
 //  std::cout<<"procInfo = "<<procInfo.AsString()<<std::endl;
   LOG_DEBUG("NeutronOsc")
     << "Generated event: " << *event;
 
   std::unique_ptr< std::vector<simb::MCTruth> > truthcol(new std::vector<simb::MCTruth>);
   simb::MCTruth truth;
   
   art::ServiceHandle<geo::Geometry> geo;
   art::ServiceHandle<art::RandomNumberGenerator> rng;
   CLHEP::HepRandomEngine &engine = rng->getEngine();
   CLHEP::RandFlat flat(engine);
 
   // Find boundary of active volume
   double minx = 1e9;
   double maxx = -1e9;
   double miny = 1e9;
   double maxy = -1e9;
   double minz = 1e9;
   double maxz = -1e9;
   for (size_t i = 0; i<geo->NTPC(); ++i){
     const geo::TPCGeo &tpc = geo->TPC(i);
     if (minx>tpc.MinX()) minx = tpc.MinX();
     if (maxx<tpc.MaxX()) maxx = tpc.MaxX();
     if (miny>tpc.MinY()) miny = tpc.MinY();
     if (maxy<tpc.MaxY()) maxy = tpc.MaxY();
     if (minz>tpc.MinZ()) minz = tpc.MinZ();
     if (maxz<tpc.MaxZ()) maxz = tpc.MaxZ();
   }
 
   // Assign vertice position
   double X0 = flat.fire( minx, maxx );
   double Y0 = flat.fire( miny, maxy );
   double Z0 = flat.fire( minz, maxz );
 
   TIter partitr(event);
   genie::GHepParticle *part = 0;
   // GHepParticles return units of GeV/c for p.  the V_i are all in fermis
   // and are relative to the center of the struck nucleus.
   // add the vertex X/Y/Z to the V_i for status codes 0 and 1
   int trackid = 0;
   std::string primary("primary");
   
   while( (part = dynamic_cast<genie::GHepParticle *>(partitr.Next())) ){
     
     simb::MCParticle tpart(trackid, 
                            part->Pdg(),
                            primary,
                            part->FirstMother(),
                            part->Mass(), 
                            part->Status());
     
     TLorentzVector pos(X0, Y0, Z0, 0);
     TLorentzVector mom(part->Px(), part->Py(), part->Pz(), part->E());
     tpart.AddTrajectoryPoint(pos,mom);
     if(part->PolzIsSet()) {
       TVector3 polz;
       part->GetPolarization(polz);
       tpart.SetPolarization(polz);
     }
     truth.Add(tpart);
     
     ++trackid;        
   }// end loop to convert GHepParticles to MCParticles
   truth.SetOrigin(simb::kUnknown);
   truthcol->push_back(truth);
   //FillHistograms(truth);  
   e.put(std::move(truthcol));
 
   delete event;
   return;
 
 }

int evgen::NeutronOsc::SelectAnnihilationMode ( int pdg_code )

private

Definition at line 237 of file NeutronOsc_module.cc.

References DEFINE_ART_MODULE, art::RandomNumberGenerator::getEngine(), gOptDecayMode, art::EngineCreator::rng(), and util::flags::to_string().

Referenced by produce().

 {
   // if the mode is set to 'random' (the default), pick one at random!
   if ((int)gOptDecayMode == 0) {
     int mode;
 
     std::string pdg_string = std::to_string(static_cast<long long>(pdg_code));
     if (pdg_string.size() != 10) {
       std::cout << "Expecting PDG code to be a 10-digit integer; instead, it's the following: " << pdg_string << std::endl;
       exit(1);
     }
 
     // count number of protons & neutrons
     int n_nucleons = std::stoi(pdg_string.substr(6,3)) - 1;
     int n_protons  = std::stoi(pdg_string.substr(3,3));
 
     // factor proton / neutron ratio into branching ratios
     double proton_frac  = ((double)n_protons) / ((double)n_nucleons);
     double neutron_frac = 1 - proton_frac;
 
     // set branching ratios, taken from bubble chamber data
     const int n_modes = 16;
     double br [n_modes] = { 0.010, 0.080, 0.100, 0.220,
                             0.360, 0.160, 0.070, 0.020,
                             0.015, 0.065, 0.110, 0.280,
                             0.070, 0.240, 0.100, 0.100 };
 
     for (int i = 0; i < n_modes; i++) {
       if (i < 7)
         br[i] *= proton_frac;
       else
         br[i] *= neutron_frac;
     }
 
     // randomly generate a number between 1 and 0
     art::ServiceHandle<art::RandomNumberGenerator> rng;
     CLHEP::HepRandomEngine &engine = rng->getEngine();
     CLHEP::RandFlat flat(engine);
     double p = flat.fire();
 
     // loop through all modes, figure out which one our random number corresponds to
     double threshold = 0;
     for (int i = 0; i < n_modes; i++) {
       threshold += br[i];
       if (p < threshold) {
         // once we've found our mode, return it!
         mode = i + 1;
         return mode;
       }
     }
 
     // error message, in case the random number selection fails
     std::cout << "Random selection of final state failed!" << std::endl;
     exit(1);
   }
 
   // if specific annihilation mode specified, just use that
   else {
     int mode = (int) gOptDecayMode;
     return mode;
   }
 }

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

genie::NeutronOscMode_t evgen::NeutronOsc::gOptDecayMode = genie::kNONull

private

Definition at line 99 of file NeutronOsc_module.cc.

Referenced by NeutronOsc(), and SelectAnnihilationMode().

const genie::EventRecordVisitorI* evgen::NeutronOsc::mcgen

private

Definition at line 98 of file NeutronOsc_module.cc.

Referenced by NeutronOsc(), and produce().

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

/cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/EventGenerator/GENIE/NeutronOsc_module.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation