Inheritance diagram for evg::GenieOutput:

Public Types
using	Parameters = art::EDAnalyzer::Table< evg::GenieOutputParams >

using	ModuleType = EDAnalyzer

Public Member Functions
	GenieOutput (const Parameters &params)

	~GenieOutput ()

	GenieOutput (GenieOutput const &)=delete

	GenieOutput (GenieOutput &&)=delete

GenieOutput &	operator= (GenieOutput const &)=delete

GenieOutput &	operator= (GenieOutput &&)=delete

void	analyze (art::Event const &e) override

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

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

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

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

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

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

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

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

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

ConsumesCollector &	consumesCollector ()

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

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

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

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

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

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

Private Member Functions
genie::NtpWriter *	FetchNtpWriter (const std::string &label)

std::ostream *	FetchDumpStream (const std::string &label)

Private Attributes
Parameters	fParams

std::vector< std::string >	fInputModuleLabels
	label(s) of existing MCTruth/GTruth/MCFlux More...

std::string	fOutputGHEPFilePattern

std::string	fDumpFilePattern

int	fDumpGeniePrintLevel

bool	fDumpMCTruth

bool	fDumpGTruth

bool	fDumpMCFlux

bool	fSeparateOutputNtpWriters

bool	fSeparateDumpStreams

std::map< std::string, genie::NtpWriter * >	fOutputNtpWriters

std::map< std::string, std::ostream * >	fDumpStreams

Detailed Description

Definition at line 100 of file GenieOutput_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

using evg::GenieOutput::Parameters = art::EDAnalyzer::Table<evg::GenieOutputParams>

Definition at line 105 of file GenieOutput_module.cc.

Constructor & Destructor Documentation

evg::GenieOutput::GenieOutput ( const Parameters & params )

explicit

Definition at line 169 of file GenieOutput_module.cc.

References fDumpFilePattern, fDumpGeniePrintLevel, fDumpGTruth, fDumpMCFlux, fDumpMCTruth, fInputModuleLabels, fOutputGHEPFilePattern, fParams, fSeparateDumpStreams, and fSeparateOutputNtpWriters.

   : EDAnalyzer(params)
   , fParams(params)
   , fSeparateOutputNtpWriters(false)
   , fSeparateDumpStreams(false)
 {
 #ifdef GENIE_PRE_R3
   // trigger early initialization of PDG database & GENIE message service
   // just to get it out of the way and not intermixed with other output
   genie::PDGLibrary::Instance();
 #else
   // get the GENIE banner out of the way
   // no longer can use genie::PDGLibrary::Instance() to do this
   // because that must happen, in some cases in v3_02_xx, after the tune
   // is determined
   // banner is triggered by first use of GENIE Messenger
   // avoid using GENIE macros (possible conflict with mf macros)
   // LOG("GENIE",pInfo) << "Trigger GENIE banner";
   (*genie::Messenger::Instance())("GENIE") << log4cpp::Priority::INFO
                                            << "Trigger GENIE banner";
 #endif
 
 
   fInputModuleLabels     = fParams().inputModuleLabels();
   fOutputGHEPFilePattern = fParams().outputGHEPFilePattern();
   fDumpFilePattern       = fParams().dumpFilePattern();
   fDumpGeniePrintLevel   = fParams().dumpGeniePrintLevel();
 
   fSeparateOutputNtpWriters =
     ( fOutputGHEPFilePattern.find("%l") != std::string::npos );
   fSeparateDumpStreams =
     ( fDumpFilePattern.find("%l") != std::string::npos );
 
   fDumpMCTruth           = fParams().dumpMCTruth();
   fDumpGTruth            = fParams().dumpGTruth();
   fDumpMCFlux            = fParams().dumpMCFlux();
 
   /*
   mf::LogInfo("GenieOutput") << "##### Dump options "
                              << fDumpMCTruth << " "
                              << fDumpGTruth << " "
                              << fDumpMCFlux << " " ;
   */
 
 }

evg::GenieOutput::~GenieOutput ( )

Definition at line 215 of file GenieOutput_module.cc.

References fDumpStreams, and fOutputNtpWriters.

 {
 
   // release resources
   std::map<std::string,genie::NtpWriter*>::iterator mitro =
     fOutputNtpWriters.begin();
   for ( ; mitro != fOutputNtpWriters.end(); ++mitro ) {
     std::string       label = mitro->first;
     genie::NtpWriter*  ntpw = mitro->second;
     if ( ntpw ) {
       // close out the file
       ntpw->Save();
       delete ntpw;
     }
     mitro->second = 0;
   }
 
   std::map<std::string,std::ostream*>::iterator mitrd = fDumpStreams.begin();
   for ( ; mitrd != fDumpStreams.end(); ++mitrd ) {
     std::string    label = mitrd->first;
     std::ofstream* fout = dynamic_cast<std::ofstream*>(mitrd->second);
     if ( fout ) {
       fout->flush();
       fout->close();
       delete fout;
     }
     mitrd->second = 0;
   }
 }

evg::GenieOutput::GenieOutput ( GenieOutput const & )

delete

evg::GenieOutput::GenieOutput ( GenieOutput && )

delete

Member Function Documentation

void evg::GenieOutput::analyze ( art::Event const & e )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 245 of file GenieOutput_module.cc.

References fDumpGTruth, fDumpMCFlux, fDumpMCTruth, FetchDumpStream(), FetchNtpWriter(), fInputModuleLabels, evgb::MCTruthAndFriendsItr::GetGTruth(), evgb::MCTruthAndFriendsItr::GetLabel(), evgb::MCTruthAndFriendsItr::GetMCFlux(), evgb::MCTruthAndFriendsItr::GetMCTruth(), evgb::MCTruthAndFriendsItr::Next(), and evgb::RetrieveGHEP().

 {
   //std::cerr << "evg::GenieOutput::analyze " << std::endl;
 
   evgb::MCTruthAndFriendsItr mcitr(evt,fInputModuleLabels);
 
   bool flag = true;
   int  indx = -1;
   while ( ( flag = mcitr.Next() ) ) {
     ++indx;
     std::string label             = mcitr.GetLabel();
     const simb::MCTruth* pmctruth = mcitr.GetMCTruth();
     const simb::GTruth*  pgtruth  = mcitr.GetGTruth();
     const simb::MCFlux*  pmcflux  = mcitr.GetMCFlux();
 
     static int ievt = -1; // ! bah!
     ++ievt;
 
     static const simb::GTruth nullGTruth;
     if ( ! pgtruth ) {
       mf::LogInfo("GenieOutput") << "##### no GTruth ";
       pgtruth = &nullGTruth;
     }
 
     genie::EventRecord* grec = evgb::RetrieveGHEP(*pmctruth,*pgtruth);
 
     genie::NtpWriter* ntpWriter = FetchNtpWriter(label);
     if ( ntpWriter ) {
       // check ownership! (might need copy)
       ntpWriter->AddEventRecord(ievt,grec);
     }
 
     std::ostream* osdump = FetchDumpStream(label);
     if ( osdump ) {
       *osdump
         << " ** Event: GenieOutput_module " << ievt
         << *grec;
       osdump->flush();
     }
 
     if ( fDumpMCTruth || fDumpGTruth || fDumpMCFlux ) {
       std::ostringstream dumpSimBaseObj;
       dumpSimBaseObj << " after Next() " << indx << " " << flag
                      << std::endl;;
       if ( fDumpMCTruth ) {
         if ( pmctruth ) dumpSimBaseObj << *pmctruth << std::endl;
         else            dumpSimBaseObj << "no simb::MCTruth available" << std::endl;
       }
       if ( fDumpGTruth ) {
         if ( pgtruth ) {
           dumpSimBaseObj << *pgtruth << std::endl;
           //dumpSimBaseObj << "sorry no operator<< exists for simb::GTruth"
           //               << " - someone should write one" << std::endl;
         } else dumpSimBaseObj << "no simb::GTruth available" << std::endl;
       }
       if ( fDumpMCFlux ) {
         if ( pmcflux ) dumpSimBaseObj << *pmcflux << std::endl;
         else           dumpSimBaseObj << "no simb::MCFlux available" << std::endl;
       }
       mf::LogInfo("GenieOutput") << dumpSimBaseObj.str();
     }
 
     delete grec;  // don't leak stuff
   } // loop over MCTruthAndFriends
 
 }

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

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

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

std::ostream * evg::GenieOutput::FetchDumpStream ( const std::string & label )

private

Definition at line 344 of file GenieOutput_module.cc.

References DEFINE_ART_MODULE, fDumpFilePattern, fDumpGeniePrintLevel, fDumpStreams, and fSeparateDumpStreams.

Referenced by analyze().

                                                                   {
   if (fDumpGeniePrintLevel < 0 ) return 0;
   genie::GHepRecord::SetPrintLevel(fDumpGeniePrintLevel);
 
   std::ostream* osret = 0;
   if ( fSeparateDumpStreams ) osret = fDumpStreams[label];
   else                        osret = fDumpStreams["*"];
 
   if ( osret ) return osret; // already openned
 
   // nope?? okay
 
   if ( fDumpFilePattern == ""          ||
        fDumpFilePattern == "--"        ||
        fDumpFilePattern == "cout"      ||
        fDumpFilePattern == "std::cout"     ) {
     // standardize so we don't check all these again
     fDumpFilePattern = "std::cout";
     osret = &(std::cout);
   } else {
     std::string finalFileName = fDumpFilePattern;
     if ( fSeparateDumpStreams ) {
       size_t posl = finalFileName.find("%l");
       if ( posl != std::string::npos ) {
         finalFileName.replace(posl,2,label);
       }
     }
     osret = new std::ofstream(finalFileName.c_str(),
                               std::ios_base::trunc|std::ios_base::out);
 
   }
   if ( fSeparateDumpStreams ) fDumpStreams[label] = osret;
   else                        fDumpStreams["*"]   = osret;
 
   return osret;
 
 }

genie::NtpWriter * evg::GenieOutput::FetchNtpWriter ( const std::string & label )

private

Definition at line 312 of file GenieOutput_module.cc.

References fOutputGHEPFilePattern, fOutputNtpWriters, and fSeparateOutputNtpWriters.

Referenced by analyze().

                                                                      {
 
   if ( fOutputGHEPFilePattern == "" ) return 0;
 
   genie::NtpWriter* ntpwret = 0;
   if ( fSeparateOutputNtpWriters ) ntpwret = fOutputNtpWriters[label];
   else                             ntpwret = fOutputNtpWriters["*"];
 
   if ( ntpwret ) return ntpwret; // already openned
 
   // nope?? okay
 
   std::string finalFileName = fOutputGHEPFilePattern;
   if ( fSeparateOutputNtpWriters ) {
     size_t posl = finalFileName.find("%l");
     if ( posl != std::string::npos ) {
       finalFileName.replace(posl,2,label);
     }
   }
   ntpwret = new genie::NtpWriter(genie::kNFGHEP,0);
   ntpwret->CustomizeFilename(finalFileName);
   ntpwret->Initialize();
 
   if ( fSeparateOutputNtpWriters ) fOutputNtpWriters[label] = ntpwret;
   else                             fOutputNtpWriters["*"]   = ntpwret;
 
   return ntpwret;
 
 
 }

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

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

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

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

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

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

GenieOutput& evg::GenieOutput::operator= ( GenieOutput const & )

delete

GenieOutput& evg::GenieOutput::operator= ( GenieOutput && )

delete

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }