butcher::EventButcher Class Reference

Inheritance diagram for butcher::EventButcher:

Public Types
using	Parameters = art::EDProducer::Table< EventButcherConfig >
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	EventButcher (Parameters const &params)
virtual	~EventButcher ()
void	produce (art::Event &evt)
template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const
template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
bool	modifiesEvent () const
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)
base_engine_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

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 34 of file EDProducer.h.

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

Definition at line 52 of file EventButcher_module.cc.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 75 of file EventButcher_module.cc.

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

    : 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 88 of file EventButcher_module.cc.

{
}

Member Function Documentation

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return rng()->createEngine(placeholder_schedule_id(), seed);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make  )

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make, label_t const &  engine_label  )

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
}

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

  {
    return current_context_.get();
  }

EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset, char const  key[] = "seed", seed_t const  implicit_seed = -1  )

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

{
  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
}

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const &  instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

  {
    return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                               instanceName);
  }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription, std::string const &  instanceName  ) const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

    {
      return true;
    }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

void butcher::EventButcher::produce ( art::Event &  evt )

virtual

Implements art::EDProducer.

Definition at line 93 of file EventButcher_module.cc.

References lar::sparse_vector< T >::add_range(), DEFINE_ART_MODULE, evd::details::end(), raw::kNone, m_cfg, m_rawtag, m_sigtag, min, 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, *this, m_cfg.outRawTag());
    art::PtrMaker<recob::Wire> SigPtr(event, *this, 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::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Member Data Documentation

const EventButcherConfig butcher::EventButcher::m_cfg

private

Definition at line 61 of file EventButcher_module.cc.

Referenced by EventButcher(), and produce().

art::InputTag butcher::EventButcher::m_rawtag

private

Definition at line 63 of file EventButcher_module.cc.

Referenced by produce().

art::InputTag butcher::EventButcher::m_sigtag

private

Definition at line 63 of file EventButcher_module.cc.

Referenced by EventButcher(), and produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larwirecell/v07_05_02/source/larwirecell/Modules/EventButcher_module.cc