Inheritance diagram for butcher::EventButcher:

Public Types
using	Parameters = art::EDProducer::Table< EventButcherConfig >

using	ModuleType = EDProducer

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

Public Member Functions
	EventButcher (Parameters const &params)

virtual	~EventButcher ()

void	produce (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
const EventButcherConfig	m_cfg

art::InputTag	m_rawtag

art::InputTag	m_sigtag

Detailed Description

Definition at line 49 of file EventButcher_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

using butcher::EventButcher::Parameters = art::EDProducer::Table<EventButcherConfig>

Definition at line 51 of file EventButcher_module.cc.

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

butcher::EventButcher::EventButcher ( Parameters const & params )

explicit

Definition at line 71 of file EventButcher_module.cc.

References butcher::EventButcherConfig::inRawTag, butcher::EventButcherConfig::inSigTag, m_cfg, m_rawtag, m_sigtag, butcher::EventButcherConfig::outAssnTag, butcher::EventButcherConfig::outRawTag, and butcher::EventButcherConfig::outSigTag.

   : EDProducer{params}, m_cfg(params()), m_rawtag{m_cfg.inRawTag()}, m_sigtag{m_cfg.inSigTag()}
 //    , m_rawtok{consumes< std::vector<raw::RawDigit> >(m_rawtag)}
 //    , m_sigtok{consumes< std::vector<recob::Wire> >(m_sigtag)}
 {
   //cerr << "Producing: outraw:"<<m_cfg.outRawTag()<<" outsig:"<<m_cfg.outSigTag()<<" outras:" << m_cfg.outAssnTag() << endl;
   produces<std::vector<raw::RawDigit>>(m_cfg.outRawTag());
   produces<std::vector<recob::Wire>>(m_cfg.outSigTag());
   produces<art::Assns<raw::RawDigit, recob::Wire>>(m_cfg.outAssnTag());
 }

butcher::EventButcher::~EventButcher ( )

virtual

Definition at line 82 of file EventButcher_module.cc.

82 {}

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

virtual

Implements art::EDProducer.

Definition at line 84 of file EventButcher_module.cc.

References lar::sparse_vector< T >::add_range(), DEFINE_ART_MODULE, util::end(), raw::kNone, m_cfg, m_rawtag, m_sigtag, butcher::EventButcherConfig::ndrop, butcher::EventButcherConfig::nkeep, butcher::EventButcherConfig::outAssnTag, butcher::EventButcherConfig::outRawTag, butcher::EventButcherConfig::outSigTag, and butcher::EventButcherConfig::sigscale.

 {
 
   //cerr <<"In raw=" << m_rawtag << " in sig=" << m_sigtag << "\n";
 
   art::Handle<std::vector<raw::RawDigit>> raw;
   //event.getByToken(m_rawtok, raw);
   event.getByLabel(m_rawtag, raw);
   const size_t nraw = raw->size();
 
   art::Handle<std::vector<recob::Wire>> sig;
   //event.getByToken(m_sigtok, sig);
   event.getByLabel(m_sigtag, sig);
   const size_t nsig = sig->size();
 
   // https://cdcvs.fnal.gov/redmine/projects/art/wiki/The_PtrMaker_utility
   art::PtrMaker<raw::RawDigit> RawPtr(event, m_cfg.outRawTag());
   art::PtrMaker<recob::Wire> SigPtr(event, m_cfg.outSigTag());
 
   // keep track of raw digit Ptr by its channel id, for later look
   // up in making associations.
   std::unordered_map<raw::ChannelID_t, art::Ptr<raw::RawDigit>> chid2rawptr;
 
   // raw-signal association
   auto outrsa = std::make_unique<art::Assns<raw::RawDigit, recob::Wire>>();
   auto outraw = std::make_unique<std::vector<raw::RawDigit>>();
   auto outsig = std::make_unique<std::vector<recob::Wire>>();
 
   const int ndrop = m_cfg.ndrop();
   const int nkeep = m_cfg.nkeep();
   const double sigscale = m_cfg.sigscale();
 
   // Truncate the raw digits
   for (size_t iraw = 0; iraw != nraw; ++iraw) {
     const auto& inrd = raw->at(iraw);
     const auto& inadcs = inrd.ADCs();
     const size_t inlen = inadcs.size();
 
     const int outlen = std::min(inlen - ndrop, nkeep < 0 ? inlen : nkeep);
 
     if (outlen <= 0) {
       continue; // add a "keep_empty" option and save an empty place holder RawDigit here?
     }
 
     size_t outind = outraw->size();
     const raw::ChannelID_t chid = inrd.Channel();
     raw::RawDigit::ADCvector_t outadc(inadcs.begin() + ndrop, inadcs.begin() + ndrop + outlen);
     outraw->emplace_back(raw::RawDigit(chid, outlen, outadc, raw::kNone));
     // given the truncationn, this is technically a BOGUS thing to do
     auto& outrd = outraw->back();
     outrd.SetPedestal(inrd.GetPedestal(), inrd.GetSigma());
 
     chid2rawptr[chid] = RawPtr(outind);
   }
 
   // Truncate the signal and make assns
   for (size_t isig = 0; isig != nsig; ++isig) {
     const auto& inw = sig->at(isig);
     std::vector<float> wave = inw.Signal();
     const size_t inlen = wave.size();
 
     const int outlen = std::min(inlen - ndrop, nkeep < 0 ? inlen : nkeep);
 
     if (outlen <= 0) { continue; }
 
     const auto chid = inw.Channel();
     const auto view = inw.View();
 
     // resparsify
     recob::Wire::RegionsOfInterest_t roi(outlen);
     auto first = wave.begin() + ndrop;
     auto done = wave.begin() + ndrop + outlen;
     auto beg = first;
     while (true) {
       beg = std::find_if(beg, done, [](float v) { return v != 0.0; });
       if (beg == done) { break; }
       auto end = std::find_if(beg, done, [](float v) { return v == 0.0; });
 
       std::vector<float> scaled(beg, end);
       for (int ind = 0; ind < end - beg; ++ind) {
         scaled[ind] *= sigscale;
       }
       roi.add_range(beg - first, scaled.begin(), scaled.end());
       beg = end;
     }
 
     const size_t outind = outsig->size();
     outsig->emplace_back(recob::Wire(roi, chid, view));
 
     // associate
     auto rawit = chid2rawptr.find(chid);
     if (rawit == chid2rawptr.end()) {
       continue; // emit warning about no accompaning raw digit?
     }
     auto const& rawptr = rawit->second;
     auto const sigptr = SigPtr(outind);
     outrsa->addSingle(rawptr, sigptr);
   }
 
   event.put(std::move(outraw), m_cfg.outRawTag());
   event.put(std::move(outsig), m_cfg.outSigTag());
   event.put(std::move(outrsa), m_cfg.outAssnTag());
 }

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

const EventButcherConfig butcher::EventButcher::m_cfg

private

Definition at line 59 of file EventButcher_module.cc.

Referenced by EventButcher(), and produce().

art::InputTag butcher::EventButcher::m_rawtag

private

Definition at line 61 of file EventButcher_module.cc.

Referenced by EventButcher(), and produce().

art::InputTag butcher::EventButcher::m_sigtag

private

Definition at line 61 of file EventButcher_module.cc.

Referenced by EventButcher(), and produce().

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

larwirecell/v09_18_03/source/larwirecell/Modules/EventButcher_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