A module to check the results from the Monte Carlo generator. More...

Inheritance diagram for evgen::GENIEGen:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

Public Member Functions
	GENIEGen (fhicl::ParameterSet const &pset)

virtual	~GENIEGen ()

void	produce (art::Event &evt)

void	beginJob ()

void	beginRun (art::Run &run)

void	beginSubRun (art::SubRun &sr)

void	endSubRun (art::SubRun &sr)

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
std::string	ParticleStatus (int StatusCode)

std::string	ReactionChannel (int ccnc, int mode)

void	FillHistograms (simb::MCTruth mc)

Private Attributes
evgb::GENIEHelper *	fGENIEHelp
	GENIEHelper object. More...

bool	fDefinedVtxHistRange

std::vector< double >	fVtxPosHistRange
	use defined hist range; it is useful to have for asymmetric ranges like in DP FD. More...

int	fPassEmptySpills
	whether or not to kill evnets with no interactions More...

TStopwatch	fStopwatch

double	fGlobalTimeOffset
	keep track of how long it takes to run the job More...

double	fRandomTimeOffset
	The start of a simulated "beam gate". More...

::sim::BeamType_t	fBeamType
	The width of a simulated "beam gate". More...

double	fPrevTotPOT
	The type of beam. More...

double	fPrevTotGoodPOT
	Total good POT from subruns previous to current subrun. More...

TH1F *	fGenerated [6]
	Spectra as generated. More...

TH1F *	fVertexX
	vertex location of generated events in x More...

TH1F *	fVertexY
	vertex location of generated events in y More...

TH1F *	fVertexZ
	vertex location of generated events in z More...

TH2F *	fVertexXY
	vertex location in xy More...

TH2F *	fVertexXZ
	vertex location in xz More...

TH2F *	fVertexYZ
	vertex location in yz More...

TH1F *	fDCosX
	direction cosine in x More...

TH1F *	fDCosY
	direction cosine in y More...

TH1F *	fDCosZ
	direction cosine in z More...

TH1F *	fMuMomentum
	momentum of outgoing muons More...

TH1F *	fMuDCosX
	direction cosine of outgoing mu in x More...

TH1F *	fMuDCosY
	direction cosine of outgoing mu in y More...

TH1F *	fMuDCosZ
	direction cosine of outgoing mu in z More...

TH1F *	fEMomentum
	momentum of outgoing electrons More...

TH1F *	fEDCosX
	direction cosine of outgoing e in x More...

TH1F *	fEDCosY
	direction cosine of outgoing e in y More...

TH1F *	fEDCosZ
	direction cosine of outgoing e in z More...

TH1F *	fCCMode
	CC interaction mode. More...

TH1F *	fNCMode
	CC interaction mode. More...

TH1F *	fDeltaE
	difference in neutrino energy from MCTruth::Enu() vs TParticle More...

TH1F *	fECons
	histogram to determine if energy is conserved in the event More...

Detailed Description

A module to check the results from the Monte Carlo generator.

Note on random number generator

GENIE uses a TRandom generator for its purposes. Since art's RandomNumberGenerator service only provides CLHEP::HepRandomEngine, the standard LArSoft/art mechanism for handling the random stream can't be used. GENIEHelper, interface to GENIE provided by nutools, creates a TRandom that GENIE can use. It initializes it with a random seed read from RandomSeed configuration parameter. This and all the other parameters are inherited from the art module (that is, GENIEGen) configuration. LArSoft meddles with this mechanism to provide support for the standard "Seed" parameter and NuRandomService service.

Configuration parameters

RandomSeed (integer, optional): if specified, this value is used as seed for GENIE random number generator engine
Seed (unsigned integer, optional): if specified, this value is used as seed for GENIE random number generator engine; if RandomSeed is also specified, this value is ignored (but in the future this could turn into a configuration error)

As custom, if the random seed is not provided by the configuration, one is fetched from NuRandomService (if available), with the behaviour in lar::util::FetchRandomSeed().

Definition at line 90 of file GENIEGen_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::GENIEGen::GENIEGen ( fhicl::ParameterSet const & pset )

explicit

Definition at line 158 of file GENIEGen_module.cc.

References fBeamType, fGENIEHelp, fStopwatch, fhicl::ParameterSet::get(), fhicl::ParameterSet::get_if_present(), sim::kBNB, sim::kNuMI, geo::kUnknown, fhicl::ParameterSet::put(), geo::GeometryCore::ROOTFile(), geo::GeometryCore::ROOTGeoManager(), seed, and geo::GeometryCore::TotalMass().

     : fGENIEHelp(0)
     , fDefinedVtxHistRange (pset.get< bool >("DefinedVtxHistRange"))
     , fVtxPosHistRange (pset.get< std::vector<double> >("VtxPosHistRange"))
     , fPassEmptySpills (pset.get< bool   >("PassEmptySpills"))
     , fGlobalTimeOffset(pset.get< double >("GlobalTimeOffset",0))
     , fRandomTimeOffset(pset.get< double >("RandomTimeOffset",1600.)) // BNB default value
     , fBeamType(::sim::kBNB)
   {  
     fStopwatch.Start();
 
     produces< std::vector<simb::MCTruth> >();
     produces< std::vector<simb::MCFlux>  >();
     produces< std::vector<simb::GTruth>  >();
     produces< sumdata::RunData, art::InRun >();
     produces< sumdata::POTSummary, art::InSubRun >();
     produces< art::Assns<simb::MCTruth, simb::MCFlux> >();
     produces< art::Assns<simb::MCTruth, simb::GTruth> >();
     produces< std::vector<sim::BeamGateInfo> >();
 
     std::string beam_type_name = pset.get<std::string>("BeamName");
 
     if(beam_type_name == "numi") 
 
       fBeamType = ::sim::kNuMI;
 
     else if(beam_type_name == "booster") 
 
       fBeamType = ::sim::kBNB;
 
     else
 
       fBeamType = ::sim::kUnknown;
 
     art::ServiceHandle<geo::Geometry> geo;
 
     signed int temp_seed; // the seed read by GENIEHelper is a signed integer...
     fhicl::ParameterSet GENIEconfig(pset);
     if (!GENIEconfig.get_if_present("RandomSeed", temp_seed)) { // TODO use has_key() when it becomes available
       // no RandomSeed specified; check for the LArSoft-style "Seed" instead:
       // obtain the random seed from a service,
       // unless overridden in configuration with key "Seed"
       unsigned int seed;
       if (!GENIEconfig.get_if_present("Seed", seed))
         seed = art::ServiceHandle<rndm::NuRandomService>()->getSeed();
       
       // The seed is not passed to RandomNumberGenerator,
       // since GENIE uses a TRandom generator that is owned by the GENIEHelper.
       // Instead, we explicitly configure the random seed for GENIEHelper:
       GENIEconfig.put("RandomSeed", seed);
     } // if no RandomSeed present
     
     fGENIEHelp = new evgb::GENIEHelper(GENIEconfig, 
                                        geo->ROOTGeoManager(),
                                        geo->ROOTFile(),
                                        geo->TotalMass(pset.get< std::string>("TopVolume").c_str()));
     
   }

evgen::GENIEGen::~GENIEGen ( )

virtual

Definition at line 218 of file GENIEGen_module.cc.

References fGENIEHelp, and fStopwatch.

   {  
     if(fGENIEHelp) delete fGENIEHelp;
     fStopwatch.Stop();
     mf::LogInfo("GENIEProductionTime") << "real time to produce file: " << fStopwatch.RealTime();
   }

Member Function Documentation

void evgen::GENIEGen::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 226 of file GENIEGen_module.cc.

References geo::GeometryCore::DetHalfHeight(), geo::GeometryCore::DetHalfWidth(), geo::GeometryCore::DetLength(), fCCMode, fDCosX, fDCosY, fDCosZ, fDefinedVtxHistRange, fDeltaE, fECons, fEDCosX, fEDCosY, fEDCosZ, fEMomentum, fGenerated, fGENIEHelp, fMuDCosX, fMuDCosY, fMuDCosZ, fMuMomentum, fNCMode, fPrevTotGoodPOT, fPrevTotPOT, fVertexX, fVertexXY, fVertexXZ, fVertexY, fVertexYZ, fVertexZ, fVtxPosHistRange, evgb::GENIEHelper::Initialize(), art::TFileDirectory::make(), x, y, and z.

                          {
     fGENIEHelp->Initialize();
 
     fPrevTotPOT = 0.;
     fPrevTotGoodPOT = 0.;
 
     // Get access to the TFile service.
     art::ServiceHandle<art::TFileService> tfs;
 
     fGenerated[0] = tfs->make<TH1F>("fGenerated_necc","",  100, 0.0, 20.0);
     fGenerated[1] = tfs->make<TH1F>("fGenerated_nebcc","", 100, 0.0, 20.0);
     fGenerated[2] = tfs->make<TH1F>("fGenerated_nmcc","",  100, 0.0, 20.0);
     fGenerated[3] = tfs->make<TH1F>("fGenerated_nmbcc","", 100, 0.0, 20.0);
     fGenerated[4] = tfs->make<TH1F>("fGenerated_nnc","",   100, 0.0, 20.0);
     fGenerated[5] = tfs->make<TH1F>("fGenerated_nbnc","",  100, 0.0, 20.0);
     
     fDCosX = tfs->make<TH1F>("fDCosX", ";dx/ds", 200, -1., 1.);
     fDCosY = tfs->make<TH1F>("fDCosY", ";dy/ds", 200, -1., 1.);
     fDCosZ = tfs->make<TH1F>("fDCosZ", ";dz/ds", 200, -1., 1.);
 
     fMuMomentum = tfs->make<TH1F>("fMuMomentum", ";p_{#mu} (GeV/c)", 500, 0., 50.);
     fMuDCosX    = tfs->make<TH1F>("fMuDCosX", ";dx/ds;", 200, -1., 1.);
     fMuDCosY    = tfs->make<TH1F>("fMuDCosY", ";dy/ds;", 200, -1., 1.);
     fMuDCosZ    = tfs->make<TH1F>("fMuDCosZ", ";dz/ds;", 200, -1., 1.);
 
     fEMomentum  = tfs->make<TH1F>("fEMomentum", ";p_{e} (GeV/c)", 500, 0., 50.);
     fEDCosX     = tfs->make<TH1F>("fEDCosX", ";dx/ds;", 200, -1., 1.);
     fEDCosY     = tfs->make<TH1F>("fEDCosY", ";dy/ds;", 200, -1., 1.);
     fEDCosZ     = tfs->make<TH1F>("fEDCosZ", ";dz/ds;", 200, -1., 1.);
 
     fCCMode = tfs->make<TH1F>("fCCMode", ";CC Interaction Mode;", 4, 0., 4.);
     fCCMode->GetXaxis()->SetBinLabel(1, "QE");
     fCCMode->GetXaxis()->SetBinLabel(2, "Res");
     fCCMode->GetXaxis()->SetBinLabel(3, "DIS");
     fCCMode->GetXaxis()->SetBinLabel(4, "Coh");
     fCCMode->GetXaxis()->CenterLabels();
 
     fNCMode = tfs->make<TH1F>("fNCMode", ";NC Interaction Mode;", 4, 0., 4.);
     fNCMode->GetXaxis()->SetBinLabel(1, "QE");
     fNCMode->GetXaxis()->SetBinLabel(2, "Res");
     fNCMode->GetXaxis()->SetBinLabel(3, "DIS");
     fNCMode->GetXaxis()->SetBinLabel(4, "Coh");
     fNCMode->GetXaxis()->CenterLabels();
 
     fDeltaE = tfs->make<TH1F>("fDeltaE", ";#Delta E_{#nu} (GeV);", 200, -1., 1.); 
     fECons  = tfs->make<TH1F>("fECons", ";#Delta E(#nu,lepton);", 500, -5., 5.);
 
     art::ServiceHandle<geo::Geometry> geo;
     double x = 2.1*geo->DetHalfWidth();
     double y = 2.1*geo->DetHalfHeight();
     double z = 2.*geo->DetLength();
     int xdiv = TMath::Nint(2*x/5.);
     int ydiv = TMath::Nint(2*y/5.);
     int zdiv = TMath::Nint(2*z/5.);
 
     if (fDefinedVtxHistRange == false)
     {
         fVertexX = tfs->make<TH1F>("fVertexX", ";x (cm)", xdiv, -0.1*x, x);
         fVertexY = tfs->make<TH1F>("fVertexY", ";y (cm)", ydiv, -y,     y);
         fVertexZ = tfs->make<TH1F>("fVertexZ", ";z (cm)", zdiv, -0.1*z, z);
     
         fVertexXY = tfs->make<TH2F>("fVertexXY", ";x (cm);y (cm)", xdiv, -0.1*x, x, ydiv,     -y, y);
         fVertexXZ = tfs->make<TH2F>("fVertexXZ", ";z (cm);x (cm)", zdiv, -0.2*z, z, xdiv, -0.1*x, x);
         fVertexYZ = tfs->make<TH2F>("fVertexYZ", ";z (cm);y (cm)", zdiv, -0.2*z, z, ydiv,     -y, y);
     }
     else
     {
         fVertexX = tfs->make<TH1F>("fVertexX", ";x (cm)", xdiv, fVtxPosHistRange[0], fVtxPosHistRange[1]);
         fVertexY = tfs->make<TH1F>("fVertexY", ";y (cm)", ydiv, fVtxPosHistRange[2], fVtxPosHistRange[3]);
         fVertexZ = tfs->make<TH1F>("fVertexZ", ";z (cm)", zdiv, fVtxPosHistRange[4], fVtxPosHistRange[5]);
     
         fVertexXY = tfs->make<TH2F>("fVertexXY", ";x (cm);y (cm)", xdiv, fVtxPosHistRange[0], fVtxPosHistRange[1], ydiv,     fVtxPosHistRange[2], fVtxPosHistRange[3]);
         fVertexXZ = tfs->make<TH2F>("fVertexXZ", ";z (cm);x (cm)", zdiv, fVtxPosHistRange[4], fVtxPosHistRange[5], xdiv,     fVtxPosHistRange[0], fVtxPosHistRange[1]);
         fVertexYZ = tfs->make<TH2F>("fVertexYZ", ";z (cm);y (cm)", zdiv, fVtxPosHistRange[4], fVtxPosHistRange[5], ydiv,     fVtxPosHistRange[2], fVtxPosHistRange[3]);
     }
 
   }

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

virtual

Reimplemented from art::EDProducer.

Definition at line 305 of file GENIEGen_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;
   }

void evgen::GENIEGen::beginSubRun ( art::SubRun & sr )

virtual

Reimplemented from art::EDProducer.

Definition at line 318 of file GENIEGen_module.cc.

References fGENIEHelp, fPrevTotGoodPOT, fPrevTotPOT, and evgb::GENIEHelper::TotalExposure().

   {
 
     fPrevTotPOT = fGENIEHelp->TotalExposure();
     fPrevTotGoodPOT = fGENIEHelp->TotalExposure();
 
     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(), 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();
   }

void evgen::GENIEGen::endSubRun ( art::SubRun & sr )

virtual

Reimplemented from art::EDProducer.

Definition at line 328 of file GENIEGen_module.cc.

References fGENIEHelp, fPrevTotGoodPOT, fPrevTotPOT, art::SubRun::put(), evgb::GENIEHelper::TotalExposure(), sumdata::POTSummary::totgoodpot, and sumdata::POTSummary::totpot.

   {
 
     std::unique_ptr<sumdata::POTSummary> p(new sumdata::POTSummary());
     
     p->totpot = fGENIEHelp->TotalExposure() - fPrevTotPOT;
     p->totgoodpot = fGENIEHelp->TotalExposure() - fPrevTotGoodPOT;
 
     sr.put(std::move(p));
 
     return;
   }

void evgen::GENIEGen::FillHistograms ( simb::MCTruth mc )

private

< fill the vertex histograms from the neutrino - that is always particle 0 in the list

look for the outgoing lepton in the particle stack just interested in the first one

Definition at line 491 of file GENIEGen_module.cc.

References simb::MCNeutrino::CCNC(), DEFINE_ART_MODULE, simb::MCParticle::E(), energy, fCCMode, fDCosX, fDCosY, fDCosZ, fECons, fEDCosX, fEDCosY, fEDCosZ, fEMomentum, fGenerated, fMuDCosX, fMuDCosY, fMuDCosZ, fMuMomentum, fNCMode, fVertexX, fVertexXY, fVertexXZ, fVertexY, fVertexYZ, fVertexZ, simb::MCTruth::GetNeutrino(), simb::MCTruth::GetParticle(), simb::kCC, art::left(), LOG_DEBUG, simb::MCNeutrino::Mode(), simb::MCTruth::NParticles(), simb::MCNeutrino::Nu(), simb::MCParticle::P(), part, ParticleStatus(), simb::MCParticle::PdgCode(), simb::MCParticle::Px(), simb::MCParticle::Py(), simb::MCParticle::Pz(), ReactionChannel(), simb::MCParticle::Vx(), simb::MCParticle::Vy(), and simb::MCParticle::Vz().

Referenced by produce().

   {
     // Decide which histograms to put the spectrum in
     int id = -1;
     if (mc.GetNeutrino().CCNC()==simb::kCC) {
       fCCMode->Fill(mc.GetNeutrino().Mode());
       if      (mc.GetNeutrino().Nu().PdgCode() ==  12) id = 0;
       else if (mc.GetNeutrino().Nu().PdgCode() == -12) id = 1;
       else if (mc.GetNeutrino().Nu().PdgCode() ==  14) id = 2;
       else if (mc.GetNeutrino().Nu().PdgCode() == -14) id = 3;
       else return;
     }
     else {
       fNCMode->Fill(mc.GetNeutrino().Mode());
       if (mc.GetNeutrino().Nu().PdgCode() > 0) id = 4;
       else                                     id = 5;
     }
     if (id==-1) abort();
   
     // Fill the specta histograms
     fGenerated[id]->Fill(mc.GetNeutrino().Nu().E() );
       
     simb::MCNeutrino       mcnu = mc.GetNeutrino();
     const simb::MCParticle nu   = mcnu.Nu();
 
     fVertexX->Fill(nu.Vx());
     fVertexY->Fill(nu.Vy());
     fVertexZ->Fill(nu.Vz());
 
     fVertexXY->Fill(nu.Vx(), nu.Vy());
     fVertexXZ->Fill(nu.Vz(), nu.Vx());
     fVertexYZ->Fill(nu.Vz(), nu.Vy());
 
     double mom = nu.P();
     if(std::abs(mom) > 0.){
       fDCosX->Fill(nu.Px()/mom);
       fDCosY->Fill(nu.Py()/mom);
       fDCosZ->Fill(nu.Pz()/mom);
     }
 
 
     LOG_DEBUG("GENIEInteractionInformation") 
       << std::endl
       << "REACTION:  " << ReactionChannel(mc.GetNeutrino().CCNC(),mc.GetNeutrino().Mode()) 
       << std::endl
       << "-----------> Particles in the Stack = " << mc.NParticles() << std::endl
       << std::setiosflags(std::ios::left) 
       << std::setw(20) << "PARTICLE"
       << std::setiosflags(std::ios::left) 
       << std::setw(32) << "STATUS"
       << std::setw(18) << "E (GeV)"
       << std::setw(18) << "m (GeV/c2)"
       << std::setw(18) << "Ek (GeV)"
       << std::endl << std::endl;
 
     const TDatabasePDG* databasePDG = TDatabasePDG::Instance();
 
     // Loop over the particle stack for this event 
     for(int i = 0; i < mc.NParticles(); ++i){
       simb::MCParticle part(mc.GetParticle(i));
       std::string name = databasePDG->GetParticle(part.PdgCode())->GetName();
       int code = part.StatusCode();
       std::string status = ParticleStatus(code);
       double mass = part.Mass();
       double energy = part.E(); 
       double Ek = (energy-mass); // Kinetic Energy (GeV)
       if(status=="kIStStableFinalState"||status=="kIStHadronInTheNucleus")
         LOG_DEBUG("GENIEFinalState") 
           << std::setiosflags(std::ios::left) << std::setw(20) << name
           << std::setiosflags(std::ios::left) << std::setw(32) <<status
           << std::setw(18)<< energy
           << std::setw(18)<< mass
           << std::setw(18)<< Ek <<std::endl;
       else 
         LOG_DEBUG("GENIEFinalState")
           << std::setiosflags(std::ios::left) << std::setw(20) << name
           << std::setiosflags(std::ios::left) << std::setw(32) << status
           << std::setw(18) << energy
           << std::setw(18) << mass <<std::endl; 
     }
 
 
     if(mc.GetNeutrino().CCNC() == simb::kCC){
   
       for(int i = 0; i < mc.NParticles(); ++i){
         simb::MCParticle part(mc.GetParticle(i));
         if(abs(part.PdgCode()) == 11){
           fEMomentum->Fill(part.P());
           fEDCosX->Fill(part.Px()/part.P());
           fEDCosY->Fill(part.Py()/part.P());
           fEDCosZ->Fill(part.Pz()/part.P());
           fECons->Fill(nu.E() - part.E());
           break;
         }
         else if(abs(part.PdgCode()) == 13){
           fMuMomentum->Fill(part.P());
           fMuDCosX->Fill(part.Px()/part.P());
           fMuDCosY->Fill(part.Py()/part.P());
           fMuDCosZ->Fill(part.Pz()/part.P());
           fECons->Fill(nu.E() - part.E());
           break;
         }
       }// end loop over particles
     }//end if CC interaction
 
     return;
   }

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

std::string evgen::GENIEGen::ParticleStatus ( int StatusCode )

private

Definition at line 420 of file GENIEGen_module.cc.

References sim::ParticleStatusName().

Referenced by FillHistograms().

   {
     int code = StatusCode;
     std::string ParticleStatusName;
 
     switch(code)
       {
       case -1:
         ParticleStatusName = "kIStUndefined";
         break;
       case 0:
         ParticleStatusName = "kIStInitialState";
         break;
       case 1:
         ParticleStatusName = "kIStStableFinalState";
         break;
       case 2:
         ParticleStatusName = "kIStIntermediateState";
         break;
       case 3:
         ParticleStatusName = "kIStDecayedState";
         break;
       case 11:
         ParticleStatusName = "kIStNucleonTarget";
         break;
       case 12:
         ParticleStatusName = "kIStDISPreFragmHadronicState";
         break;
       case 13:
         ParticleStatusName = "kIStPreDecayResonantState";
         break;
       case 14:
         ParticleStatusName = "kIStHadronInTheNucleus";
         break;
       case 15:
         ParticleStatusName = "kIStFinalStateNuclearRemnant";
         break;
       case 16:
         ParticleStatusName = "kIStNucleonClusterTarget";
         break;
       default:
         ParticleStatusName = "Status Unknown";
       }
     return ParticleStatusName;
   }

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::GENIEGen::produce ( art::Event & evt )

virtual

Implements art::EDProducer.

Definition at line 342 of file GENIEGen_module.cc.

References util::CreateAssn(), sim::dump::DumpGTruth(), sim::dump::DumpMCTruth(), fBeamType, fGENIEHelp, fGlobalTimeOffset, FillHistograms(), fPassEmptySpills, fRandomTimeOffset, simb::MCTruth::GetNeutrino(), simb::MCNeutrino::InteractionType(), simb::kNuanceOffset, LOG_DEBUG, simb::MCTruth::NeutrinoSet(), art::Event::put(), evgb::GENIEHelper::Sample(), and evgb::GENIEHelper::Stop().

   {
     std::unique_ptr< std::vector<simb::MCTruth> > truthcol  (new std::vector<simb::MCTruth>);
     std::unique_ptr< std::vector<simb::MCFlux>  > fluxcol   (new std::vector<simb::MCFlux >);
     std::unique_ptr< std::vector<simb::GTruth>  > gtruthcol (new std::vector<simb::GTruth >);
     std::unique_ptr< art::Assns<simb::MCTruth, simb::MCFlux> > tfassn(new art::Assns<simb::MCTruth, simb::MCFlux>);
     std::unique_ptr< art::Assns<simb::MCTruth, simb::GTruth> > tgtassn(new art::Assns<simb::MCTruth, simb::GTruth>);
     std::unique_ptr< std::vector<sim::BeamGateInfo> > gateCollection(new std::vector<sim::BeamGateInfo>);
 
     while(truthcol->size() < 1){
       while(!fGENIEHelp->Stop()){
         
         simb::MCTruth truth;
         simb::MCFlux  flux;
         simb::GTruth  gTruth;
 
         // GENIEHelper returns a false in the sample method if 
         // either no neutrino was generated, or the interaction
         // occurred beyond the detector's z extent - ie something we
         // would never see anyway.
         if(fGENIEHelp->Sample(truth, flux, gTruth)){
 
           truthcol ->push_back(truth);  
           fluxcol  ->push_back(flux);
           gtruthcol->push_back(gTruth);
           util::CreateAssn(*this, evt, *truthcol, *fluxcol, *tfassn, fluxcol->size()-1, fluxcol->size());
           util::CreateAssn(*this, evt, *truthcol, *gtruthcol, *tgtassn, gtruthcol->size()-1, gtruthcol->size());
           
           FillHistograms(truth);
           
           // check that the process code is not unsupported by GENIE
           // (see issue #18025 for reference);
           // if it is, print all the information we can about this truth record
           if (truth.NeutrinoSet() && (truth.GetNeutrino().InteractionType() == simb::kNuanceOffset)) {
             mf::LogWarning log("GENIEmissingProcessMapping");
             log << "Found an interaction that is not represented by the interaction type code in GENIE:"
               "\nMCTruth record:"
               "\n"
               ;
             sim::dump::DumpMCTruth(log, truth, 2U); // 2 trajectory points per line
             log <<
               "\nGENIE truth record:"
               "\n"
               ;
             sim::dump::DumpGTruth(log, gTruth);
           } // if 
           
         }// end if genie was able to make an event
 
       }// end event generation loop
       
       // check to see if we are to pass empty spills
       if(truthcol->size() < 1 && fPassEmptySpills){
         LOG_DEBUG("GENIEGen") << "no events made for this spill but "
                               << "passing it on and ending the event anyway";
         break;
       }
 
     }// end loop while no interactions are made
 
     // Create a simulated "beam gate" for these neutrino events.
     // We're creating a vector of these because, in a
     // distant-but-possible future, we may be generating more than one
     // beam gate within a simulated time window.
     gateCollection->push_back(sim::BeamGateInfo( fGlobalTimeOffset, fRandomTimeOffset, fBeamType ));
 
     // put the collections in the event 
     evt.put(std::move(truthcol));
     evt.put(std::move(fluxcol));
     evt.put(std::move(gtruthcol));
     evt.put(std::move(tfassn));
     evt.put(std::move(tgtassn));
     evt.put(std::move(gateCollection));
 
     return;
   }

std::string evgen::GENIEGen::ReactionChannel	(	int	ccnc,
		int	mode
	)

private

Definition at line 467 of file GENIEGen_module.cc.

Referenced by FillHistograms().

   {
     std::string ReactionChannelName=" ";
 
     if(ccnc==0)
       ReactionChannelName = "kCC";
     else if(ccnc==1)
       ReactionChannelName = "kNC";
     else std::cout<<"Current mode unknown!! "<<std::endl;
 
     if(mode==0)
       ReactionChannelName += "_kQE";
     else if(mode==1)
       ReactionChannelName += "_kRes";
     else if(mode==2)
       ReactionChannelName += "_kDIS";
     else if(mode==3)
       ReactionChannelName += "_kCoh";
     else std::cout<<"interaction mode unknown!! "<<std::endl;
 
     return ReactionChannelName;
   }

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

::sim::BeamType_t evgen::GENIEGen::fBeamType

private

The width of a simulated "beam gate".

Definition at line 117 of file GENIEGen_module.cc.

Referenced by GENIEGen(), and produce().

TH1F* evgen::GENIEGen::fCCMode

private

CC interaction mode.

Definition at line 146 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fDCosX

private

direction cosine in x

Definition at line 132 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fDCosY

private

direction cosine in y

Definition at line 133 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fDCosZ

private

direction cosine in z

Definition at line 134 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

bool evgen::GENIEGen::fDefinedVtxHistRange

private

Definition at line 109 of file GENIEGen_module.cc.

Referenced by beginJob().

TH1F* evgen::GENIEGen::fDeltaE

private

difference in neutrino energy from MCTruth::Enu() vs TParticle

Definition at line 149 of file GENIEGen_module.cc.

Referenced by beginJob().

TH1F* evgen::GENIEGen::fECons

private

histogram to determine if energy is conserved in the event

Definition at line 150 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fEDCosX

private

direction cosine of outgoing e in x

Definition at line 142 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fEDCosY

private

direction cosine of outgoing e in y

Definition at line 143 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fEDCosZ

private

direction cosine of outgoing e in z

Definition at line 144 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fEMomentum

private

momentum of outgoing electrons

Definition at line 141 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fGenerated[6]

private

Spectra as generated.

Definition at line 122 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

evgb::GENIEHelper* evgen::GENIEGen::fGENIEHelp

private

GENIEHelper object.

Definition at line 108 of file GENIEGen_module.cc.

Referenced by beginJob(), beginSubRun(), endSubRun(), GENIEGen(), produce(), and ~GENIEGen().

double evgen::GENIEGen::fGlobalTimeOffset

private

keep track of how long it takes to run the job

Definition at line 115 of file GENIEGen_module.cc.

Referenced by produce().

TH1F* evgen::GENIEGen::fMuDCosX

private

direction cosine of outgoing mu in x

Definition at line 137 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fMuDCosY

private

direction cosine of outgoing mu in y

Definition at line 138 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fMuDCosZ

private

direction cosine of outgoing mu in z

Definition at line 139 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fMuMomentum

private

momentum of outgoing muons

Definition at line 136 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fNCMode

private

CC interaction mode.

Definition at line 147 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

int evgen::GENIEGen::fPassEmptySpills

private

whether or not to kill evnets with no interactions

Definition at line 112 of file GENIEGen_module.cc.

Referenced by produce().

double evgen::GENIEGen::fPrevTotGoodPOT

private

Total good POT from subruns previous to current subrun.

Definition at line 120 of file GENIEGen_module.cc.

Referenced by beginJob(), beginSubRun(), and endSubRun().

double evgen::GENIEGen::fPrevTotPOT

private

The type of beam.

Total POT from subruns previous to current subrun

Definition at line 119 of file GENIEGen_module.cc.

Referenced by beginJob(), beginSubRun(), and endSubRun().

double evgen::GENIEGen::fRandomTimeOffset

private

The start of a simulated "beam gate".

Definition at line 116 of file GENIEGen_module.cc.

Referenced by produce().

TStopwatch evgen::GENIEGen::fStopwatch

private

Definition at line 113 of file GENIEGen_module.cc.

Referenced by GENIEGen(), and ~GENIEGen().

TH1F* evgen::GENIEGen::fVertexX

private

vertex location of generated events in x

Definition at line 124 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH2F* evgen::GENIEGen::fVertexXY

private

vertex location in xy

Definition at line 128 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH2F* evgen::GENIEGen::fVertexXZ

private

vertex location in xz

Definition at line 129 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fVertexY

private

vertex location of generated events in y

Definition at line 125 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH2F* evgen::GENIEGen::fVertexYZ

private

vertex location in yz

Definition at line 130 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

TH1F* evgen::GENIEGen::fVertexZ

private

vertex location of generated events in z

Definition at line 126 of file GENIEGen_module.cc.

Referenced by beginJob(), and FillHistograms().

std::vector< double > evgen::GENIEGen::fVtxPosHistRange

private

use defined hist range; it is useful to have for asymmetric ranges like in DP FD.

Definition at line 110 of file GENIEGen_module.cc.

Referenced by beginJob().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Note on random number generator

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation