DumpVertices_module.cc

Go to the documentation of this file.

// LArSoft includes
#include "lardataobj/RecoBase/Vertex.h"

// art libraries
#include "canvas/Utilities/InputTag.h"
#include "art/Framework/Core/EDAnalyzer.h"
#include "art/Framework/Principal/Event.h"

// support libraries
#include "fhiclcpp/ParameterSet.h"

// C//C++ standard libraries
#include <string>

// ... and more in the implementation part

namespace recob {
  
  class DumpVertices: public art::EDAnalyzer {
      public:
    
    explicit DumpVertices(fhicl::ParameterSet const& pset); 
    
    virtual void analyze (const art::Event& evt) override;

      private:

    art::InputTag fInputTag; 
    std::string fOutputCategory; 
    bool fPrintHexFloats; 

  }; // class DumpVertices
  
} // namespace recob


//==============================================================================
//===  Implementation section
//==============================================================================

// LArSoft includes
#include "lardataobj/RecoBase/Vertex.h"
#include "lardata/ArtDataHelper/Dumpers/hexfloat.h"

// art libraries
#include "art/Framework/Core/ModuleMacros.h"
#include "art/Framework/Principal/Handle.h"

// support libraries
#include "messagefacility/MessageLogger/MessageLogger.h"

// C//C++ standard libraries
#include <vector>


namespace {
  
  //----------------------------------------------------------------------------
  class VertexDumper {
      public:
         
    struct PrintOptions_t {
       bool hexFloats = false; 
    }; // PrintOptions_t
    
    
    VertexDumper(std::vector<recob::Vertex> const& vertex_list)
      : VertexDumper(vertex_list, {})
      {}
    
    VertexDumper(
      std::vector<recob::Vertex> const& vertex_list,
      PrintOptions_t print_options
      )
      : vertices(vertex_list)
      , options(print_options)
      {}
    
    
    template <typename Stream>
    void DumpVertex
      (Stream&& out, size_t iVertex, std::string indentstr = "") const
      {
        lar::OptionalHexFloat hexfloat(options.hexFloats);
    
        recob::Vertex const& vertex = vertices.at(iVertex);
        
        //
        // intro
        //
        out << "\n" << indentstr
          << "[#" << iVertex << "]";
        
        std::array<double, 3> vtx_pos;
        vertex.XYZ(vtx_pos.data());
        out << " ID=" << vertex.ID() << " at ("
          << hexfloat(vtx_pos[0]) << "," << hexfloat(vtx_pos[1])
          << "," << hexfloat(vtx_pos[2])
          << ")";
        
        //
        // done
        //
        
      } // DumpVertex()
    
    
    template <typename Stream>
    void DumpAllVertices(Stream&& out, std::string indentstr = "") const
      {
        indentstr += "  ";
        size_t const nVertices = vertices.size();
        for (size_t iVertex = 0; iVertex < nVertices; ++iVertex)
          DumpVertex(out, iVertex, indentstr);
      } // DumpAllVertices()
    
    
    
      protected:
    std::vector<recob::Vertex> const& vertices; 
    
    PrintOptions_t options; 
    
  }; // VertexDumper
  
  
  //----------------------------------------------------------------------------
  
  
} // local namespace



namespace recob {
  
  //----------------------------------------------------------------------------
  DumpVertices::DumpVertices(fhicl::ParameterSet const& pset) 
    : EDAnalyzer(pset)
    , fInputTag      (pset.get<art::InputTag>("VertexModuleLabel"))
    , fOutputCategory(pset.get<std::string>  ("OutputCategory", "DumpVertices"))
    , fPrintHexFloats(pset.get<bool>         ("PrintHexFloats", false))
    {}
  
  
  //----------------------------------------------------------------------------
  void DumpVertices::analyze(const art::Event& evt) {
    
    //
    // 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()

  DEFINE_ART_MODULE(DumpVertices)

} // namespace recob