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

Inheritance diagram for recob::DumpVertices:

Public Member Functions
	DumpVertices (fhicl::ParameterSet const &pset)
	Default constructor. More...

virtual void	analyze (const art::Event &evt) override
	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	fInputTag
	input tag of the Vertex product More...

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

bool	fPrintHexFloats
	whether to print floats in base 16 More...

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

using	ModuleType = EDAnalyzer

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 vertices on screen.

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

Configuration parameters

VertexModuleLabel (art::InputTag, mandatory): label of the producer used to create the recob::Vertex collection to be dumped
OutputCategory (string, default: "DumpVertices"): the category used for the output (useful for filtering)
PrintHexFloats (boolean, default: false): print all the floating point numbers in base 16

Definition at line 43 of file DumpVertices_module.cc.

Constructor & Destructor Documentation

recob::DumpVertices::DumpVertices ( fhicl::ParameterSet const & pset )

explicit

Default constructor.

Definition at line 167 of file DumpVertices_module.cc.

     : EDAnalyzer(pset)
     , fInputTag      (pset.get<art::InputTag>("VertexModuleLabel"))
     , fOutputCategory(pset.get<std::string>  ("OutputCategory", "DumpVertices"))
     , fPrintHexFloats(pset.get<bool>         ("PrintHexFloats", false))
     {}

Member Function Documentation

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

overridevirtual

Does the printing.

Definition at line 176 of file DumpVertices_module.cc.

                                                 {
 
     //
     // collect all the available information
     //
     // fetch the data to be dumped on screen
     auto Vertices = evt.getValidHandle<std::vector<recob::Vertex>>(fInputTag);
 
     size_t const nVertices = Vertices->size();
     mf::LogVerbatim(fOutputCategory) << "Event " << evt.id()
       << " contains " << nVertices << " vertices from '"
       << fInputTag.encode() << "'";
 
     // prepare the dumper
     VertexDumper::PrintOptions_t options;
     options.hexFloats = fPrintHexFloats;
     VertexDumper dumper(*Vertices, options);
 
     dumper.DumpAllVertices(mf::LogVerbatim(fOutputCategory), "  ");
 
     mf::LogVerbatim(fOutputCategory) << "\n"; // two empty lines
 
   } // DumpVertices::analyze()

Member Data Documentation

art::InputTag recob::DumpVertices::fInputTag

private

input tag of the Vertex product

Definition at line 54 of file DumpVertices_module.cc.

std::string recob::DumpVertices::fOutputCategory

private

category for LogInfo output

Definition at line 55 of file DumpVertices_module.cc.

bool recob::DumpVertices::fPrintHexFloats

private

whether to print floats in base 16

Definition at line 56 of file DumpVertices_module.cc.

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

lardata/lardata/ArtDataHelper/Dumpers/DumpVertices_module.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Configuration parameters

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation