hit::DumpHits Class Reference

Prints the content of all the hits on screen. More...

Inheritance diagram for hit::DumpHits:

Classes
struct	Config

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

Public Member Functions
	DumpHits (Parameters const &config)
	Default constructor. More...
void	analyze (const art::Event &evt)
	Does the printing. More...
Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDAnalyzer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept
	Analyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	Analyzer (Table< Config > const &config)
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)
Public Member Functions inherited from art::Observer
	~Observer () noexcept
	Observer (Observer const &)=delete
	Observer (Observer &&)=delete
Observer &	operator= (Observer const &)=delete
Observer &	operator= (Observer &&)=delete
void	registerProducts (ProductDescriptions &, ModuleDescription const &)
void	fillDescriptions (ModuleDescription const &)
fhicl::ParameterSetID	selectorConfig () const
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
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)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
art::InputTag	fHitsModuleLabel
	name of module that produced the hits More...
std::string	fOutputCategory
	category for LogInfo output More...
bool	bCheckRawDigits
	check associations with raw digits More...
bool	bCheckWires
	check associations with wires More...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const
bool	wantAllEvents () const noexcept
bool	wantEvent (ScheduleID id, Event const &e) const
Handle< TriggerResults >	getTriggerResults (Event const &e) const
	Observer (fhicl::ParameterSet const &config)
	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Prints the content of all the hits on screen.

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

Configuration parameters

• HitModuleLabel (string): label of the producer used to create the recob::Hit collection
• OutputCategory (string, default: "DumpHits"): the category used for the output (useful for filtering)
• CheckWireAssociation (string, default: false): if set, verifies that the associated wire are on the same channel as the hit
• CheckRawDigitAssociation (string, default: false): if set, verifies that the associated raw digits are on the same channel as the hit

Definition at line 46 of file DumpHits_module.cc.

Member Typedef Documentation

using hit::DumpHits::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 78 of file DumpHits_module.cc.

Constructor & Destructor Documentation

hit::DumpHits::DumpHits ( Parameters const &  config )

explicit

Default constructor.

Definition at line 121 of file DumpHits_module.cc.

    : EDAnalyzer         (config)
    , fHitsModuleLabel   (config().HitModuleLabel())
    , fOutputCategory    (config().OutputCategory())
    , bCheckRawDigits    (config().CheckRawDigitAssociation())
    , bCheckWires        (config().CheckWireAssociation())
    {}

Member Function Documentation

void hit::DumpHits::analyze

(

const art::Event &

evt

)

Does the printing.

Definition at line 131 of file DumpHits_module.cc.

                                            {

    // fetch the data to be dumped on screen
    auto Hits = evt.getValidHandle<std::vector<recob::Hit>>(fHitsModuleLabel);

    mf::LogInfo(fOutputCategory)
      << "The event contains " << Hits->size() << " '"
      << fHitsModuleLabel.encode() << "' hits";

    std::unique_ptr<art::FindOne<raw::RawDigit>> HitToRawDigit;
    if (bCheckRawDigits) {
      HitToRawDigit.reset
        (new art::FindOne<raw::RawDigit>(Hits, evt, fHitsModuleLabel));
      if (!HitToRawDigit->isValid()) {
        throw art::Exception(art::errors::ProductNotFound)
          << "DumpHits: can't find associations between raw digits and hits from '"
          << fHitsModuleLabel << "'";
      }
    } // if check raw digits

    std::unique_ptr<art::FindOne<recob::Wire>> HitToWire;
    if (bCheckWires) {
      HitToWire.reset(new art::FindOne<recob::Wire>(Hits, evt, fHitsModuleLabel));
      if (!HitToWire->isValid()) {
        throw art::Exception(art::errors::ProductNotFound)
          << "DumpHits: can't find associations between wires and hits from '"
          << fHitsModuleLabel << "'";
      }
    } // if check wires

    unsigned int iHit = 0;
    for (const recob::Hit& hit: *Hits) {

      // print a header for the cluster
      mf::LogVerbatim(fOutputCategory)
        << "Hit #" << iHit << ": " << hit;

      if (HitToRawDigit) {
        raw::ChannelID_t assChannelID = HitToRawDigit->at(iHit).ref().Channel();
        if (assChannelID != hit.Channel()) {
          throw art::Exception(art::errors::DataCorruption)
            << "Hit #" << iHit << " on channel " << hit.Channel()
            << " is associated with raw digit on channel " << assChannelID
            << "!!";
        } // mismatch
      } // raw digit check

      if (HitToWire) {
        raw::ChannelID_t assChannelID = HitToWire->at(iHit).ref().Channel();
        if (assChannelID != hit.Channel()) {
          throw art::Exception(art::errors::DataCorruption)
            << "Hit #" << iHit << " on channel " << hit.Channel()
            << " is associated with wire on channel " << assChannelID
            << "!!";
        } // mismatch
      } // wire check

      ++iHit;
    } // for hits

  } // DumpHits::analyze()

Member Data Documentation

bool hit::DumpHits::bCheckRawDigits

private

check associations with raw digits

Definition at line 91 of file DumpHits_module.cc.

bool hit::DumpHits::bCheckWires

private

check associations with wires

Definition at line 92 of file DumpHits_module.cc.

art::InputTag hit::DumpHits::fHitsModuleLabel

private

name of module that produced the hits

Definition at line 89 of file DumpHits_module.cc.

std::string hit::DumpHits::fOutputCategory

private

category for LogInfo output

Definition at line 90 of file DumpHits_module.cc.

---

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

• lardata/lardata/ArtDataHelper/Dumpers/DumpHits_module.cc