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

Inheritance diagram for recob::DumpClusters:

Classes
struct	Config
	Configuration object. More...

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

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpClusters (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	fClusterModuleLabel
	tag of the cluster data product More...

std::string	fOutputCategory
	category for LogInfo output More...

unsigned int	fHitsPerLine
	hits per line in the output 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 clusters on screen.

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

Configuration parameters

ClusterModuleLabel (string, required): input tag from the producer used to create the recob::Cluster collection to be dumped
OutputCategory (string, default: "DumpClusters"): the category used for the output (useful for filtering)
HitsPerLine (integer, default: 20): the dump of hits will put this many of them for each line

Definition at line 54 of file DumpClusters_module.cc.

Member Typedef Documentation

using recob::DumpClusters::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 79 of file DumpClusters_module.cc.

Constructor & Destructor Documentation

recob::DumpClusters::DumpClusters ( Parameters const & config )

explicit

Default constructor.

Definition at line 114 of file DumpClusters_module.cc.

     : EDAnalyzer         (config)
     , fClusterModuleLabel(config().ClusterModuleLabel())
     , fOutputCategory    (config().OutputCategory())
     , fHitsPerLine       (config().HitsPerLine())
     {}

Member Function Documentation

void recob::DumpClusters::analyze ( const art::Event & evt )

Does the printing.

Definition at line 123 of file DumpClusters_module.cc.

                                                 {
 
     // fetch the data to be dumped on screen
     art::InputTag ClusterInputTag(fClusterModuleLabel);
 
     auto Clusters
       = evt.getValidHandle<std::vector<recob::Cluster>>(ClusterInputTag);
 
     // get cluster-hit associations
     art::FindManyP<recob::Hit> HitAssn(Clusters, evt, ClusterInputTag);
 
     mf::LogInfo(fOutputCategory)
       << "The event contains " << Clusters->size() << " '"
       << ClusterInputTag.encode() << "' clusters";
 
     unsigned int iCluster = 0;
     std::vector<size_t> HitBuffer(fHitsPerLine), LastBuffer;
     for (const recob::Cluster& cluster: *Clusters) {
       decltype(auto) ClusterHits = HitAssn.at(iCluster);
 
       // print a header for the cluster
       mf::LogVerbatim(fOutputCategory)
         << "Cluster #" << (iCluster++) << " from " << ClusterHits.size()
         << " hits: " << cluster;
 
 
       // print the hits of the cluster
       if ((fHitsPerLine > 0) && !ClusterHits.empty()) {
         std::vector<size_t> HitIndices;
         for (art::Ptr<recob::Hit> pHit: ClusterHits)
           HitIndices.push_back(pHit.key());
         std::sort(HitIndices.begin(), HitIndices.end());
 
         unsigned int Padding = ::StringLength(HitIndices.back());
 
         mf::LogVerbatim(fOutputCategory) << "  hit indices:";
 
         std::vector<size_t>::const_iterator iHit = HitIndices.begin(),
           hend = HitIndices.end();
         size_t RangeStart = *iHit, RangeStop = RangeStart;
         std::ostringstream output_line;
         size_t nItemsInLine = 0;
         while (++iHit != hend) {
 
           if (*iHit == RangeStop + 1) {
             ++RangeStop;
           }
           else {
             // the new item does not belong to the current range:
             // - print the current range
             if (RangeStart == RangeStop) {
               output_line << "  " << std::setw(Padding) << RangeStart;
               ++nItemsInLine;
             }
             else {
               char fill = (RangeStart + 1 == RangeStop)? ' ': '-';
               output_line << "  " << std::setw(Padding) << RangeStart
                 << fill << fill
                 << std::setw(Padding) << std::setfill(fill) << RangeStop
                 << std::setfill(' ');
               nItemsInLine += 2;
             }
             // - start a new one
             RangeStart = RangeStop = *iHit;
           } // if ... else
 
           // if we have enough stuff in the buffer, let's print it
           if (nItemsInLine >= fHitsPerLine) {
             nItemsInLine = 0;
             mf::LogVerbatim(fOutputCategory) << " " << output_line.str();
             output_line.str("");
           }
 
         } // while
 
         mf::LogVerbatim line_out(fOutputCategory);
         line_out << " " << output_line.str();
         if (RangeStart == RangeStop)
           line_out << "  " << std::setw(Padding) << RangeStart;
         else {
           char fill = (RangeStart + 1 == RangeStop)? ' ': '-';
           line_out << "  " << std::setw(Padding) << RangeStart
             << fill << fill
             << std::setw(Padding) << std::setfill(fill) << RangeStop;
         }
       } // if dumping the hits
 
     } // for clusters
 
   } // DumpClusters::analyze()

Member Data Documentation

art::InputTag recob::DumpClusters::fClusterModuleLabel

private

tag of the cluster data product

Definition at line 89 of file DumpClusters_module.cc.

unsigned int recob::DumpClusters::fHitsPerLine

private

hits per line in the output

Definition at line 91 of file DumpClusters_module.cc.

std::string recob::DumpClusters::fOutputCategory

private

category for LogInfo output

Definition at line 90 of file DumpClusters_module.cc.

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

lardata/lardata/ArtDataHelper/Dumpers/DumpClusters_module.cc

Classes

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation