detsim::DumpOpDetWaveforms Class Reference

Prints the content of all optical detector waveforms on screen. More...

Inheritance diagram for detsim::DumpOpDetWaveforms:

Classes
struct	Config

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	DumpOpDetWaveforms (Parameters const &config)
void	analyze (const art::Event &evt)
	Does the printing. More...
template<typename Stream >
void	DumpWaveform (Stream &&out, raw::OpDetWaveform const &waveform, std::string indent, std::string indentFirst) const
	Dumps the content of a single waveform into the specified output stream. More...
template<typename Stream >
void	DumpWaveform (Stream &&out, raw::OpDetWaveform const &waveform, std::string indent="") const
std::string	workerType () const
bool	modifiesEvent () const
void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
std::string const &	processName () const
bool	wantAllEvents () const
bool	wantEvent (Event const &e)
fhicl::ParameterSetID	selectorConfig () const
art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) 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
detail::CachedProducts &	cachedProducts ()
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Attributes
art::InputTag	fOpDetWaveformsTag
	Input tag of data product to dump. More...
std::string	fOutputCategory
	Category for mf::LogInfo output. More...
unsigned int	fDigitsPerLine
	ADC readings per line in the output. More...
raw::ADC_Count_t	fPedestal
	ADC pedestal (subtracted from readings). More...

Detailed Description

Prints the content of all optical detector waveforms on screen.

This analyser prints the content of all the raw digits into the LogInfo/LogVerbatim stream.

Configuration parameters

• OpDetWaveformsTag (string, default: daq): input tag of the raw::OpDetWaveform collection to be dumped
• OutputCategory (string, default: DumpOpDetWaveforms): the category used for the output (useful for filtering)
• DigitsPerLine (integer, default: 20): the dump of ADC readings will put this many of them for each line
• Pedestal (integer, default: 0): ADC readings are written relative to this number

Definition at line 54 of file DumpOpDetWaveforms_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

using detsim::DumpOpDetWaveforms::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 88 of file DumpOpDetWaveforms_module.cc.

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

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

detsim::DumpOpDetWaveforms::DumpOpDetWaveforms ( Parameters const &  config )

explicit

Definition at line 127 of file DumpOpDetWaveforms_module.cc.

    : EDAnalyzer         (config)
    , fOpDetWaveformsTag (config().OpDetWaveformsTag())
    , fOutputCategory    (config().OutputCategory())
    , fDigitsPerLine     (config().DigitsPerLine())
    , fPedestal          (config().Pedestal())
    {}

Member Function Documentation

void detsim::DumpOpDetWaveforms::analyze

(

const art::Event &

evt

)

Does the printing.

Definition at line 137 of file DumpOpDetWaveforms_module.cc.

References DumpWaveform(), fOpDetWaveformsTag, fOutputCategory, and fPedestal.

                                                        {
    
    // fetch the data to be dumped on screen
    auto Waveforms =
      event.getValidHandle<std::vector<raw::OpDetWaveform>>(fOpDetWaveformsTag);
    
    mf::LogVerbatim(fOutputCategory)
      << "The event " << event.id() << " contains data for "
      << Waveforms->size() << " optical detector channels";
    if (fPedestal != 0) {
      mf::LogVerbatim(fOutputCategory) << "A pedestal of " << fPedestal
        << " counts will be subtracted from all ADC readings.";
    } // if pedestal
    
    for (raw::OpDetWaveform const& waveform: *Waveforms) {
      
      DumpWaveform(mf::LogVerbatim(fOutputCategory), waveform, "  ");
      
    } // for waveforms
    
  } // DumpOpDetWaveforms::analyze()

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

  {
    return selectors_;
  }

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::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

  {
    return current_context_.get();
  }

template<typename Stream >

void detsim::DumpOpDetWaveforms::DumpWaveform	(	Stream &&	out,
		raw::OpDetWaveform const &	waveform,
		std::string	indent,
		std::string	indentFirst
	)		const

Dumps the content of a single waveform into the specified output stream.

Definition at line 162 of file DumpOpDetWaveforms_module.cc.

References lar::util::MinMaxCollector< T >::add(), raw::OpDetWaveform::ChannelNumber(), DEFINE_ART_MODULE, fDigitsPerLine, fPedestal, lar::util::MinMaxCollector< T >::max(), min, lar::util::MinMaxCollector< T >::min(), and raw::OpDetWaveform::TimeStamp().

Referenced by analyze(), and DumpWaveform().

  {
    auto const& data = waveform;
    using Count_t = raw::ADC_Count_t;
    
    // print a header for the raw digits
    out << indentFirst
      << "on channel #" << waveform.ChannelNumber() << " (time stamp: "
      << waveform.TimeStamp() << "): " << data.size() << " time ticks";
    
    // print the content of the channel
    if (fDigitsPerLine == 0) return;
    
    std::vector<Count_t> DigitBuffer(fDigitsPerLine), LastBuffer;
    
    unsigned int repeat_count = 0; // additional lines like the last one
    unsigned int index = 0;
    
    lar::util::MinMaxCollector<Count_t> Extrema;
    out << "\n" << indent
      << "  content of the channel (" << fDigitsPerLine << " ticks per line):";
    auto iTick = data.cbegin(), tend = data.cend(); // const iterators
    while (iTick != tend) {
      // the next line will show at most fDigitsPerLine ticks
      unsigned int line_size
        = std::min(fDigitsPerLine, (unsigned int) data.size() - index);
      if (line_size == 0) break; // no more ticks
      
      // fill the new buffer (iTick will move forward)
      DigitBuffer.resize(line_size);
      auto iBuf = DigitBuffer.begin(), bend = DigitBuffer.end();
      while ((iBuf != bend) && (iTick != tend))
        Extrema.add(*(iBuf++) = *(iTick++) - fPedestal);
      index += line_size;
      
      // if the new buffer is the same as the old one, just mark it
      if (DigitBuffer == LastBuffer) {
        repeat_count += 1;
        continue;
      }
      
      // if there are previous repeats, write that on screen
      // before the new, different line
      if (repeat_count > 0) {
        out << "\n" << indent
          << "  [ ... repeated " << repeat_count << " more times ]";
        repeat_count = 0;
      }
      
      // dump the new line of ticks
      out << "\n" << indent << " ";
      for (auto digit: DigitBuffer)
        out << " " << std::setw(4) << digit;
      
      // quick way to assign DigitBuffer to LastBuffer
      // (we don't care we lose the former)
      std::swap(LastBuffer, DigitBuffer);
      
    } // while
    if (repeat_count > 0) {
      out << "\n" << indent
        << "  [ ... repeated " << repeat_count << " more times to the end]";
    }
    if (Extrema.min() != Extrema.max()) {
      out << "\n" << indent
        << "  range of " << data.size()
        << " samples: [" << Extrema.min() << ";" << Extrema.max() << "]";
    }
  
  } // DumpOpDetWaveforms::DumpWaveform()

template<typename Stream >

void detsim::DumpOpDetWaveforms::DumpWaveform ( Stream &&  out, raw::OpDetWaveform const &  waveform, std::string  indent = ""  ) const

inline

Definition at line 106 of file DumpOpDetWaveforms_module.cc.

References DumpWaveform(), and art::detail::indent().

      { DumpWaveform(std::forward<Stream>(out), waveform, indent, indent); }

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

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

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

  {
    return selectors_.getOneTriggerResults(e);
  }

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::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

  {
    return false;
  }

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

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

  {
    return process_name_;
  }

void art::EventObserverBase::registerProducts ( MasterProductRegistry &  , ProductDescriptions &  , ModuleDescription const &    )

inlineinherited

Definition at line 33 of file EventObserverBase.h.

  {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

  {
    return selector_config_id_;
  }

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

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

  {
    return wantAllEvents_;
  }

bool art::EventObserverBase::wantEvent ( Event const &  e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

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

  {
    return selectors_.wantEvent(e);
  }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

    {
      return "WorkerT<EDAnalyzer>";
    }

Member Data Documentation

unsigned int detsim::DumpOpDetWaveforms::fDigitsPerLine

private

ADC readings per line in the output.

Definition at line 116 of file DumpOpDetWaveforms_module.cc.

Referenced by DumpWaveform().

art::InputTag detsim::DumpOpDetWaveforms::fOpDetWaveformsTag

private

Input tag of data product to dump.

Definition at line 114 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

std::string detsim::DumpOpDetWaveforms::fOutputCategory

private

Category for mf::LogInfo output.

Definition at line 115 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze().

raw::ADC_Count_t detsim::DumpOpDetWaveforms::fPedestal

private

ADC pedestal (subtracted from readings).

Definition at line 117 of file DumpOpDetWaveforms_module.cc.

Referenced by analyze(), and DumpWaveform().

---

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

• lardata/v06_47_03/source/lardata/ArtDataHelper/Dumpers/DumpOpDetWaveforms_module.cc