DumpSeeds_module.cc

Go to the documentation of this file.

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

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

// support libraries
#include "fhiclcpp/types/Atom.h"
#include "fhiclcpp/types/Table.h"
#include "fhiclcpp/types/Name.h"
#include "fhiclcpp/types/Comment.h"

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

// ... and more in the implementation part

namespace recob {
  
  class DumpSeeds: public art::EDAnalyzer {
      public:
    
    struct Config {
      
      using Name = fhicl::Name;
      using Comment = fhicl::Comment;
      
      fhicl::Atom<art::InputTag> SeedModuleLabel{
        Name("SeedModuleLabel"),
        Comment("tag of the recob::Seed collection data product to be dumped")
        };
      
      fhicl::Atom<std::string> OutputCategory{
        Name("OutputCategory"),
        Comment("name of the message facility category to be used for output"),
        "DumpSeeds"
        };
      
      fhicl::Atom<bool> PrintHexFloats{
        Name("PrintHexFloats"),
        Comment("print all the floating point numbers in base 16"),
        false
        };
      
    }; // struct Config
    
    using Parameters = art::EDAnalyzer::Table<Config>;
    
    explicit DumpSeeds(Parameters const& config); 
    
    virtual void analyze (const art::Event& evt) override;

      private:

    art::InputTag fInputTag; 
    std::string fOutputCategory; 
    bool fPrintHexFloats; 
    
  }; // class DumpSeeds
  
} // namespace recob


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

// LArSoft includes
#include "lardataobj/RecoBase/Seed.h"
#include "lardataobj/RecoBase/Hit.h"

// art libraries
#include "art/Framework/Core/ModuleMacros.h"
#include "canvas/Persistency/Common/FindMany.h"
#include "art/Framework/Principal/Handle.h"

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

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


namespace {
  
  //----------------------------------------------------------------------------
  class SeedDumper {
      public:
         
    struct PrintOptions_t {
       bool hexFloats = false; 
       std::string indent; 
    }; // PrintOptions_t
    
    
    SeedDumper(std::vector<recob::Seed> const& seed_list)
      : SeedDumper(seed_list, {})
      {}
    
    SeedDumper
      (std::vector<recob::Seed> const& seed_list, PrintOptions_t print_options)
      : seeds(seed_list)
      , options(print_options)
      {}
    
    
    void SetHits(art::FindMany<recob::Hit> const* hit_query)
      { hits = hit_query; }
    
    
    template <typename Stream>
    void DumpSeed(Stream&& out, size_t iSeed) const
      {
        lar::OptionalHexFloat hexfloat(options.hexFloats);
        std::string const& indentstr = options.indent;
        
        recob::Seed const& seed = seeds.at(iSeed);
        //
        // intro
        //
        out << "\n" << indentstr
          << "[#" << iSeed << "]";
        if (!seed.IsValid()) out << " invalid!";
        else {
          std::array<double, 3> start, dir;
          seed.GetDirection(dir.data(), nullptr);
          seed.GetPoint(start.data(), nullptr);
          out
            << " starts at (" << hexfloat(start[0])
            << "," << hexfloat(start[1]) << "," << hexfloat(start[2])
            << ") toward (" << hexfloat(dir[0]) << "," << hexfloat(dir[1])
            << "," << hexfloat(dir[2])
            << "); length: " << hexfloat(seed.GetLength()) << " cm"
            ;
        }
        
        //
        // hits
        //
        if (hits) {
          std::vector<recob::Hit const*> myHits = hits->at(iSeed);
          if (!myHits.empty()) {
            // we do not honour the base 16 printout requirement here, because
            // these data members are single precision and there is no printf()
            // flag taking a float as an argument;, and a promotion to double 
            // would silently occurr, which we want to avoid
            out
              << "; " << myHits.size() << " hits:";
            for (recob::Hit const* hit: myHits) {
              out << "\n" << indentstr
                << "  on " << hit->WireID()
                << ", peak at tick " << hit->PeakTime()
                << ", " << hit->PeakAmplitude()
                << " ADC, RMS: " << hit->RMS()
                << " (channel: " << hit->Channel() << ")";
            } // for hits
          } // if we have hits
        } // if we have hit information
        
        //
        // done
        //
        
      } // DumpSeed()
    
    
    template <typename Stream>
    void DumpAllSeeds(Stream&& out) const
      {
        size_t const nSeeds = seeds.size();
        for (size_t iSeed = 0; iSeed < nSeeds; ++iSeed)
          DumpSeed(out, iSeed);
      } // DumpAllSeeds()
    
    
    
      protected:
    std::vector<recob::Seed> const& seeds; 
    
    PrintOptions_t options; 
    
    art::FindMany<recob::Hit> const* hits = nullptr;
    
  }; // SeedDumper
  
  
  //----------------------------------------------------------------------------
  
  
} // local namespace



namespace recob {
  
  //----------------------------------------------------------------------------
  DumpSeeds::DumpSeeds(Parameters const& config) 
    : EDAnalyzer(config)
    , fInputTag(config().SeedModuleLabel())
    , fOutputCategory(config().OutputCategory())
    , fPrintHexFloats(config().PrintHexFloats())
    {}
  
  
  //----------------------------------------------------------------------------
  void DumpSeeds::analyze(const art::Event& evt) {
    
    //
    // collect all the available information
    //
    // fetch the data to be dumped on screen
    auto Seeds = evt.getValidHandle<std::vector<recob::Seed>>(fInputTag);
    
    art::FindMany<recob::Hit> const SeedHits(Seeds, evt, fInputTag);
    
    size_t const nSeeds = Seeds->size();
    mf::LogVerbatim(fOutputCategory) << "Event " << evt.id()
      << " contains " << nSeeds << " seeds from '"
      << fInputTag.encode() << "'";
    
    // prepare the dumper
    SeedDumper::PrintOptions_t options;
    options.hexFloats = fPrintHexFloats;
    options.indent = "  ";
    SeedDumper dumper(*Seeds, options);
    
    if (SeedHits.isValid()) dumper.SetHits(&SeedHits);
    else mf::LogWarning("DumpSeeds") << "hit information not avaialble";
    
    dumper.DumpAllSeeds(mf::LogVerbatim(fOutputCategory));
    
    mf::LogVerbatim(fOutputCategory) << "\n"; // two empty lines
    
  } // DumpSeeds::analyze()

  DEFINE_ART_MODULE(DumpSeeds)

} // namespace recob