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 Member Functions
	DumpSpacePoints (Parameters const &config)
	Default constructor. More...
virtual void	analyze (const art::Event &evt) override
	Does the printing. More...

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...

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:

• DumpSpacePoints_module.cc