recob::DumpSpacePoints Class Reference

Prints the content of all the space points on screen. More...

Inheritance diagram for recob::DumpSpacePoints:

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
	DumpSpacePoints (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 SpacePoint 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 space points on screen.

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

Configuration parameters

• SpacePointModuleLabel (art::InputTag, mandatory): label of the producer used to create the recob::SpacePoint collection to be dumped
• OutputCategory (string, default: "DumpSpacePoints"): 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 DumpSpacePoints_module.cc.

Member Typedef Documentation

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

Definition at line 70 of file DumpSpacePoints_module.cc.

Constructor & Destructor Documentation

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

explicit

Default constructor.

Definition at line 228 of file DumpSpacePoints_module.cc.

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

Member Function Documentation

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

overridevirtual

Does the printing.

Definition at line 237 of file DumpSpacePoints_module.cc.

                                                   {

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

    art::FindMany<recob::Hit> const PointHits(SpacePoints, evt, fInputTag);

    size_t const nPoints = SpacePoints->size();
    mf::LogInfo(fOutputCategory)
      << "The event contains " << nPoints << " space points from '"
      << fInputTag.encode() << "'";

    // prepare the dumper
    SpacePointDumper dumper(*SpacePoints);
    if (PointHits.isValid()) dumper.SetHits(&PointHits);
    else mf::LogWarning("DumpSpacePoints") << "hit information not avaialble";

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

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

  } // DumpSpacePoints::analyze()

Member Data Documentation

art::InputTag recob::DumpSpacePoints::fInputTag

private

input tag of the SpacePoint product

Definition at line 80 of file DumpSpacePoints_module.cc.

std::string recob::DumpSpacePoints::fOutputCategory

private

category for LogInfo output

Definition at line 81 of file DumpSpacePoints_module.cc.

bool recob::DumpSpacePoints::fPrintHexFloats

private

whether to print floats in base 16

Definition at line 82 of file DumpSpacePoints_module.cc.

---

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

• lardata/lardata/ArtDataHelper/Dumpers/DumpSpacePoints_module.cc