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 (fhicl::ParameterSet const &pset)
	DetectorClocksStandard (DetectorClocksStandard const &)=delete
void	SetConfigValue (size_t i, double val)
std::string const &	TrigModuleName () const
	Returns the input tag of the trigger data product. More...
std::string	G4RefCorrTrigModuleName () const
	Returns the input tag of the trigger data product for G4Ref correctons. More...
std::vector< std::string > const &	ConfigNames () const override
std::vector< double > const &	ConfigValues () const override
DetectorClocksData	DataForJob () const override
	Returns a complete detinfo::DetectorClocksData object. More...
DetectorClocksData	DataFor (double const g4_ref_time, double const trigger_time, double const beam_time) const override
	Returns a complete detinfo::DetectorClocksData object. More...
void	ApplyParams ()
	Internal function to apply loaded parameters to member attributes. More...
bool	IsRightConfig (const fhicl::ParameterSet &ps) const
void	debugReport () const
	Dumps the current configuration to screen. More...
Public Member Functions inherited from detinfo::DetectorClocks
virtual	~DetectorClocks ()=default

Private Member Functions
void	SetTriggerTime (double const trig_time, double const beam_time)
	Setter for trigger times. More...
double	TriggerOffsetTPC () const

Private Attributes
std::vector< std::string >	fConfigName
std::vector< double >	fConfigValue
std::string	fTrigModuleName
std::string	fG4RefCorrTrigModuleName
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...
double	fFramePeriod
	Frame period. More...
ElecClock	fTPCClock

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 122 of file DetectorClocksStandard.h.

Constructor & Destructor Documentation

detinfo::DetectorClocksStandard::DetectorClocksStandard

(

fhicl::ParameterSet const &

pset

)

Definition at line 9 of file DetectorClocksStandard.cxx.

  : fConfigName{"G4RefTime",
                "TriggerOffsetTPC",
                "FramePeriod",
                "ClockSpeedTPC",
                "ClockSpeedOptical",
                "ClockSpeedTrigger",
                "ClockSpeedExternal",
                "DefaultTrigTime",
                "DefaultBeamTime"}
  , fConfigValue{pset.get<double>(fConfigName[kG4RefTime]),
                 pset.get<double>(fConfigName[kTriggerOffsetTPC]),
                 pset.get<double>(fConfigName[kFramePeriod]),
                 pset.get<double>(fConfigName[kClockSpeedTPC]),
                 pset.get<double>(fConfigName[kClockSpeedOptical]),
                 pset.get<double>(fConfigName[kClockSpeedTrigger]),
                 pset.get<double>(fConfigName[kClockSpeedExternal]),
                 pset.get<double>(fConfigName[kDefaultTrigTime]),
                 pset.get<double>(fConfigName[kDefaultBeamTime])}
  , fTrigModuleName{pset.get<std::string>("TrigModuleName")}
  , fG4RefCorrTrigModuleName{pset.get<std::string>("G4RefCorrTrigModuleName", "baddefault")}
  , fTriggerOffsetTPC{fConfigValue[kTriggerOffsetTPC]}
  , fTriggerTime{fConfigValue[detinfo::kDefaultTrigTime]}
  , fBeamGateTime{fConfigValue[detinfo::kDefaultBeamTime]}
  , fFramePeriod{fConfigValue[kFramePeriod]}
  , fTPCClock{fTriggerTime, fFramePeriod, fConfigValue[kClockSpeedTPC]}
{
  SetTriggerTime(fConfigValue[detinfo::kDefaultTrigTime], fConfigValue[detinfo::kDefaultBeamTime]);
}

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

delete

Member Function Documentation

void detinfo::DetectorClocksStandard::ApplyParams

(

)

Internal function to apply loaded parameters to member attributes.

Definition at line 40 of file DetectorClocksStandard.cxx.

{
  fFramePeriod = fConfigValue[kFramePeriod];
  fTriggerOffsetTPC = fConfigValue[kTriggerOffsetTPC];
  SetTriggerTime(fConfigValue[detinfo::kDefaultTrigTime], fConfigValue[detinfo::kDefaultBeamTime]);
}

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

inlineoverridevirtual

Returns a list of provider configuration names.

See Also

ConfigValues()

Implements detinfo::DetectorClocks.

Definition at line 160 of file DetectorClocksStandard.h.

    {
      return fConfigName;
    }

std::vector<double> const& 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 165 of file DetectorClocksStandard.h.

    {
      return fConfigValue;
    }

DetectorClocksData detinfo::DetectorClocksStandard::DataFor ( double const  g4_ref_time, double const  trigger_time, double const  beam_time  ) const

inlineoverridevirtual

Returns a complete detinfo::DetectorClocksData object.

Parameters

g4_ref_time	start of simulation time in electronics time scale [ns]
trigger_time	the default hardware trigger time in electronics time
beam_time	the default beam gate opening time in electronics time

The returned timing information reflects the current context, defined by the parameters passed to this method.

If the information required by the parameters is not available, users will be forced to use DataForJob() instead.

For more details on the definition of the parameters, see the documentation of detinfo::DetectorClocksData constructor.

Implements detinfo::DetectorClocks.

Definition at line 185 of file DetectorClocksStandard.h.

    {
      return DetectorClocksData{
        g4_ref_time,
        fTriggerOffsetTPC,
        trigger_time,
        beam_time,
        ElecClock{trigger_time, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedTPC]},
        ElecClock{trigger_time, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedOptical]},
        ElecClock{trigger_time, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedTrigger]},
        ElecClock{0, kDEFAULT_FRAME_PERIOD, kDEFAULT_FREQUENCY_EXTERNAL}};
    }

DetectorClocksData detinfo::DetectorClocksStandard::DataForJob ( ) const

inlineoverridevirtual

Returns a complete detinfo::DetectorClocksData object.

The returned timing information is based on information independent of the current input file, run or event. It is recommended that DataFor() is used instead whenever possible.

Implements detinfo::DetectorClocks.

Definition at line 171 of file DetectorClocksStandard.h.

    {
      return DetectorClocksData{
        fConfigValue[kG4RefTime], // FIXME: Should be run-dependent?
        fTriggerOffsetTPC,
        fTriggerTime,
        fBeamGateTime,
        ElecClock{fTriggerTime, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedTPC]},
        ElecClock{fTriggerTime, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedOptical]},
        ElecClock{fTriggerTime, fConfigValue[kFramePeriod], fConfigValue[kClockSpeedTrigger]},
        ElecClock{0, kDEFAULT_FRAME_PERIOD, kDEFAULT_FREQUENCY_EXTERNAL}};
    }

void detinfo::DetectorClocksStandard::debugReport

(

)

const

Dumps the current configuration to screen.

Definition at line 58 of file DetectorClocksStandard.cxx.

{
  std::cout << "fConfigValues contents: " << std::endl;

  for(auto const& [ name, value ]: util::zip(fConfigName, fConfigValue))
    std::cout << "\n    " << name << " ... " << value;
  std::cout << std::endl;

  DataForJob().debugReport(std::cout);
  std::cout.flush();

} // detinfo::DetectorClocksStandard::debugReport()

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

inline

Returns the input tag of the trigger data product for G4Ref correctons.

Returns

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

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

Definition at line 154 of file DetectorClocksStandard.h.

    {
      return fG4RefCorrTrigModuleName;
    }

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 48 of file DetectorClocksStandard.cxx.

{
  if (ps.has_key("module_label")) { return false; }
  return std::all_of(fConfigName.cbegin(), fConfigName.cend(), [&ps](auto const& config_name) {
    return ps.has_key(config_name);
  });
}

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

inline

Definition at line 128 of file DetectorClocksStandard.h.

    {
      fConfigValue[i] = val;
    }

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

inlineprivate

Setter for trigger times.

Parameters

trig_time

hardware triggertime" in @ref DetectorClocksElectronicsTime "electronics time scale" @param beam_time @ref DetectorClocksBeamGateOpening "beam gate opening time" in @ref DetectorClocksElectronicsTime "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 223 of file DetectorClocksStandard.h.

    {
      fTriggerTime = trig_time;
      fBeamGateTime = beam_time;
      fTPCClock = ElecClock{fTriggerTime, fFramePeriod, fConfigValue[kClockSpeedTPC]};
    }

double detinfo::DetectorClocksStandard::TriggerOffsetTPC ( ) const

inlineprivate

Definition at line 231 of file DetectorClocksStandard.h.

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

std::string const& 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 141 of file DetectorClocksStandard.h.

    {
      return fTrigModuleName;
    }

Member Data Documentation

double detinfo::DetectorClocksStandard::fBeamGateTime

private

BeamGate time in [us].

Definition at line 253 of file DetectorClocksStandard.h.

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

private

Definition at line 240 of file DetectorClocksStandard.h.

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

private

Definition at line 241 of file DetectorClocksStandard.h.

double detinfo::DetectorClocksStandard::fFramePeriod

private

Frame period.

Definition at line 256 of file DetectorClocksStandard.h.

std::string detinfo::DetectorClocksStandard::fG4RefCorrTrigModuleName

private

Definition at line 244 of file DetectorClocksStandard.h.

ElecClock detinfo::DetectorClocksStandard::fTPCClock

private

Definition at line 258 of file DetectorClocksStandard.h.

double detinfo::DetectorClocksStandard::fTriggerOffsetTPC

private

Time offset from trigger to TPC readout start.

Definition at line 247 of file DetectorClocksStandard.h.

double detinfo::DetectorClocksStandard::fTriggerTime

private

Trigger time in [us].

Definition at line 250 of file DetectorClocksStandard.h.

std::string detinfo::DetectorClocksStandard::fTrigModuleName

private

Definition at line 243 of file DetectorClocksStandard.h.

---

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

• DetectorClocksStandard.h
• DetectorClocksStandard.cxx