detinfo::DetectorClocksStandard Class Reference

Implementation of detinfo::DetectorClocks interface with fixed settings from configuration. More...

#include "DetectorClocksStandard.h"

Inheritance diagram for detinfo::DetectorClocksStandard:

Public Member Functions
	DetectorClocksStandard ()
	DetectorClocksStandard (fhicl::ParameterSet const &pset)
	DetectorClocksStandard (DetectorClocksStandard const &)=delete
virtual	~DetectorClocksStandard ()
bool	Configure (fhicl::ParameterSet const &pset)
bool	Update (uint64_t ts=0)
virtual double	TriggerOffsetTPC () const override
virtual double	TPCTime () const override
	Returns the TPC electronics start time in electronics time. More...
void	debugReport () const
std::string	TrigModuleName () const
	Returns the input tag of the trigger data product. More...
void	SetDefaultTriggerTime ()
	Sets trigger and beam gate time from default configuration values. More...
virtual double	G4ToElecTime (double g4_time) const override
	Given Geant4 time [ns], returns relative time [us] w.r.t. electronics time T0. More...
virtual double	TriggerTime () const override
	Trigger electronics clock time in [us]. More...
virtual double	BeamGateTime () const override
	Beam gate electronics clock time in [us]. More...
virtual std::vector< std::string >	ConfigNames () const override
virtual std::vector< double >	ConfigValues () const override
void	SetConfigValue (size_t i, double val)
virtual void	SetTriggerTime (double trig_time, double beam_time)
	Setter for trigger times. More...
virtual const ::detinfo::ElecClock &	TPCClock () const override
	Borrow a const TPC clock with time set to Trigger time [us]. More...
virtual ::detinfo::ElecClock	TPCClock (double time) const override
	Create a TPC clock for a given time [us] from clock counting start. More...
detinfo::ElecClock	TPCClock (unsigned int sample, unsigned int frame) const override
	Create a TPC clock for a given sample/frame number in TPC clock frequency. More...
virtual const detinfo::ElecClock &	OpticalClock () const override
	Borrow a const Optical clock with time set to Trigger time [us]. More...
virtual detinfo::ElecClock	OpticalClock (double time) const override
	Create a Optical clock for a given time [us] from clock counting start. More...
virtual detinfo::ElecClock	OpticalClock (unsigned int sample, unsigned int frame) const override
	Create a Optical clock for a given sample/frame number in Optical clock frequency. More...
virtual const detinfo::ElecClock &	TriggerClock () const override
	Borrow a const Trigger clock with time set to Trigger time [us]. More...
virtual detinfo::ElecClock	TriggerClock (double time) const override
	Create a Trigger clock for a given time [us] from clock counting start. More...
virtual detinfo::ElecClock	TriggerClock (unsigned int sample, unsigned int frame) const override
	Create a Trigger clock for a given sample/frame number in Trigger clock frequency. More...
virtual const detinfo::ElecClock &	ExternalClock () const override
	Borrow a const Trigger clock with time set to External Time [us]. More...
virtual detinfo::ElecClock	ExternalClock (double time) const override
virtual detinfo::ElecClock	ExternalClock (unsigned int sample, unsigned int frame) const override
	Create a External clock for a given sample/frame number in External clock frequency. More...
virtual double	TPCTick2TrigTime (double tick) const override
	Given TPC time-tick (waveform index), returns time [us] w.r.t. trigger time stamp. More...
virtual double	TPCTick2BeamTime (double tick) const override
	Given TPC time-tick (waveform index), returns time [us] w.r.t. beam gate time. More...
virtual double	OpticalTick2TrigTime (double tick, size_t sample, size_t frame) const override
	Given Optical time-tick (waveform index), sample and frame number, returns time [us] w.r.t. trigger time stamp. More...
virtual double	OpticalTick2BeamTime (double tick, size_t sample, size_t frame) const override
	Given Optical time-tick (waveform index), sample and frame number, returns time [us] w.r.t. beam gate time stamp. More...
virtual double	ExternalTick2TrigTime (double tick, size_t sample, size_t frame) const override
	Given External time-tick (waveform index), sample and frame number, returns time [us] w.r.t. trigger time stamp. More...
virtual double	ExternalTick2BeamTime (double tick, size_t sample, size_t frame) const override
	Given External time-tick (waveform index), sample and frame number, returns time [us] w.r.t. beam gate time stamp. More...
virtual double	TPCTick2TDC (double tick) const override
	Given TPC time-tick (waveform index), returns electronics clock count [tdc]. More...
virtual double	TPCG4Time2TDC (double g4time) const override
	Given G4 time [ns], returns corresponding TPC electronics clock count [tdc]. More...
virtual double	OpticalTick2TDC (double tick, size_t sample, size_t frame) const override
	Given Optical time-tick (waveform index), sample and frame number, returns time electronics clock count [tdc]. More...
virtual double	OpticalG4Time2TDC (double g4time) const override
	Given G4 time [ns], returns corresponding Optical electronics clock count [tdc]. More...
virtual double	ExternalTick2TDC (double tick, size_t sample, size_t frame) const override
	Given External time-tick (waveform index), sample and frame number, returns time electronics clock count [tdc]. More...
virtual double	ExternalG4Time2TDC (double g4time) const override
	Given G4 time [ns], returns corresponding External electronics clock count [tdc]. More...
virtual double	TPCTick2Time (double tick) const override
	Given TPC time-tick (waveform index), returns electronics clock [us]. More...
virtual double	OpticalTick2Time (double tick, size_t sample, size_t frame) const override
	Given Optical time-tick (waveform index), sample and frame number, returns electronics clock [us]. More...
virtual double	ExternalTick2Time (double tick, size_t sample, size_t frame) const override
	Given External time-tick (waveform index), sample and frame number, returns electronics clock [us]. More...
virtual double	TPCTDC2Tick (double tdc) const override
	Given electronics clock count [tdc] returns TPC time-tick. More...
virtual double	TPCG4Time2Tick (double g4time) const override
	Given G4 time returns electronics clock count [tdc]. More...
bool	InheritClockConfig ()
void	ApplyParams ()
	Internal function to apply loaded parameters to member attributes. More...
bool	IsRightConfig (const fhicl::ParameterSet &ps) const
	Internal function used to search for the right configuration set in the data file. More...

Protected Member Functions
double	doTPCTime () const
	Implementation of TPCTime(). More...

Protected Attributes
std::vector< std::string >	fConfigName
std::vector< double >	fConfigValue
bool	fInheritClockConfig
std::string	fTrigModuleName
double	fG4RefTime
	Electronics clock counting start time in G4 time frame [us]. More...
double	fFramePeriod
	Frame period. More...
::detinfo::ElecClock	fTPCClock
	TPC clock. More...
::detinfo::ElecClock	fOpticalClock
	Optical clock. More...
::detinfo::ElecClock	fTriggerClock
	Trigger clock. More...
::detinfo::ElecClock	fExternalClock
	External clock. More...
double	fTriggerOffsetTPC
	Time offset from trigger to TPC readout start. More...
double	fTriggerTime
	Trigger time in [us]. More...
double	fBeamGateTime
	BeamGate time in [us]. More...

Detailed Description

Implementation of detinfo::DetectorClocks interface with fixed settings from configuration.

In this implementation, all quantities are defined at configuration time and are unchanged for the duration of the entire job, with the exception of the trigger time (see below).

Configuration parameters

All configuration parameters are mandatory, unless explicitly stated.

• G4RefTime (nanoseconds): simulation (Geant4) start time in electronics time scale, i.e. when time 0.0 of simulation happens in the electronics time scale

• TriggerOffsetTPC: time elapsed between the start of the TPC readout clock and the hardware trigger; it can be expressed in one of two ways:

  • negative number [µs]: the offset of the start of the TPC readout clock start respect to the trigger time (where negative means that the clock starts before the trigger arrives)
  • positive number [ticks]: the number of TPC readout clock tick at which the trigger arrives; despite this being a tick number, it can be fractional for added precision

  For example, TriggerOffsetTPC of -1600.0 means that the TDC clock starts 1.6 milliseconds before the hardware trigger. TriggerOffsetTPC of 3200.0 means that the trigger arrives at the exact start of tick 3200 of the TPC readout. In this example, if the sampling frequency of that readout is 2 MHz, these two settings are equivalent.

• FramePeriod (microseconds): duration of an electronics clock frame; all clocks share the same frame period
• ClockSpeedTPC (megahertz): frequency of the TPC electronics clock
• ClockSpeedOptical (megahertz): frequency of the optical electronics clock
• ClockSpeedTrigger (megahertz): frequency of the trigger electronics clock
• ClockSpeedExternal (megahertz): frequency of the external electronics clock
• DefaultTrigTime (microseconds): the default hardware trigger time, measured in the electronics time frame
• DefaultBeamTime (microseconds): the default beam gate opening time, measured in the electronics time frame
• TrigModuleName (string): input tag for the trigger data product (see "Trigger time" section below)
• InheritClockConfig (boolean): whether to inherit the configuration from previous jobs (see "Consistency check" below)

Consistency check

The consistency check feature verifies that the current configuration of detinfo::DetectorClocksStandard is compatible with the one from previous jobs. It is expected that when this feature is enabled (InheritClockConfig is configured to be true), either the configuration is overridden to follow the previous ones, or an exception is thrown in case of inconsistency.

The service provider (detinfo::DetectorClocksStandard) does not provide a facility to inherit configuration from a previous job, but it stores the expectation whether this should happen (InheritClockConfig()). The service provider manager is in charge of implementing this feature (see detinfo::DetectorClocksStandardService for the manager in the art environment).

Timing specifics

For the general timing requirements, see the documentation of detinfo::DetectorClocks.

Trigger time

In this implementation, the trigger time and the beam gate time both default to 0.0 µs.

The manager of this provider is expected to set those values by calling detinfo::DetectorClocksStandard::SetTriggerTime(). See detinfo::DetectorClocksStandardService for the manager in the art environment.

Bug:

ExternalClock() clock is never initialized!

Definition at line 117 of file DetectorClocksStandard.h.

Constructor & Destructor Documentation

detinfo::DetectorClocksStandard::DetectorClocksStandard

(

)

Definition at line 4 of file DetectorClocksStandard.cxx.

References fConfigName, detinfo::kClockSpeedExternal, detinfo::kClockSpeedOptical, detinfo::kClockSpeedTPC, detinfo::kClockSpeedTrigger, detinfo::kDefaultBeamTime, detinfo::kDefaultTrigTime, detinfo::kFramePeriod, detinfo::kG4RefTime, and detinfo::kTriggerOffsetTPC.

  : fConfigName(detinfo::kInheritConfigTypeMax,""),
    fConfigValue(detinfo::kInheritConfigTypeMax,0),
    fInheritClockConfig(false),
    fTrigModuleName(""),
    fG4RefTime    (detinfo::kDEFAULT_MC_CLOCK_T0),
    fFramePeriod  (detinfo::kDEFAULT_FRAME_PERIOD),
    fTPCClock     (0,detinfo::kDEFAULT_FRAME_PERIOD,detinfo::kDEFAULT_FREQUENCY_TPC),
    fOpticalClock (0,detinfo::kDEFAULT_FRAME_PERIOD,detinfo::kDEFAULT_FREQUENCY_OPTICAL),
    fTriggerClock (0,detinfo::kDEFAULT_FRAME_PERIOD,detinfo::kDEFAULT_FREQUENCY_TRIGGER),
    fExternalClock(0,detinfo::kDEFAULT_FRAME_PERIOD,detinfo::kDEFAULT_FREQUENCY_EXTERNAL),
    fTriggerOffsetTPC     (detinfo::kDEFAULT_TRIG_OFFSET_TPC),
    fTriggerTime(detinfo::kDEFAULT_TRIG_TIME),
    fBeamGateTime(detinfo::kDEFAULT_BEAM_TIME)
{
  
  fConfigName.at(detinfo::kG4RefTime)         = "G4RefTime";
  fConfigName.at(detinfo::kTriggerOffsetTPC)  = "TriggerOffsetTPC";
  fConfigName.at(detinfo::kFramePeriod)       = "FramePeriod";
  fConfigName.at(detinfo::kClockSpeedTPC)     = "ClockSpeedTPC";
  fConfigName.at(detinfo::kClockSpeedOptical) = "ClockSpeedOptical";
  fConfigName.at(detinfo::kClockSpeedTrigger) = "ClockSpeedTrigger";
  fConfigName.at(detinfo::kClockSpeedExternal) = "ClockSpeedExternal";
  fConfigName.at(detinfo::kDefaultTrigTime)   = "DefaultTrigTime";
  fConfigName.at(detinfo::kDefaultBeamTime)   = "DefaultBeamTime";
}

detinfo::DetectorClocksStandard::DetectorClocksStandard

(

fhicl::ParameterSet const &

pset

)

Definition at line 32 of file DetectorClocksStandard.cxx.

References Configure().

  : DetectorClocksStandard()
{
  // In a constructor, the version of virtual method that is called
  // is always the one specific of the class being constructed
  // (the one mentioned in the name of the constructor itself).
  // For clarity, we explicitly show that:
  DetectorClocksStandard::Configure(pset);

}

detinfo::DetectorClocksStandard::DetectorClocksStandard ( DetectorClocksStandard const &  )

delete

virtual detinfo::DetectorClocksStandard::~DetectorClocksStandard ( )

inlinevirtual

Definition at line 123 of file DetectorClocksStandard.h.

References Configure(), and Update().

{};

Member Function Documentation

void detinfo::DetectorClocksStandard::ApplyParams

(

)

Internal function to apply loaded parameters to member attributes.

Definition at line 72 of file DetectorClocksStandard.cxx.

References fBeamGateTime, fConfigValue, fFramePeriod, fG4RefTime, fOpticalClock, fTPCClock, fTriggerClock, fTriggerOffsetTPC, fTriggerTime, detinfo::kClockSpeedOptical, detinfo::kClockSpeedTPC, detinfo::kClockSpeedTrigger, detinfo::kDefaultBeamTime, detinfo::kDefaultTrigTime, detinfo::kFramePeriod, detinfo::kG4RefTime, and detinfo::kTriggerOffsetTPC.

Referenced by Configure(), and InheritClockConfig().

{

  fG4RefTime   = fConfigValue.at(kG4RefTime);
  fFramePeriod = fConfigValue.at(kFramePeriod);
  fTPCClock     = detinfo::ElecClock( fTriggerTime, fFramePeriod, fConfigValue.at( kClockSpeedTPC     ) );
  fOpticalClock = detinfo::ElecClock( fTriggerTime, fFramePeriod, fConfigValue.at( kClockSpeedOptical ) );
  fTriggerClock = detinfo::ElecClock( fTriggerTime, fFramePeriod, fConfigValue.at( kClockSpeedTrigger ) );
  // FIXME: fExternalClock is not initialized!!!
  fTriggerOffsetTPC = fConfigValue.at(kTriggerOffsetTPC);
  fTriggerTime = fConfigValue[detinfo::kDefaultTrigTime];
  fBeamGateTime = fConfigValue[detinfo::kDefaultBeamTime];
}

virtual double detinfo::DetectorClocksStandard::BeamGateTime ( ) const

inlineoverridevirtual

Beam gate electronics clock time in [us].

Implements detinfo::DetectorClocks.

Definition at line 165 of file DetectorClocksStandard.h.

References fBeamGateTime.

Referenced by ExternalTick2BeamTime(), OpticalTick2BeamTime(), and TPCTick2BeamTime().

{ return fBeamGateTime; }

virtual std::vector<std::string> detinfo::DetectorClocksStandard::ConfigNames ( ) const

inlineoverridevirtual

Returns a list of provider configuration names.

See also

ConfigValues()

Implements detinfo::DetectorClocks.

Definition at line 167 of file DetectorClocksStandard.h.

References fConfigName.

{ return fConfigName; }

bool detinfo::DetectorClocksStandard::Configure

(

fhicl::ParameterSet const &

pset

)

Definition at line 51 of file DetectorClocksStandard.cxx.

References ApplyParams(), fConfigName, fConfigValue, fInheritClockConfig, fTrigModuleName, fhicl::ParameterSet::get(), detinfo::kClockSpeedExternal, detinfo::kClockSpeedOptical, detinfo::kClockSpeedTPC, detinfo::kClockSpeedTrigger, detinfo::kDefaultBeamTime, detinfo::kDefaultTrigTime, detinfo::kFramePeriod, detinfo::kG4RefTime, detinfo::kTriggerOffsetTPC, and SetDefaultTriggerTime().

Referenced by DetectorClocksStandard(), and ~DetectorClocksStandard().

{

  // Read fcl parameters
  fInheritClockConfig                 = pset.get< bool >( "InheritClockConfig" );
  fTrigModuleName                     = pset.get< std::string >( "TrigModuleName" );
  fConfigValue.at(kG4RefTime)         = pset.get< double >( fConfigName.at(kG4RefTime).c_str() );
  fConfigValue.at(kFramePeriod)       = pset.get< double >( fConfigName.at(kFramePeriod).c_str() );
  fConfigValue.at(kTriggerOffsetTPC)  = pset.get< double >( fConfigName.at(kTriggerOffsetTPC).c_str());
  fConfigValue.at(kClockSpeedTPC)     = pset.get< double >( fConfigName.at(kClockSpeedTPC).c_str() );
  fConfigValue.at(kClockSpeedOptical) = pset.get< double >( fConfigName.at(kClockSpeedOptical).c_str());
  fConfigValue.at(kClockSpeedTrigger) = pset.get< double >( fConfigName.at(kClockSpeedTrigger).c_str() );
  fConfigValue.at(kClockSpeedExternal)= pset.get< double >( fConfigName.at(kClockSpeedExternal).c_str());
  fConfigValue.at(kDefaultTrigTime)   = pset.get< double >( fConfigName.at(kDefaultTrigTime).c_str() );
  fConfigValue.at(kDefaultBeamTime)   = pset.get< double >( fConfigName.at(kDefaultBeamTime).c_str() );
  ApplyParams();
  SetDefaultTriggerTime();
  return true;
}

virtual std::vector<double> detinfo::DetectorClocksStandard::ConfigValues ( ) const

inlineoverridevirtual

Returns a list of provider configuration values (same order as ConfigNames()).

See also

ConfigNames()

Implements detinfo::DetectorClocks.

Definition at line 168 of file DetectorClocksStandard.h.

References fConfigValue.

Referenced by SetDefaultTriggerTime().

{ return fConfigValue; }

void detinfo::DetectorClocksStandard::debugReport

(

)

const

Definition at line 104 of file DetectorClocksStandard.cxx.

References fBeamGateTime, fConfigName, fConfigValue, fExternalClock, fG4RefTime, fOpticalClock, detinfo::ElecClock::Frequency(), fTPCClock, fTriggerClock, fTriggerTime, detinfo::kInheritConfigTypeMax, TPCG4Time2Tick(), TPCTDC2Tick(), TPCTick2BeamTime(), TPCTick2TDC(), TPCTick2TrigTime(), and TriggerOffsetTPC().

Referenced by TPCTime().

{
  std::cout << "fConfigValues contents: "<<std::endl;
  for(size_t i=0;i<kInheritConfigTypeMax; ++i)

    std::cout<<"    "<<fConfigName.at(i).c_str()<<" ... "<<fConfigValue.at(i)<<std::endl;

  std::cout<<std::endl;
  
  std::cout 
    << "Trigger  time @ " << fTriggerTime       << std::endl
    << "BeamGate time @ " << fBeamGateTime      << std::endl
    << "TrigOffsetTPC @ " << TriggerOffsetTPC() << std::endl
    << "G4RefTime     @ " << fG4RefTime         << std::endl
    << "TPC     Freq. @ " << fTPCClock.Frequency() << std::endl
    << "Optical Freq. @ " << fOpticalClock.Frequency() << std::endl
    << "Trigger Freq. @ " << fTriggerClock.Frequency() << std::endl
    << "External Freq. @ " << fExternalClock.Frequency() << std::endl
    << "TPC start tick [tdc]             : " << TPCTick2TDC(0) <<std::endl
    << "TPC start tick from trigger [us] : " << TPCTick2TrigTime(0) <<std::endl
    << "TPC start tick from beam    [us] : " << TPCTick2BeamTime(0) <<std::endl
    << "TPC tdc=0 in tick     : " << TPCTDC2Tick(0) << std::endl
    << "TPC G4 time 0 in tick : " << TPCG4Time2Tick(0) << std::endl
    << std::endl;
  
}

double detinfo::DetectorClocksStandard::doTPCTime ( ) const

inlineprotected

Implementation of TPCTime().

Definition at line 371 of file DetectorClocksStandard.h.

References TriggerOffsetTPC(), and TriggerTime().

Referenced by TPCG4Time2Tick(), TPCTDC2Tick(), TPCTick2TDC(), TPCTick2Time(), and TPCTime().

{ return TriggerTime() + TriggerOffsetTPC(); }

virtual const detinfo::ElecClock& detinfo::DetectorClocksStandard::ExternalClock ( ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 242 of file DetectorClocksStandard.h.

References fExternalClock.

Referenced by ExternalClock().

    { return fExternalClock; }

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::ExternalClock ( double  time ) const

inlineoverridevirtual

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

Bug:

The frequency is taken from TriggerClock(), not ExternalClock()

Implements detinfo::DetectorClocks.

Definition at line 247 of file DetectorClocksStandard.h.

References fExternalClock, detinfo::ElecClock::FramePeriod(), detinfo::ElecClock::Frequency(), and fTriggerClock.

      { return detinfo::ElecClock(time,fExternalClock.FramePeriod(),fTriggerClock.Frequency());}

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::ExternalClock ( unsigned int  sample, unsigned int  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 251 of file DetectorClocksStandard.h.

References ExternalClock(), and detinfo::ElecClock::SetTime().

      { detinfo::ElecClock clock = ExternalClock(); clock.SetTime(sample,frame); return clock; }

virtual double detinfo::DetectorClocksStandard::ExternalG4Time2TDC ( double  g4time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 298 of file DetectorClocksStandard.h.

References fExternalClock, G4ToElecTime(), and detinfo::ElecClock::TickPeriod().

    { return G4ToElecTime(g4time) / fExternalClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::ExternalTick2BeamTime ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 275 of file DetectorClocksStandard.h.

References BeamGateTime(), fExternalClock, detinfo::ElecClock::TickPeriod(), and detinfo::ElecClock::Time().

    { return fExternalClock.TickPeriod() * tick + fExternalClock.Time(sample,frame) - BeamGateTime(); }

virtual double detinfo::DetectorClocksStandard::ExternalTick2TDC ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 295 of file DetectorClocksStandard.h.

References fExternalClock, and detinfo::ElecClock::Ticks().

    { return fExternalClock.Ticks(sample,frame) + tick; }

virtual double detinfo::DetectorClocksStandard::ExternalTick2Time ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 311 of file DetectorClocksStandard.h.

References fExternalClock, detinfo::ElecClock::TickPeriod(), and detinfo::ElecClock::Time().

    { return fExternalClock.Time(sample,frame) + tick * fExternalClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::ExternalTick2TrigTime ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 272 of file DetectorClocksStandard.h.

References fExternalClock, detinfo::ElecClock::TickPeriod(), detinfo::ElecClock::Time(), and TriggerTime().

    { return fExternalClock.TickPeriod() * tick + fExternalClock.Time(sample,frame) - TriggerTime(); }

virtual double detinfo::DetectorClocksStandard::G4ToElecTime ( double  g4_time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 159 of file DetectorClocksStandard.h.

References fG4RefTime.

Referenced by ExternalG4Time2TDC(), OpticalG4Time2TDC(), TPCG4Time2TDC(), and TPCG4Time2Tick().

{return g4_time * 1.e-3 - fG4RefTime; }

bool detinfo::DetectorClocksStandard::InheritClockConfig ( )

inline

Definition at line 325 of file DetectorClocksStandard.h.

References ApplyParams(), fInheritClockConfig, and IsRightConfig().

{ return fInheritClockConfig; }

bool detinfo::DetectorClocksStandard::IsRightConfig

(

const fhicl::ParameterSet &

ps

)

const

Internal function used to search for the right configuration set in the data file.

Definition at line 88 of file DetectorClocksStandard.cxx.

References d, fConfigName, detinfo::kInheritConfigTypeMax, and s.

Referenced by InheritClockConfig().

{
  std::string s;
  double d;
  
  // TODO replace with has_key()
  bool result = !ps.get_if_present("module_label", s);
  for(size_t i=0; result && i<kInheritConfigTypeMax; ++i)

    result = result && ps.get_if_present(fConfigName.at(i).c_str(),d);

  return result;
}

virtual const detinfo::ElecClock& detinfo::DetectorClocksStandard::OpticalClock ( ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 210 of file DetectorClocksStandard.h.

References fOpticalClock.

Referenced by OpticalClock().

    { return fOpticalClock; }

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::OpticalClock ( double  time ) const

inlineoverridevirtual

Create a Optical clock for a given time [us] from clock counting start.

Implements detinfo::DetectorClocks.

Definition at line 214 of file DetectorClocksStandard.h.

References fOpticalClock, detinfo::ElecClock::FramePeriod(), and detinfo::ElecClock::Frequency().

      { return detinfo::ElecClock(time,fOpticalClock.FramePeriod(),fOpticalClock.Frequency());}

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::OpticalClock ( unsigned int  sample, unsigned int  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 218 of file DetectorClocksStandard.h.

References OpticalClock(), and detinfo::ElecClock::SetTime().

    { detinfo::ElecClock clock = OpticalClock(); clock.SetTime(sample,frame); return clock; }

virtual double detinfo::DetectorClocksStandard::OpticalG4Time2TDC ( double  g4time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 292 of file DetectorClocksStandard.h.

References fOpticalClock, G4ToElecTime(), and detinfo::ElecClock::TickPeriod().

    { return G4ToElecTime(g4time) / fOpticalClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::OpticalTick2BeamTime ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 269 of file DetectorClocksStandard.h.

References BeamGateTime(), fOpticalClock, detinfo::ElecClock::TickPeriod(), and detinfo::ElecClock::Time().

    { return fOpticalClock.TickPeriod() * tick + fOpticalClock.Time(sample,frame) - BeamGateTime(); }

virtual double detinfo::DetectorClocksStandard::OpticalTick2TDC ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 289 of file DetectorClocksStandard.h.

References fOpticalClock, and detinfo::ElecClock::Ticks().

    { return fOpticalClock.Ticks(sample,frame) + tick; }

virtual double detinfo::DetectorClocksStandard::OpticalTick2Time ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 308 of file DetectorClocksStandard.h.

References fOpticalClock, detinfo::ElecClock::TickPeriod(), and detinfo::ElecClock::Time().

    { return fOpticalClock.Time(sample,frame) + tick * fOpticalClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::OpticalTick2TrigTime ( double  tick, size_t  sample, size_t  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 266 of file DetectorClocksStandard.h.

References fOpticalClock, detinfo::ElecClock::TickPeriod(), detinfo::ElecClock::Time(), and TriggerTime().

    { return fOpticalClock.TickPeriod() * tick + fOpticalClock.Time(sample,frame) - TriggerTime();  }

void detinfo::DetectorClocksStandard::SetConfigValue ( size_t  i, double  val  )

inline

Definition at line 170 of file DetectorClocksStandard.h.

References fConfigValue.

{ fConfigValue[i] = val; }

void detinfo::DetectorClocksStandard::SetDefaultTriggerTime

(

)

Sets trigger and beam gate time from default configuration values.

Definition at line 133 of file DetectorClocksStandard.cxx.

References ConfigValues(), detinfo::kDefaultBeamTime, detinfo::kDefaultTrigTime, and SetTriggerTime().

Referenced by Configure(), detinfo::setDetectorClocksStandardTrigger(), and TrigModuleName().

{
  std::vector<double> const& cfgValues = ConfigValues();
  
  SetTriggerTime(
    cfgValues.at(detinfo::kDefaultTrigTime),
                cfgValues.at(detinfo::kDefaultBeamTime)
    );
  
} // detinfo::DetectorClocksStandard::SetDefaultTriggerTime()

virtual void detinfo::DetectorClocksStandard::SetTriggerTime ( double  trig_time, double  beam_time  )

inlinevirtual

Setter for trigger times.

Parameters

trig_time	hardware trigger time in electronics time scale
beam_time	beam gate opening time in electronics time scale

The hardware trigger and beam gate opening times are set, and the electronic clocks are updated to store the new trigger time.

Definition at line 181 of file DetectorClocksStandard.h.

References fBeamGateTime, fOpticalClock, fTPCClock, fTriggerClock, fTriggerTime, and detinfo::ElecClock::SetTime().

Referenced by SetDefaultTriggerTime(), and detinfo::setDetectorClocksStandardTriggersFromRawTrigger().

    { 
      fTriggerTime  = trig_time;
      fBeamGateTime = beam_time;
      fTPCClock.SetTime(trig_time);
      fOpticalClock.SetTime(trig_time);
      fTriggerClock.SetTime(trig_time);
    }

virtual const ::detinfo::ElecClock& detinfo::DetectorClocksStandard::TPCClock ( ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 194 of file DetectorClocksStandard.h.

References fTPCClock.

Referenced by TPCClock().

    { return fTPCClock; }

virtual ::detinfo::ElecClock detinfo::DetectorClocksStandard::TPCClock ( double  time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 198 of file DetectorClocksStandard.h.

References detinfo::ElecClock::FramePeriod(), detinfo::ElecClock::Frequency(), and fTPCClock.

        { return ::detinfo::ElecClock(time,fTPCClock.FramePeriod(),fTPCClock.Frequency());}

detinfo::ElecClock detinfo::DetectorClocksStandard::TPCClock ( unsigned int  sample, unsigned int  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 202 of file DetectorClocksStandard.h.

References detinfo::ElecClock::SetTime(), and TPCClock().

      { detinfo::ElecClock clock = TPCClock(); clock.SetTime(sample,frame); return clock; }

virtual double detinfo::DetectorClocksStandard::TPCG4Time2TDC ( double  g4time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 286 of file DetectorClocksStandard.h.

References fTPCClock, G4ToElecTime(), and detinfo::ElecClock::TickPeriod().

    { return G4ToElecTime(g4time) / fTPCClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::TPCG4Time2Tick ( double  g4time ) const

inlineoverridevirtual

Given G4 time returns electronics clock count [tdc].

Implements detinfo::DetectorClocks.

Definition at line 322 of file DetectorClocksStandard.h.

References doTPCTime(), fTPCClock, G4ToElecTime(), and detinfo::ElecClock::TickPeriod().

Referenced by debugReport().

    { return (G4ToElecTime(g4time) - doTPCTime()) / fTPCClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::TPCTDC2Tick ( double  tdc ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 319 of file DetectorClocksStandard.h.

References doTPCTime(), fTPCClock, and detinfo::ElecClock::TickPeriod().

Referenced by debugReport().

    { return ( tdc - doTPCTime() / fTPCClock.TickPeriod() ); }

virtual double detinfo::DetectorClocksStandard::TPCTick2BeamTime ( double  tick ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 263 of file DetectorClocksStandard.h.

References BeamGateTime(), TPCTick2TrigTime(), and TriggerTime().

Referenced by debugReport().

    { return TPCTick2TrigTime(tick) + TriggerTime() - BeamGateTime(); }

virtual double detinfo::DetectorClocksStandard::TPCTick2TDC ( double  tick ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 283 of file DetectorClocksStandard.h.

References doTPCTime(), fTPCClock, and detinfo::ElecClock::TickPeriod().

Referenced by debugReport().

    { return ( doTPCTime() / fTPCClock.TickPeriod() + tick ); }

virtual double detinfo::DetectorClocksStandard::TPCTick2Time ( double  tick ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 305 of file DetectorClocksStandard.h.

References doTPCTime(), fTPCClock, and detinfo::ElecClock::TickPeriod().

    { return doTPCTime() + tick * fTPCClock.TickPeriod(); }

virtual double detinfo::DetectorClocksStandard::TPCTick2TrigTime ( double  tick ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 260 of file DetectorClocksStandard.h.

References fTPCClock, detinfo::ElecClock::TickPeriod(), and TriggerOffsetTPC().

Referenced by debugReport(), and TPCTick2BeamTime().

    { return fTPCClock.TickPeriod() * tick + TriggerOffsetTPC(); }

virtual double detinfo::DetectorClocksStandard::TPCTime ( ) const

inlineoverridevirtual

Returns the TPC electronics start time in electronics time.

Implements detinfo::DetectorClocks.

Definition at line 142 of file DetectorClocksStandard.h.

References debugReport(), and doTPCTime().

{ return doTPCTime(); }

virtual const detinfo::ElecClock& detinfo::DetectorClocksStandard::TriggerClock ( ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 226 of file DetectorClocksStandard.h.

References fTriggerClock.

Referenced by TriggerClock().

    { return fTriggerClock; }

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::TriggerClock ( double  time ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 230 of file DetectorClocksStandard.h.

References detinfo::ElecClock::FramePeriod(), detinfo::ElecClock::Frequency(), and fTriggerClock.

    { return detinfo::ElecClock(time,fTriggerClock.FramePeriod(),fTriggerClock.Frequency());}

virtual detinfo::ElecClock detinfo::DetectorClocksStandard::TriggerClock ( unsigned int  sample, unsigned int  frame  ) const

inlineoverridevirtual

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

Implements detinfo::DetectorClocks.

Definition at line 234 of file DetectorClocksStandard.h.

References detinfo::ElecClock::SetTime(), and TriggerClock().

    { detinfo::ElecClock clock = TriggerClock(); clock.SetTime(sample,frame); return clock; }

virtual double detinfo::DetectorClocksStandard::TriggerOffsetTPC ( ) const

inlineoverridevirtual

See also

detinfo::DetectorClocks::TriggerOffsetTPC()

This offset is set via configuration parameter TriggerOffsetTPC.

Implements detinfo::DetectorClocks.

Definition at line 133 of file DetectorClocksStandard.h.

References detinfo::ElecClock::Frequency(), fTPCClock, and fTriggerOffsetTPC.

Referenced by debugReport(), doTPCTime(), and TPCTick2TrigTime().

    { 
      if (fTriggerOffsetTPC<0)
        return fTriggerOffsetTPC; 
      else
        return -fTriggerOffsetTPC/fTPCClock.Frequency(); //convert ticks to us
    }

virtual double detinfo::DetectorClocksStandard::TriggerTime ( ) const

inlineoverridevirtual

Trigger electronics clock time in [us].

Implements detinfo::DetectorClocks.

Definition at line 162 of file DetectorClocksStandard.h.

References fTriggerTime.

Referenced by doTPCTime(), ExternalTick2TrigTime(), OpticalTick2TrigTime(), and TPCTick2BeamTime().

{ return fTriggerTime; }

std::string detinfo::DetectorClocksStandard::TrigModuleName ( ) const

inline

Returns the input tag of the trigger data product.

Returns

the input tag of the trigger data product (as string)

The trigger module name is set directly in the configuration as TrigModuleName.

Definition at line 153 of file DetectorClocksStandard.h.

References fTrigModuleName, and SetDefaultTriggerTime().

Referenced by detinfo::setDetectorClocksStandardTriggersFromEvent().

{ return fTrigModuleName; }

bool detinfo::DetectorClocksStandard::Update

(

uint64_t

ts = 0

)

Definition at line 45 of file DetectorClocksStandard.cxx.

Referenced by ~DetectorClocksStandard().

{
  return true;
}

Member Data Documentation

double detinfo::DetectorClocksStandard::fBeamGateTime

protected

BeamGate time in [us].

Definition at line 368 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), BeamGateTime(), debugReport(), and SetTriggerTime().

std::vector<std::string> detinfo::DetectorClocksStandard::fConfigName

protected

Definition at line 335 of file DetectorClocksStandard.h.

Referenced by ConfigNames(), Configure(), debugReport(), DetectorClocksStandard(), and IsRightConfig().

std::vector<double> detinfo::DetectorClocksStandard::fConfigValue

protected

Definition at line 337 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), Configure(), ConfigValues(), debugReport(), and SetConfigValue().

::detinfo::ElecClock detinfo::DetectorClocksStandard::fExternalClock

protected

External clock.

Definition at line 359 of file DetectorClocksStandard.h.

Referenced by debugReport(), ExternalClock(), ExternalG4Time2TDC(), ExternalTick2BeamTime(), ExternalTick2TDC(), ExternalTick2Time(), and ExternalTick2TrigTime().

double detinfo::DetectorClocksStandard::fFramePeriod

protected

Frame period.

Definition at line 347 of file DetectorClocksStandard.h.

Referenced by ApplyParams().

double detinfo::DetectorClocksStandard::fG4RefTime

protected

Electronics clock counting start time in G4 time frame [us].

Definition at line 344 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), debugReport(), and G4ToElecTime().

bool detinfo::DetectorClocksStandard::fInheritClockConfig

protected

Definition at line 339 of file DetectorClocksStandard.h.

Referenced by Configure(), and InheritClockConfig().

::detinfo::ElecClock detinfo::DetectorClocksStandard::fOpticalClock

protected

Optical clock.

Definition at line 353 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), debugReport(), OpticalClock(), OpticalG4Time2TDC(), OpticalTick2BeamTime(), OpticalTick2TDC(), OpticalTick2Time(), OpticalTick2TrigTime(), and SetTriggerTime().

::detinfo::ElecClock detinfo::DetectorClocksStandard::fTPCClock

protected

TPC clock.

Definition at line 350 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), debugReport(), SetTriggerTime(), TPCClock(), TPCG4Time2TDC(), TPCG4Time2Tick(), TPCTDC2Tick(), TPCTick2TDC(), TPCTick2Time(), TPCTick2TrigTime(), and TriggerOffsetTPC().

::detinfo::ElecClock detinfo::DetectorClocksStandard::fTriggerClock

protected

Trigger clock.

Definition at line 356 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), debugReport(), ExternalClock(), SetTriggerTime(), and TriggerClock().

double detinfo::DetectorClocksStandard::fTriggerOffsetTPC

protected

Time offset from trigger to TPC readout start.

Definition at line 362 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), and TriggerOffsetTPC().

double detinfo::DetectorClocksStandard::fTriggerTime

protected

Trigger time in [us].

Definition at line 365 of file DetectorClocksStandard.h.

Referenced by ApplyParams(), debugReport(), SetTriggerTime(), and TriggerTime().

std::string detinfo::DetectorClocksStandard::fTrigModuleName

protected

Definition at line 341 of file DetectorClocksStandard.h.

Referenced by Configure(), and TrigModuleName().

---

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

• lardataalg/v1_02_01/source/lardataalg/DetectorInfo/DetectorClocksStandard.h
• lardataalg/v1_02_01/source/lardataalg/DetectorInfo/DetectorClocksStandard.cxx