Inheritance diagram for MCReco:

Public Types
using	ModuleType = EDProducer

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

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

void	produce (art::Event &e) override

template<typename T >
void	MakeMCEdep (art::Event &evt)

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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
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 Attributes
art::InputTag	fMCParticleLabel

art::InputTag	fMCParticleDroppedLabel

art::InputTag	fSimChannelLabel

bool	fUseSimEnergyDeposit

bool	fUseSimEnergyDepositLite

bool	fIncludeDroppedParticles

::sim::MCRecoPart	fPart

::sim::MCRecoEdep	fEdep

::sim::MCShowerRecoAlg	fMCSAlg

::sim::MCTrackRecoAlg	fMCTAlg

Detailed Description

Definition at line 28 of file MCReco_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

MCReco::MCReco ( fhicl::ParameterSet const & p )

explicit

Definition at line 52 of file MCReco_module.cc.

References fEdep, fIncludeDroppedParticles, fMCParticleDroppedLabel, fMCParticleLabel, fMCSAlg, fMCTAlg, fPart, fSimChannelLabel, fUseSimEnergyDeposit, and fUseSimEnergyDepositLite.

   : EDProducer{pset}
   , fPart(pset.get<fhicl::ParameterSet>("MCRecoPart"))
   , fEdep(pset.get<fhicl::ParameterSet>("MCRecoEdep"))
   , fMCSAlg(pset.get<fhicl::ParameterSet>("MCShowerRecoAlg"))
   , fMCTAlg(pset.get<fhicl::ParameterSet>("MCTrackRecoAlg"))
 {
 
   //for backwards compatibility to using the "G4ModName" label...
   if (!(pset.get_if_present<art::InputTag>("MCParticleLabel", fMCParticleLabel) &&
         pset.get_if_present<art::InputTag>("SimChannelLabel", fSimChannelLabel))) {
 
     mf::LogWarning("MCReco_module") << "USING DEPRECATED G4ModName CONFIG IN MCRECO_MODULE"
                                     << "\nUse 'MCParticleLabel' and 'SimChannelLabel' instead.";
 
     fMCParticleLabel = pset.get<art::InputTag>("G4ModName", "largeant");
     fMCParticleDroppedLabel = pset.get<art::InputTag>("G4ModName", "largeant:droppedMCParticles");
     fSimChannelLabel = pset.get<art::InputTag>("G4ModName", "largeant");
   }
   else {
     fMCParticleDroppedLabel =
       pset.get<art::InputTag>("MCParticleDroppedLabel", "largeant:droppedMCParticles");
   }
 
   fUseSimEnergyDeposit = pset.get<bool>("UseSimEnergyDeposit", false);
   fUseSimEnergyDepositLite = pset.get<bool>("UseSimEnergyDepositLite", false);
   fIncludeDroppedParticles = pset.get<bool>("IncludeDroppedParticles", false);
 
   if (fUseSimEnergyDepositLite && fUseSimEnergyDeposit) {
     mf::LogWarning("MCReco_module")
       << "Asked to use both SimEnergyDeposit and SimEnergyDepositLite - will use SimEnergyDeposit.";
   }
 
   produces<std::vector<sim::MCShower>>();
   produces<std::vector<sim::MCTrack>>();
   // Call appropriate produces<>() functions here.
 
   //MCReco::~MCReco()
   //{
   // Clean up dynamic memory and other resources here.
   //}
 }

Member Function Documentation

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::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

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

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

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

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

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

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

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

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

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

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::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 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

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

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

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

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

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

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

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

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

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

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

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

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

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

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

template<typename T >

void MCReco::MakeMCEdep ( art::Event & evt )

Definition at line 146 of file MCReco_module.cc.

References DEFINE_ART_MODULE, fEdep, fSimChannelLabel, art::ProductRetriever::getValidHandle(), and sim::MCRecoEdep::MakeMCEdep().

 {
   // Retrieve T
   auto const& sed_array = *evt.getValidHandle<std::vector<T>>(fSimChannelLabel);
   fEdep.MakeMCEdep(sed_array);
 }

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

void MCReco::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 95 of file MCReco_module.cc.

References sim::MCRecoPart::AddParticles(), sim::MCRecoEdep::Clear(), tca::evt, fEdep, fIncludeDroppedParticles, fMCParticleDroppedLabel, fMCParticleLabel, fMCSAlg, fMCTAlg, fPart, fUseSimEnergyDeposit, fUseSimEnergyDepositLite, art::ProductRetriever::getByLabel(), art::ProductRetriever::getValidHandle(), art::Handle< T >::isValid(), simb::MCTruth::Origin(), art::Event::put(), sim::MCTrackRecoAlg::Reconstruct(), and sim::MCShowerRecoAlg::Reconstruct().

 {
   //  std::unique_ptr< std::vector<sim::MCTrack> > outTrackArray(new std::vector<sim::MCTrack>);
 
   // Retrieve mcparticles
   art::Handle<std::vector<simb::MCParticle>> mcpHandle;
   evt.getByLabel(fMCParticleLabel, mcpHandle);
   if (!mcpHandle.isValid())
     throw cet::exception(__FUNCTION__) << "Failed to retrieve simb::MCParticle";
   ;
 
   // Find associations
   art::FindOneP<simb::MCTruth> ass(mcpHandle, evt, fMCParticleLabel);
   std::vector<simb::Origin_t> orig_array;
   orig_array.reserve(mcpHandle->size());
   for (size_t i = 0; i < mcpHandle->size(); ++i) {
     const art::Ptr<simb::MCTruth>& mct = ass.at(i);
     orig_array.push_back(mct->Origin());
   }
 
   const std::vector<simb::MCParticle>& mcp_array(*mcpHandle);
 
   if (fIncludeDroppedParticles) {
     auto const& mcmp_array =
       *evt.getValidHandle<std::vector<simb::MCParticle>>(fMCParticleDroppedLabel);
     fPart.AddParticles(mcp_array, orig_array, mcmp_array);
   } // end if fIncludeDroppedParticles
   else {
     fPart.AddParticles(mcp_array, orig_array);
   }
 
   // change implemented by David Caratelli to allow for MCRECO to run without SimChannels and using
   // SimEnergyDeposits instead
   if (fUseSimEnergyDeposit == true) { MakeMCEdep<sim::SimEnergyDeposit>(evt); }
   // change implemented by Laura Domine to allow for MCRECO to run with SimEnergyDepositLite
   else if (fUseSimEnergyDepositLite == true) {
     MakeMCEdep<sim::SimEnergyDepositLite>(evt);
   }
   else {
     MakeMCEdep<sim::SimChannel>(evt);
   }
 
   //Add MCShowers and MCTracks to the event
   evt.put(fMCSAlg.Reconstruct(fPart, fEdep));
   evt.put(fMCTAlg.Reconstruct(fPart, fEdep));
 
   fEdep.Clear();
   fPart.clear();
 }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

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

Member Data Documentation

::sim::MCRecoEdep MCReco::fEdep

private

Definition at line 47 of file MCReco_module.cc.

Referenced by MakeMCEdep(), MCReco(), and produce().

bool MCReco::fIncludeDroppedParticles

private

Definition at line 44 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

art::InputTag MCReco::fMCParticleDroppedLabel

private

Definition at line 40 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

art::InputTag MCReco::fMCParticleLabel

private

Definition at line 39 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

::sim::MCShowerRecoAlg MCReco::fMCSAlg

private

Definition at line 48 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

::sim::MCTrackRecoAlg MCReco::fMCTAlg

private

Definition at line 49 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

::sim::MCRecoPart MCReco::fPart

private

Definition at line 46 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

art::InputTag MCReco::fSimChannelLabel

private

Definition at line 41 of file MCReco_module.cc.

Referenced by MakeMCEdep(), and MCReco().

bool MCReco::fUseSimEnergyDeposit

private

Definition at line 42 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

bool MCReco::fUseSimEnergyDepositLite

private

Definition at line 43 of file MCReco_module.cc.

Referenced by MCReco(), and produce().

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

larsim/v09_43_00/source/larsim/MCSTReco/MCReco_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation