TpcToolBasedRawDigitPrepService.h

Go to the documentation of this file.

// TpcToolBasedRawDigitPrepService.h
//
// David Adams
// April 2018
//
// Implementation of service that prepares TPC raw digits for reconstruction.
// It receives an ADC channel data map, applies a sequence of ADC channel
// tools (calling updateMap) and then constructs wires.
//
// There is an option to list tools for which callgrind should collect statistics.
// If any tools are listed, callgrind should be invoked with "--collect-atstart=no".
// Otherwise, callgrind will be disabled when those tools are run.
//
// Confguration parameters.
//   LogLevel - logging level
//              0 - errors only
//              1 - initilization information including configuration
//              2 - one line per processed map
//              3 - one line for each step (tool call)
//              4 - display result from each step
//   DoWires - If true, the wire building service is called after processing.
//   ToolNames - Names of the TpcData tools.
//   CallgrindToolNames - Names of the tools for which callgrind should be enabled.

#ifndef TpcToolBasedRawDigitPrepService_H
#define TpcToolBasedRawDigitPrepService_H

#include "dunecore/DuneInterface/Service/RawDigitPrepService.h"
#include "dunecore/DuneInterface/Tool/TpcDataTool.h"
#include <map>
#include <chrono>

class AdcWireBuildingService;
class AdcChannelDataCopyService;

class TpcToolBasedRawDigitPrepService : public RawDigitPrepService {

public:

  using Index = unsigned int;
  using TpcDataToolPtr = std::unique_ptr<TpcDataTool>;
  struct NamedTool {
    std::string name;
    const TpcDataTool* tool;
    NamedTool(std::string a_name ="", const TpcDataTool* a_tool =nullptr) : name(a_name), tool(a_tool) { }
  };
  using TpcDataToolVector = std::vector<TpcDataToolPtr>;
  using TpcDataNamedToolVector = std::vector<NamedTool>;

  TpcToolBasedRawDigitPrepService(fhicl::ParameterSet const& pset, art::ActivityRegistry&);
  ~TpcToolBasedRawDigitPrepService();

  // Called at begin and end of event processing.
  // Calls the same method for each tool.
  int beginEvent(const DuneEventInfo& devt) const override;
  int endEvent(const DuneEventInfo& devt) const override;

  int prepare(detinfo::DetectorClocksData const& clockData,
              AdcChannelDataMap& prepdigs,
              std::vector<recob::Wire>* pwires,
              WiredAdcChannelDataMap* pintStates) const override;

  std::ostream& print(std::ostream& out =std::cout, std::string prefix ="") const override;

private:

  // Configuration parameters.
  int m_LogLevel;
  bool m_DoWires;
  std::vector<std::string> m_ToolNames;
  std::vector<std::string> m_CallgrindToolNames;

  TpcDataToolVector m_TpcDataTools;
  TpcDataNamedToolVector m_TpcDataNamedTools;
  const AdcWireBuildingService* m_pWireBuildingService;
  std::set<std::string> m_cgset;

  using Clock = std::chrono::steady_clock;
  using Duration = std::chrono::duration<double>;
  class State {
  public:
    Index nevtBegin = 0;
    Index nevtEnd = 0;
    Index ncall = 0;
    // Timing.
    std::vector<Duration> toolTimes;
  };
  std::unique_ptr<State> m_pstate;
  State& state() const { return *m_pstate; }

};

DECLARE_ART_SERVICE_INTERFACE_IMPL(TpcToolBasedRawDigitPrepService, RawDigitPrepService, LEGACY)

#endif