recob::DumpPCAxes Class Reference

Prints the content of all the PCA axis object on screen. More...

Inheritance diagram for recob::DumpPCAxes:

Classes
struct	Config
	Configuration parameters. 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
	DumpPCAxes (Parameters const &config)
	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 PCAxis product More...
std::string	fOutputCategory
	category for LogInfo output More...
bool	fPrintHexFloats
	whether to print floats in base 16 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 PCA axis object on screen.

This analyser prints the content of all the principal component axis object into the LogInfo/LogVerbatim stream.

Configuration parameters

• PCAxisModuleLabel (art::InputTag, mandatory): label of the producer used to create the recob::PCAxis collection to be dumped
• OutputCategory (string, default: "DumpPCAxes"): 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 45 of file DumpPCAxes_module.cc.

Member Typedef Documentation

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

Definition at line 70 of file DumpPCAxes_module.cc.

Constructor & Destructor Documentation

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

explicit

Default constructor.

Definition at line 188 of file DumpPCAxes_module.cc.

    : EDAnalyzer(config)
    , fInputTag(config().PCAxisModuleLabel())
    , fOutputCategory(config().OutputCategory())
    , fPrintHexFloats(config().PrintHexFloats())
    {}

Member Function Documentation

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

overridevirtual

Does the printing.

Definition at line 197 of file DumpPCAxes_module.cc.

                                              {

    //
    // collect all the available information
    //
    // fetch the data to be dumped on screen
    auto PCAxes = evt.getValidHandle<std::vector<recob::PCAxis>>(fInputTag);

    size_t const nPCAs = PCAxes->size();
    mf::LogInfo(fOutputCategory)
      << "The event contains " << nPCAs << " PC axes from '"
      << fInputTag.encode() << "'";

    // prepare the dumper
    PCAxisDumper::PrintOptions_t options;
    options.hexFloats = fPrintHexFloats;
    PCAxisDumper dumper(*PCAxes, options);

    dumper.DumpAllPCAxes(mf::LogVerbatim(fOutputCategory), "  ");

    mf::LogVerbatim(fOutputCategory) << "\n"; // two empty lines

  } // DumpPCAxes::analyze()

Member Data Documentation

art::InputTag recob::DumpPCAxes::fInputTag

private

input tag of the PCAxis product

Definition at line 80 of file DumpPCAxes_module.cc.

std::string recob::DumpPCAxes::fOutputCategory

private

category for LogInfo output

Definition at line 81 of file DumpPCAxes_module.cc.

bool recob::DumpPCAxes::fPrintHexFloats

private

whether to print floats in base 16

Definition at line 82 of file DumpPCAxes_module.cc.

---

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

• lardata/lardata/ArtDataHelper/Dumpers/DumpPCAxes_module.cc