DetectorClocks.h

Go to the documentation of this file.

#ifndef LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H
#define LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H

#include "lardataalg/DetectorInfo/ElecClock.h"

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


namespace detinfo{

  enum InheritConfigType_t {
    kG4RefTime=0,
    kTriggerOffsetTPC,
    kFramePeriod,
    kClockSpeedTPC,
    kClockSpeedOptical,
    kClockSpeedTrigger,
    kClockSpeedExternal,
    kDefaultTrigTime,
    kDefaultBeamTime,
    kInheritConfigTypeMax
  };

  class DetectorClocks {

  public:
    DetectorClocks(const DetectorClocks &) = delete;
    DetectorClocks(DetectorClocks &&) = delete;
    DetectorClocks& operator = (const DetectorClocks &) = delete;
    DetectorClocks& operator = (DetectorClocks &&) = delete;
    virtual ~DetectorClocks() = default;
    
    // --- BEGIN Configuration information -------------------------------------
    
    virtual std::vector<std::string> ConfigNames() const = 0;
    
    virtual std::vector<double> ConfigValues() const = 0;

    // --- END Configuration information ---------------------------------------
    
    
    
    // --- BEGIN Time points and intervals -------------------------------------
    
    virtual double TriggerOffsetTPC() const = 0;
    
    virtual double TriggerTime() const = 0;
    
    virtual double TPCTime() const = 0;
    
    virtual double BeamGateTime() const = 0;
    
    
    // --- END Time points and intervals ---------------------------------------
    
    
    
    // --- BEGIN Time conversions ----------------------------------------------
    
    virtual double G4ToElecTime(double g4_time) const = 0;
    
    //
    // Getters for time [us] w.r.t. trigger given information from waveform
    //

    virtual double TPCTick2TrigTime(double tick) const = 0;
    virtual double TPCTick2BeamTime(double tick) const = 0;
    
    
    // --- END Time conversions ------------------------------------------------
    
    
    
    // --- BEGIN Electronics clocks --------------------------------------------

    //
    // Getters of TPC ElecClock
    //
    virtual const ::detinfo::ElecClock& TPCClock() const = 0;
    
    virtual ::detinfo::ElecClock TPCClock(double time) const = 0; 
    
    virtual detinfo::ElecClock TPCClock(unsigned int sample,unsigned int frame) const = 0;
    
    
    //
    // Getters of Optical ElecClock
    //
    virtual const detinfo::ElecClock& OpticalClock() const = 0;
    
    virtual detinfo::ElecClock OpticalClock(double time) const = 0;
    
    virtual detinfo::ElecClock OpticalClock(unsigned int sample, unsigned int frame) const = 0;
    
    
    //
    // Getters of Trigger ElecClock
    //
    virtual const detinfo::ElecClock& TriggerClock() const = 0;
    
    virtual detinfo::ElecClock TriggerClock(double time) const = 0;
    
    virtual detinfo::ElecClock TriggerClock(unsigned int sample, unsigned int frame) const = 0;
    
    
    //
    // Getters of External ElecClock
    //
    virtual const detinfo::ElecClock& ExternalClock() const = 0;

    virtual detinfo::ElecClock ExternalClock(double time) const = 0;
    
    virtual detinfo::ElecClock ExternalClock(unsigned int sample, unsigned int frame) const = 0;
    
    // --- END Electronics clocks ----------------------------------------------
    
    
    // --- BEGIN Conversions from electronics time -----------------------------

    virtual double Time2Tick(double time) const = 0; 
    
    // --- END Conversions from electronics time -------------------------------
    
    
    // --- BEGIN Conversions from electronics waveform ticks -------------------


    virtual double TPCTDC2Tick(double tdc) const = 0;

    virtual double TPCTick2TDC(double tick) const = 0;
    
    virtual double TPCTick2Time(double tick) const = 0;
    
    
    virtual double OpticalTick2TrigTime(double tick, size_t sample, size_t frame) const = 0;

    virtual double OpticalTick2BeamTime(double tick, size_t sample, size_t frame) const = 0;
    
    virtual double OpticalTick2TDC(double tick, size_t sample, size_t frame) const = 0;
    
    virtual double OpticalTick2Time(double tick, size_t sample, size_t frame) const = 0;
    
    
    virtual double ExternalTick2TrigTime(double tick, size_t sample, size_t frame) const = 0;

    virtual double ExternalTick2BeamTime(double tick, size_t sample, size_t frame) const = 0;
    

    virtual double ExternalTick2TDC(double tick, size_t sample, size_t frame) const = 0;
    
    virtual double ExternalTick2Time(double tick, size_t sample, size_t frame) const = 0;
    
    // --- END Conversions from electronics waveform ticks ---------------------
    
    
    
    // --- BEGIN Conversions to electronics waveform ticks ---------------------

    virtual double TPCG4Time2TDC(double g4time) const = 0;
    
    virtual double TPCG4Time2Tick(double g4time) const = 0;
    
    
    virtual double OpticalG4Time2TDC(double g4time) const = 0;
    
    virtual double ExternalG4Time2TDC(double g4time) const = 0;

    // --- END Conversions to electronics waveform ticks ---------------------
    
    
    protected:
      DetectorClocks() = default;

  }; // class DetectorClocks

} //namespace detinfo


#endif // LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H