Public Member Functions | Protected Member Functions | List of all members
gar::detinfo::DetectorClocks Class Referenceabstract

#include <DetectorClocks.h>

Inheritance diagram for gar::detinfo::DetectorClocks:
gar::detinfo::DetectorClocksStandardGAr

Public Member Functions

 DetectorClocks (const DetectorClocks &)=delete
 
 DetectorClocks (DetectorClocks &&)=delete
 
DetectorClocksoperator= (const DetectorClocks &)=delete
 
DetectorClocksoperator= (DetectorClocks &&)=delete
 
virtual ~DetectorClocks ()=default
 
virtual double TriggerOffsetTPC () const =0
 
virtual double G4ToElecTime (double g4_time) const =0
 Given Geant4 time [ns], returns relative time [ns] w.r.t. electronics time T0. More...
 
virtual double TriggerTime () const =0
 Trigger electronics clock time in [ns]. More...
 
virtual double BeamGateTime () const =0
 Beam gate electronics clock time in [ns]. More...
 
virtual double SpillLength () const =0
 Duration of spill [ns]. More...
 
virtual std::vector< std::stringConfigNames () const =0
 
virtual std::vector< double > ConfigValues () const =0
 
virtual const ElecClockTPCClock () const =0
 Borrow a const TPC clock with time set to Trigger time [ns]. More...
 
virtual ElecClock TPCClock (double time) const =0
 Create a TPC clock for a given time [ns] from clock counting start. More...
 
virtual ElecClock TPCClock (unsigned int sample, unsigned int frame) const =0
 Create a TPC clock for a given sample/frame number in TPC clock frequency. More...
 
virtual const detinfo::ElecClockTriggerClock () const =0
 Borrow a const Trigger clock with time set to Trigger time [ns]. More...
 
virtual detinfo::ElecClock TriggerClock (double time) const =0
 Create a Trigger clock for a given time [ns] from clock counting start. More...
 
virtual detinfo::ElecClock TriggerClock (unsigned int sample, unsigned int frame) const =0
 Create a Trigger clock for a given sample/frame number in Trigger clock frequency. More...
 
virtual const detinfo::ElecClockExternalClock () const =0
 Borrow a const Trigger clock with time set to External Time [ns]. More...
 
virtual detinfo::ElecClock ExternalClock (double time) const =0
 Create a External clock for a given time [ns] from clock counting start. More...
 
virtual detinfo::ElecClock ExternalClock (unsigned int sample, unsigned int frame) const =0
 Create a External clock for a given sample/frame number in External clock frequency. More...
 
virtual double TPCTick2TrigTime (double tick) const =0
 Given TPC time-tick (waveform index), returns time [ns] w.r.t. trigger time stamp. More...
 
virtual double TPCTick2BeamTime (double tick) const =0
 Given TPC time-tick (waveform index), returns time [ns] w.r.t. beam gate time. More...
 
virtual double ExternalTick2TrigTime (double tick, size_t sample, size_t frame) const =0
 Given External time-tick (waveform index), sample and frame number, returns time [ns] w.r.t. trigger time stamp. More...
 
virtual double ExternalTick2BeamTime (double tick, size_t sample, size_t frame) const =0
 Given External time-tick (waveform index), sample and frame number, returns time [ns] w.r.t. beam gate time stamp. More...
 
virtual double TPCTick2TDC (double tick) const =0
 Given TPC time-tick (waveform index), returns electronics clock count [tdc]. More...
 
virtual double TPCG4Time2TDC (double g4time) const =0
 Given G4 time [ns], returns corresponding TPC electronics clock count [tdc]. More...
 
virtual double ExternalTick2TDC (double tick, size_t sample, size_t frame) const =0
 Given External time-tick (waveform index), sample and frame number, returns time electronics clock count [tdc]. More...
 
virtual double ExternalG4Time2TDC (double g4time) const =0
 Given G4 time [ns], returns corresponding External electronics clock count [tdc]. More...
 
virtual double TPCTick2Time (double tick) const =0
 Given TPC time-tick (waveform index), returns electronics clock [ns]. More...
 
virtual double ExternalTick2Time (double tick, size_t sample, size_t frame) const =0
 Given External time-tick (waveform index), sample and frame number, returns electronics clock [ns]. More...
 
virtual double TPCTDC2Tick (double tdc) const =0
 Given electronics clock count [tdc] returns TPC time-tick. More...
 
virtual double TPCG4Time2Tick (double g4time) const =0
 Given G4 time returns electronics clock count [tdc]. More...
 

Protected Member Functions

 DetectorClocks ()=default
 

Detailed Description

Definition at line 30 of file DetectorClocks.h.

Constructor & Destructor Documentation

gar::detinfo::DetectorClocks::DetectorClocks ( const DetectorClocks )
delete
gar::detinfo::DetectorClocks::DetectorClocks ( DetectorClocks &&  )
delete
virtual gar::detinfo::DetectorClocks::~DetectorClocks ( )
virtualdefault
gar::detinfo::DetectorClocks::DetectorClocks ( )
protecteddefault

Member Function Documentation

virtual double gar::detinfo::DetectorClocks::BeamGateTime ( ) const
pure virtual

Beam gate electronics clock time in [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual std::vector<std::string> gar::detinfo::DetectorClocks::ConfigNames ( ) const
pure virtual
virtual std::vector<double> gar::detinfo::DetectorClocks::ConfigValues ( ) const
pure virtual
virtual const detinfo::ElecClock& gar::detinfo::DetectorClocks::ExternalClock ( ) const
pure virtual

Borrow a const Trigger clock with time set to External Time [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual detinfo::ElecClock gar::detinfo::DetectorClocks::ExternalClock ( double  time) const
pure virtual

Create a External clock for a given time [ns] from clock counting start.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual detinfo::ElecClock gar::detinfo::DetectorClocks::ExternalClock ( unsigned int  sample,
unsigned int  frame 
) const
pure virtual

Create a External clock for a given sample/frame number in External clock frequency.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::ExternalG4Time2TDC ( double  g4time) const
pure virtual

Given G4 time [ns], returns corresponding External electronics clock count [tdc].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::ExternalTick2BeamTime ( double  tick,
size_t  sample,
size_t  frame 
) const
pure virtual

Given External time-tick (waveform index), sample and frame number, returns time [ns] w.r.t. beam gate time stamp.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::ExternalTick2TDC ( double  tick,
size_t  sample,
size_t  frame 
) const
pure virtual

Given External time-tick (waveform index), sample and frame number, returns time electronics clock count [tdc].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::ExternalTick2Time ( double  tick,
size_t  sample,
size_t  frame 
) const
pure virtual

Given External time-tick (waveform index), sample and frame number, returns electronics clock [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::ExternalTick2TrigTime ( double  tick,
size_t  sample,
size_t  frame 
) const
pure virtual

Given External time-tick (waveform index), sample and frame number, returns time [ns] w.r.t. trigger time stamp.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::G4ToElecTime ( double  g4_time) const
pure virtual

Given Geant4 time [ns], returns relative time [ns] w.r.t. electronics time T0.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

DetectorClocks& gar::detinfo::DetectorClocks::operator= ( const DetectorClocks )
delete
DetectorClocks& gar::detinfo::DetectorClocks::operator= ( DetectorClocks &&  )
delete
virtual double gar::detinfo::DetectorClocks::SpillLength ( ) const
pure virtual

Duration of spill [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual const ElecClock& gar::detinfo::DetectorClocks::TPCClock ( ) const
pure virtual

Borrow a const TPC clock with time set to Trigger time [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual ElecClock gar::detinfo::DetectorClocks::TPCClock ( double  time) const
pure virtual

Create a TPC clock for a given time [ns] from clock counting start.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual ElecClock gar::detinfo::DetectorClocks::TPCClock ( unsigned int  sample,
unsigned int  frame 
) const
pure virtual

Create a TPC clock for a given sample/frame number in TPC clock frequency.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCG4Time2TDC ( double  g4time) const
pure virtual

Given G4 time [ns], returns corresponding TPC electronics clock count [tdc].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCG4Time2Tick ( double  g4time) const
pure virtual

Given G4 time returns electronics clock count [tdc].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCTDC2Tick ( double  tdc) const
pure virtual

Given electronics clock count [tdc] returns TPC time-tick.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCTick2BeamTime ( double  tick) const
pure virtual

Given TPC time-tick (waveform index), returns time [ns] w.r.t. beam gate time.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCTick2TDC ( double  tick) const
pure virtual

Given TPC time-tick (waveform index), returns electronics clock count [tdc].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCTick2Time ( double  tick) const
pure virtual

Given TPC time-tick (waveform index), returns electronics clock [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TPCTick2TrigTime ( double  tick) const
pure virtual

Given TPC time-tick (waveform index), returns time [ns] w.r.t. trigger time stamp.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual const detinfo::ElecClock& gar::detinfo::DetectorClocks::TriggerClock ( ) const
pure virtual

Borrow a const Trigger clock with time set to Trigger time [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual detinfo::ElecClock gar::detinfo::DetectorClocks::TriggerClock ( double  time) const
pure virtual

Create a Trigger clock for a given time [ns] from clock counting start.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual detinfo::ElecClock gar::detinfo::DetectorClocks::TriggerClock ( unsigned int  sample,
unsigned int  frame 
) const
pure virtual

Create a Trigger clock for a given sample/frame number in Trigger clock frequency.

Implemented in gar::detinfo::DetectorClocksStandardGAr.

virtual double gar::detinfo::DetectorClocks::TriggerOffsetTPC ( ) const
pure virtual
virtual double gar::detinfo::DetectorClocks::TriggerTime ( ) const
pure virtual

Trigger electronics clock time in [ns].

Implemented in gar::detinfo::DetectorClocksStandardGAr.


The documentation for this class was generated from the following file: