DumpChargedSpacePoints_module.cc

Go to the documentation of this file.

// LArSoft includes
#include "lardata/ArtDataHelper/Dumpers/SpacePointDumpers.h"
#include "lardata/RecoBaseProxy/ChargedSpacePoints.h"
#include "lardataobj/RecoBase/SpacePoint.h"
#include "lardataobj/RecoBase/PointCharge.h"

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

// support libraries
#include "messagefacility/MessageLogger/MessageLogger.h"
#include "fhiclcpp/ParameterSet.h"
#include "fhiclcpp/types/Atom.h" // also pulls in fhicl::Name and fhicl::Comment

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


namespace recob {
  
  class DumpChargedSpacePoints: public art::EDAnalyzer {
      public:
    
    struct Config {
      using Name = fhicl::Name;
      using Comment = fhicl::Comment;
      
      fhicl::Atom<art::InputTag> SpacePointTag {
        Name   ("SpacePointLabel"),
        Comment(
          "label of the producer used to create"
          " the recob::SpacePoint collection to be dumped"
          )
        };
      fhicl::Atom<std::string> OutputCategory {
        Name   ("OutputCategory"),
        Comment("the category used for the output (useful for filtering)"),
        "DumpChargedSpacePoints" /* default value */
        };
      
    }; // struct Config
    
    using Parameters = art::EDAnalyzer::Table<Config>;
    
    
    explicit DumpChargedSpacePoints(Parameters const& config); 
    
    virtual void analyze (art::Event const& event) override;

      private:

    art::InputTag fInputTag; 
    std::string fOutputCategory; 
    
  }; // class DumpChargedSpacePoints
  
} // namespace recob


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

//----------------------------------------------------------------------------
recob::DumpChargedSpacePoints::DumpChargedSpacePoints
  (art::EDAnalyzer::Table<Config> const& config)
  : EDAnalyzer(config)
  , fInputTag(config().SpacePointTag())
  , fOutputCategory(config().OutputCategory())
  {}


//----------------------------------------------------------------------------
void recob::DumpChargedSpacePoints::analyze(art::Event const& event) {
  
  //
  // collect all the available information
  //
  // fetch the data to be dumped on screen
  auto const& points = proxy::getChargedSpacePoints(event, fInputTag);
  
  size_t const nPoints = points.size();
  mf::LogVerbatim log(fOutputCategory);
  log
    << "The event " << event.id()
    << " contains " << nPoints
    << " space points from '" << fInputTag.encode() << "'";
  
  for (auto const& point: points) {
    
    log << "\n [#" << point.index() << "] "
      << point.point() << " " << point.charge();
    
  } // for
  
  log << "\n"; // two empty lines
  
} // DumpChargedSpacePoints::analyze()


//----------------------------------------------------------------------------
DEFINE_ART_MODULE(recob::DumpChargedSpacePoints)


//----------------------------------------------------------------------------