Inheritance diagram for evgen::MarleyGen:

Classes
struct	Config
	Collection of configuration parameters for the module. More...

struct	KeysToIgnore

Public Types
using	Name = fhicl::Name

using	Comment = fhicl::Comment

using	Parameters = art::EDProducer::Table< Config, KeysToIgnore >

Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	MarleyGen (const Parameters &p)

virtual void	produce (art::Event &e) override

virtual void	beginRun (art::Run &run) override

virtual void	reconfigure (const Parameters &p)

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
std::unique_ptr< evgen::MARLEYHelper >	fMarleyHelper

std::unique_ptr< evgen::ActiveVolumeVertexSampler >	fVertexSampler

std::unique_ptr< marley::Event >	fEvent

TTree *	fEventTree

uint_fast32_t	fRunNumber

uint_fast32_t	fSubRunNumber

uint_fast32_t	fEventNumber

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Definition at line 39 of file MARLEYGen_module.cc.

Member Typedef Documentation

using evgen::MarleyGen::Comment = fhicl::Comment

Definition at line 44 of file MARLEYGen_module.cc.

using evgen::MarleyGen::Name = fhicl::Name

Definition at line 43 of file MARLEYGen_module.cc.

using evgen::MarleyGen::Parameters = art::EDProducer::Table<Config, KeysToIgnore>

Definition at line 72 of file MARLEYGen_module.cc.

Constructor & Destructor Documentation

evgen::MarleyGen::MarleyGen ( const Parameters & p )

explicit

Definition at line 104 of file MARLEYGen_module.cc.

   : EDProducer{ p.get_PSet() },
     fEvent(new marley::Event), fRunNumber(0), fSubRunNumber(0), fEventNumber(0)
 {
   // Configure the module (including MARLEY itself) using the FHiCL parameters
   this->reconfigure( p );
 
   // Create a ROOT TTree using the TFileService that will store the MARLEY
   // event objects (useful for debugging purposes)
   art::ServiceHandle<art::TFileService const> tfs;
   fEventTree = tfs->make<TTree>("MARLEY_event_tree",
     "Neutrino events generated by MARLEY");
   fEventTree->Branch("event", "marley::Event", fEvent.get());
 
   // Add branches that give the art::Event run, subrun, and event numbers for
   // easy match-ups between the MARLEY and art TTrees. All three are recorded
   // as 32-bit unsigned integers.
   fEventTree->Branch("run_number", &fRunNumber, "run_number/i");
   fEventTree->Branch("subrun_number", &fSubRunNumber, "subrun_number/i");
   fEventTree->Branch("event_number", &fEventNumber, "event_number/i");
 
   produces< std::vector<simb::MCTruth>   >();
   produces< sumdata::RunData, art::InRun >();
 }

Member Function Documentation

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

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 130 of file MARLEYGen_module.cc.

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

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

overridevirtual

Implements art::EDProducer.

Definition at line 137 of file MARLEYGen_module.cc.

 {
   // Get the run, subrun, and event numbers from the current art::Event
   fRunNumber = e.run();
   fSubRunNumber = e.subRun();
   fEventNumber = e.event();
 
   std::unique_ptr< std::vector<simb::MCTruth> >
     truthcol(new std::vector<simb::MCTruth>);
 
   // Get the primary vertex location for this event
   art::ServiceHandle<geo::Geometry const> geo;
   TLorentzVector vertex_pos = fVertexSampler->sample_vertex_pos(*geo);
 
   // Create the MCTruth object, and retrieve the marley::Event object
   // that was generated as it was created
   simb::MCTruth truth = fMarleyHelper->create_MCTruth(vertex_pos,
     fEvent.get());
 
   // Write the marley::Event object to the event tree
   fEventTree->Fill();
 
   truthcol->push_back(truth);
 
   e.put(std::move(truthcol));
 }

void evgen::MarleyGen::reconfigure ( const Parameters & p )

virtual

Definition at line 165 of file MARLEYGen_module.cc.

 {
   const auto& seed_service = art::ServiceHandle<rndm::NuRandomService>();
   const auto& geom_service = art::ServiceHandle<geo::Geometry const>();
 
   // Create a new evgen::ActiveVolumeVertexSampler object based on the current
   // configuration
   fVertexSampler = std::make_unique<evgen::ActiveVolumeVertexSampler>(
     p().vertex_, *seed_service, *geom_service, "MARLEY_Vertex_Sampler");
 
   // Create a new marley::Generator object based on the current configuration
   fhicl::ParameterSet marley_pset = p.get_PSet().get< fhicl::ParameterSet >(
     "marley_parameters" );
   fMarleyHelper = std::make_unique<MARLEYHelper>( marley_pset,
     *seed_service, "MARLEY" );
 }

Member Data Documentation

std::unique_ptr<marley::Event> evgen::MarleyGen::fEvent

private

Definition at line 92 of file MARLEYGen_module.cc.

uint_fast32_t evgen::MarleyGen::fEventNumber

private

Definition at line 100 of file MARLEYGen_module.cc.

TTree* evgen::MarleyGen::fEventTree

private

Definition at line 95 of file MARLEYGen_module.cc.

std::unique_ptr<evgen::MARLEYHelper> evgen::MarleyGen::fMarleyHelper

private

Definition at line 85 of file MARLEYGen_module.cc.

uint_fast32_t evgen::MarleyGen::fRunNumber

private

Definition at line 98 of file MARLEYGen_module.cc.

uint_fast32_t evgen::MarleyGen::fSubRunNumber

private

Definition at line 99 of file MARLEYGen_module.cc.

std::unique_ptr<evgen::ActiveVolumeVertexSampler> evgen::MarleyGen::fVertexSampler

private

Definition at line 89 of file MARLEYGen_module.cc.

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

larsim/larsim/EventGenerator/MARLEY/MARLEYGen_module.cc

Classes

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation