General LArSoft Utilities. More...

Classes
class	DetectorClocks
	Conversion of times between different formats and references. More...

class	DetectorClocksException

class	DetectorClocksService

class	DetectorClocksServiceStandard
	art service managing `detinfo::DetectorClocksStandard`. More...

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

class	DetectorProperties

class	DetectorPropertiesService

class	DetectorPropertiesServiceStandard
	"Standard" implementation of DetectorProperties service More...

class	DetectorPropertiesStandard

class	ElecClock
	Class representing the time measured by an electronics clock. More...

class	LArProperties

class	LArPropertiesService

class	LArPropertiesServiceStandard

class	LArPropertiesStandard
	Properties related to liquid argon environment in the detector. More...

class	RunHistory

class	RunHistoryStandard

class	SubRun

class	SubRunStandard

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

enum	RunType_t { kUnknownRunType =0, kProductionRun, kCommissioningRun, kTestRun, kPedestalRun, kCalibrationRun, kNRunType }

Functions
void	setDetectorClocksStandardTriggersFromRawTrigger (detinfo::DetectorClocksStandard &detClocks, raw::Trigger const &trigger)
	Loads `DetectorClocksStandard` trigger times from a `raw::Trigger`. More...

template<typename Event >
bool	setDetectorClocksStandardTriggersFromEvent (detinfo::DetectorClocksStandard &detClocks, Event const &event)
	Loads `DetectorClocksStandard` trigger times from a `raw::Trigger`. More...

template<typename Event >
bool	setDetectorClocksStandardTrigger (detinfo::DetectorClocksStandard &detClocks, Event const &event)
	Loads `DetectorClocksStandard` trigger times. More...

Variables
const double	kTIME_MAX = std::numeric_limits<double>::max()
	Maximum time in microseconds. More...

const double	kDEFAULT_FREQUENCY = 1.e-6
	Default Frequency in MHz. More...

const double	kDEFAULT_FRAME_PERIOD = 1.6e3
	Default Frame period in micro-second. More...

const double	kDEFAULT_FREQUENCY_OPTICAL = 64.
	Default Optical clock speed in MHz. More...

const double	kDEFAULT_FREQUENCY_TPC = 2.
	Default TPC clock speed in MHz. More...

const double	kDEFAULT_FREQUENCY_TRIGGER = 16.
	Default Trigger clock speed in MHz. More...

const double	kDEFAULT_FREQUENCY_EXTERNAL = 31.25
	Default External clock speed in MHz. More...

const double	kDEFAULT_MC_CLOCK_T0 = 0
	Default G4 reference time in micro-second. More...

const double	kDEFAULT_TRIG_OFFSET_TPC = -1600.
	Default TPC readout start time offset from trigger in micro-second. More...

const double	kDEFAULT_TRIG_TIME = 0.0
	Default TriggerTime in micro-second. More...

const double	kDEFAULT_BEAM_TIME = 0.0
	Default BeamGateTime in micro-second. More...

Detailed Description

General LArSoft Utilities.

Enumeration Type Documentation

enum detinfo::InheritConfigType_t

Enumerator
kG4RefTime
kTriggerOffsetTPC
kFramePeriod
kClockSpeedTPC
kClockSpeedOptical
kClockSpeedTrigger
kClockSpeedExternal
kDefaultTrigTime
kDefaultBeamTime
kInheritConfigTypeMax

Definition at line 16 of file DetectorClocks.h.

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

enum detinfo::RunType_t

Enumerator
kUnknownRunType
kProductionRun
kCommissioningRun
kTestRun
kPedestalRun
kCalibrationRun
kNRunType

Definition at line 15 of file RunHistory.h.

                  {
     kUnknownRunType=0,
     kProductionRun,
     kCommissioningRun,
     kTestRun,    
     kPedestalRun,
     kCalibrationRun,
     kNRunType
   };

Function Documentation

template<typename Event >

bool detinfo::setDetectorClocksStandardTrigger	(	detinfo::DetectorClocksStandard &	detClocks,
		Event const &	event
	)

Loads DetectorClocksStandard trigger times.

Template Parameters

Event type of event where trigger data might be stored

Parameters

detClocks	the instance of `detinfo::DetectorClocksStandard` to set
event	the event the trigger objects are stored into

Returns: whether the times were set from a trigger object

Exceptions

cet::exception if trigger data product has more than one trigger

This function sets the trigger and beam gate times of detClocks. First, it attempts to read the settings from the event (see setDetectorClocksStandardTriggersFromEvent()). If that fails "nicely", then sets them with the default values from the configuration.

A "nice" failure is where there is no trigger object in the event. Other types of failure include when there are more than one trigger objects in the event, in which case no choice is made, and an exception is thrown.

Definition at line 135 of file DetectorClocksStandardTriggerLoader.h.

References detinfo::DetectorClocksStandard::SetDefaultTriggerTime(), and setDetectorClocksStandardTriggersFromEvent().

Referenced by detinfo::DetectorClocksServiceStandard::preProcessEvent(), and setDetectorClocksStandardTriggersFromEvent().

   {
     //
     // try to read the trigger from the event
     //
     if (setDetectorClocksStandardTriggersFromEvent(detClocks, event))
       return true;
     
     //
     // if there was no trigger candidate, set it default
     //
     detClocks.SetDefaultTriggerTime();
     return false;
     
   } // setDetectorClocksStandardTrigger

template<typename Event >

bool detinfo::setDetectorClocksStandardTriggersFromEvent	(	detinfo::DetectorClocksStandard &	detClocks,
		Event const &	event
	)

Loads DetectorClocksStandard trigger times from a raw::Trigger.

Template Parameters

Event type of event where trigger data might be stored

Parameters

detClocks	the instance of `detinfo::DetectorClocksStandard` to set
event	the event the trigger objects are stored into

Returns: whether the times were set

Exceptions

cet::exception if trigger data product has more than one trigger

The input tag stored in detClocks (detinfo::DetectorClocksStandard::TrigModuleName()) is used to read a raw::Trigger collection.

If the event has no such trigger data product, or if that data product is empty, false is returned and detClocks is unchanged.

If the trigger data product is found and there are more than one triggers in there, an exception is thrown: we support only the case where the trigger to be used is unequivocal.

Definition at line 73 of file DetectorClocksStandardTriggerLoader.h.

References art::InputTag::encode(), setDetectorClocksStandardTrigger(), setDetectorClocksStandardTriggersFromRawTrigger(), and detinfo::DetectorClocksStandard::TrigModuleName().

Referenced by setDetectorClocksStandardTrigger(), and setDetectorClocksStandardTriggersFromRawTrigger().

   {
     //
     // fetch the trigger data product
     //
     using TriggerHandle_t
       = typename Event::template HandleT<std::vector<raw::Trigger>>;
     
     art::InputTag const triggerTag = detClocks.TrigModuleName();
     TriggerHandle_t triggerHandle;
     if (!event.template getByLabel(triggerTag, triggerHandle)) return false;
     
     //
     // check that we do have a trigger
     // (we have already checked whether the handle is valid above)
     //
     
     auto const& triggers = *triggerHandle;
     if (triggers.empty()) return false;
     
     //
     // select which trigger to set (i.e., the only one!)
     //
     if (triggers.size() != 1) {
       throw cet::exception("setDetectorClocksStandardTrigger")
         << "Found " << triggers.size()
         << " trigger objects in '" << triggerTag.encode()
         << "' (only one trigger per event is supported)\n";
     }
         
     //
     // set the timings from the first and only trigger into the service
     //
     setDetectorClocksStandardTriggersFromRawTrigger
       (detClocks, triggers.front());
     
     // all done
     return true;
     
   } // setDetectorClocksStandardTriggersFromEvent()

void detinfo::setDetectorClocksStandardTriggersFromRawTrigger	(	detinfo::DetectorClocksStandard &	detClocks,
		raw::Trigger const &	trigger
	)

inline

Loads DetectorClocksStandard trigger times from a raw::Trigger.

Parameters

detClocks	the instance of `detinfo::DetectorClocksStandard` to set
trigger	the trigger object to extract timings from

The times are stored unconditionally and directly, with no time scale conversion.

Definition at line 48 of file DetectorClocksStandardTriggerLoader.h.

References raw::Trigger::BeamGateTime(), setDetectorClocksStandardTriggersFromEvent(), detinfo::DetectorClocksStandard::SetTriggerTime(), and raw::Trigger::TriggerTime().

Referenced by setDetectorClocksStandardTriggersFromEvent().

49 { detClocks.SetTriggerTime(trigger.TriggerTime(), trigger.BeamGateTime()); }

detinfo::DetectorClocksStandard::SetTriggerTime

virtual void SetTriggerTime(double trig_time, double beam_time)

Setter for trigger times.

Definition: DetectorClocksStandard.h:181

trigger

Definition: TriggerAlgoBase.h:27

Variable Documentation

const double detinfo::kDEFAULT_BEAM_TIME = 0.0

Default BeamGateTime in micro-second.

Definition at line 41 of file ClockConstants.h.

const double detinfo::kDEFAULT_FRAME_PERIOD = 1.6e3

Default Frame period in micro-second.

Definition at line 17 of file ClockConstants.h.

const double detinfo::kDEFAULT_FREQUENCY = 1.e-6

Default Frequency in MHz.

Definition at line 14 of file ClockConstants.h.

const double detinfo::kDEFAULT_FREQUENCY_EXTERNAL = 31.25

Default External clock speed in MHz.

Definition at line 29 of file ClockConstants.h.

const double detinfo::kDEFAULT_FREQUENCY_OPTICAL = 64.

Default Optical clock speed in MHz.

Definition at line 20 of file ClockConstants.h.

const double detinfo::kDEFAULT_FREQUENCY_TPC = 2.

Default TPC clock speed in MHz.

Definition at line 23 of file ClockConstants.h.

const double detinfo::kDEFAULT_FREQUENCY_TRIGGER = 16.

Default Trigger clock speed in MHz.

Definition at line 26 of file ClockConstants.h.

const double detinfo::kDEFAULT_MC_CLOCK_T0 = 0

Default G4 reference time in micro-second.

Definition at line 32 of file ClockConstants.h.

const double detinfo::kDEFAULT_TRIG_OFFSET_TPC = -1600.

Default TPC readout start time offset from trigger in micro-second.

Definition at line 35 of file ClockConstants.h.

const double detinfo::kDEFAULT_TRIG_TIME = 0.0

Default TriggerTime in micro-second.

Definition at line 38 of file ClockConstants.h.

const double detinfo::kTIME_MAX = std::numeric_limits<double>::max()

Maximum time in microseconds.

Definition at line 11 of file ClockConstants.h.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation