Inheritance diagram for hit::MCHitFinder:

Public Types
using	ModuleType = EDProducer

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

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

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 Member Functions
void	produce (art::Event &e) override

Private Attributes
std::string	fLArG4ModuleName

bool	fVerbose

bool	fMakeMCWire

Detailed Description

Definition at line 31 of file MCHitFinder_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

hit::MCHitFinder::MCHitFinder ( fhicl::ParameterSet const & p )

explicit

Definition at line 43 of file MCHitFinder_module.cc.

References fLArG4ModuleName, fMakeMCWire, and fVerbose.

                                                      : EDProducer{p}
   {
     fLArG4ModuleName = p.get<std::string>("LArG4ModuleName");
     fMakeMCWire = p.get<bool>("MakeMCWire");
     fVerbose = p.get<bool>("Verbose");
     produces<std::vector<sim::MCHitCollection>>();
     if (fMakeMCWire) produces<std::vector<sim::MCWireCollection>>();
   }

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

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 hit::MCHitFinder::produce ( art::Event & e )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 52 of file MCHitFinder_module.cc.

References sim::SimChannel::Channel(), DEFINE_ART_MODULE, edep, fLArG4ModuleName, fMakeMCWire, fVerbose, art::ProductRetriever::getByLabel(), art::Handle< T >::isValid(), geo::GeometryCore::Nchannels(), art::Event::put(), art::Handle< T >::removeProduct(), sim::MCHit::SetCharge(), sim::MCEnDep::SetEnergy(), sim::MCHit::SetParticleInfo(), sim::MCWire::SetStartTDC(), sim::MCHit::SetTime(), sim::MCEnDep::SetTrackId(), sim::MCEnDep::SetVertex(), and sim::SimChannel::TDCIDEMap().

   {
 
     art::ServiceHandle<geo::Geometry const> geo;
 
     const unsigned int nch = geo->Nchannels();
 
     std::unique_ptr<std::vector<sim::MCHitCollection>> hits_v(
       new std::vector<sim::MCHitCollection>());
     std::unique_ptr<std::vector<sim::MCWireCollection>> wires_v(
       new std::vector<sim::MCWireCollection>());
 
     hits_v->reserve(nch);
     wires_v->reserve(nch);
     for (size_t ch = 0; ch < nch; ++ch) {
 
       hits_v->push_back(sim::MCHitCollection(ch));
       wires_v->push_back(sim::MCWireCollection(ch));
     }
 
     art::Handle<std::vector<sim::SimChannel>> simchArray;
     e.getByLabel(fLArG4ModuleName, simchArray);
     if (!simchArray.isValid())
       throw cet::exception(__PRETTY_FUNCTION__)
         << "Did not find sim::SimChannel with a label: " << fLArG4ModuleName.c_str() << std::endl;
 
     // Loop over SimChannel
     for (size_t simch_index = 0; simch_index < simchArray->size(); ++simch_index) {
 
       const art::Ptr<sim::SimChannel> simch_ptr(simchArray, simch_index);
 
       size_t ch = simch_ptr->Channel();
 
       if (ch >= hits_v->size())
 
         throw cet::exception(__PRETTY_FUNCTION__)
           << "Channel number " << ch << " exceeds total # of channels: " << nch << std::endl;
 
       auto& mchits = hits_v->at(ch);
       auto& mcwires = wires_v->at(ch);
 
       std::map<sim::MCEnDep, sim::MCWire> edep_wire_map;
       auto tdc_ide_map = simch_ptr->TDCIDEMap();
 
       // Loop over stored data for a particular sim::SimChannel //
 
       //
       // Read & Convert
       //
       if (fVerbose) std::cout << std::endl << "Processing Ch: " << ch << std::endl;
 
       for (auto const& tdc_ide_pair : tdc_ide_map) {
 
         auto const& tdc = tdc_ide_pair.first;
         auto const& ide_v = tdc_ide_pair.second;
 
         for (auto const& ide : ide_v) {
           sim::MCEnDep edep;
           edep.SetVertex(ide.x, ide.y, ide.z);
           edep.SetEnergy(ide.energy);
           edep.SetTrackId(ide.trackID);
 
           sim::MCWire wire;
           wire.SetStartTDC(tdc);
 
           auto edep_iter = edep_wire_map.insert(std::make_pair(edep, wire));
 
           //auto edep_iter = edep_wire_map.find(edep);
 
           auto last_tdc =
             (edep_iter).first->second.StartTDC() + (edep_iter).first->second.size() - 1;
 
           if (fVerbose) {
 
             if (edep_iter.second) std::cout << std::endl;
 
             std::cout << "  Track: " << ide.trackID << " Vtx: " << ide.x << " " << ide.y << " "
                       << ide.z << " " << ide.energy << " ...  @ TDC = " << tdc << " ... "
                       << ide.numElectrons << std::endl;
           }
 
           if (!(edep_iter.second)) {
 
             if (last_tdc + 1 != tdc) {
               /*
               std::cerr
                 << "Found discontinuous TDC! "
                 << " Last (ADC @ TDC): " << (*(edep_iter.first->second.rbegin())) << " @ " << last_tdc
                 << " while current (ADC @ TDC): " << (ide.numElectrons * detp->ElectronsToADC()) << " @ " << tdc
                 << " ... skipping to store!"
                 << std::endl;
               */
               continue;
             }
           }
           (edep_iter).first->second.push_back(ide.numElectrons);
         } // Done looping over IDEs in a particular TDC
       }   // Done looping over TDC
 
       //
       // Store
       //
       for (auto const& edep_wire_pair : edep_wire_map) {
 
         auto const& edep = edep_wire_pair.first;
         auto const& wire = edep_wire_pair.second;
 
         // Create MCHit
         ::sim::MCHit hit;
         float vtx[3] = {float(edep.Vertex()[0]), float(edep.Vertex()[1]), float(edep.Vertex()[2])};
         hit.SetParticleInfo(vtx, edep.Energy(), edep.TrackId());
 
         double max_time = 0;
         double qsum = 0;
         double qmax = 0;
         for (size_t wire_index = 0; wire_index < wire.size(); ++wire_index) {
 
           auto q = wire.at(wire_index);
 
           qsum += q;
 
           if (q > qmax) {
             qmax = q;
             max_time = wire.StartTDC() + wire_index;
           }
         }
         hit.SetCharge(qsum, qmax);
         hit.SetTime(max_time, 0);
 
         mchits.push_back(hit);
 
         if (!fMakeMCWire) continue;
 
         mcwires.push_back(wire);
       } // End looping over all MCEnDep-MCWire pairs
     }   // End looping over all SimChannels
 
     simchArray.removeProduct();
 
     std::sort((*hits_v).begin(), (*hits_v).end());
     e.put(std::move(hits_v));
 
     if (fMakeMCWire) {
       std::sort((*wires_v).begin(), (*wires_v).end());
       e.put(std::move(wires_v));
     }
   }

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

std::string hit::MCHitFinder::fLArG4ModuleName

private

Definition at line 38 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

bool hit::MCHitFinder::fMakeMCWire

private

Definition at line 40 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

bool hit::MCHitFinder::fVerbose

private

Definition at line 39 of file MCHitFinder_module.cc.

Referenced by MCHitFinder(), and produce().

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

larreco/v09_25_00/source/larreco/HitFinder/MCHitFinder_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation