LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
detinfo::timescales Namespace Reference

Namespace including different time scales as defined in LArSoft. More...

Namespaces

 details
 

Classes

struct  ElectronicsTimeCategory
 Category for electronics time scale. More...
 
struct  is_tick_type
 Evaluates to whether the specified time T is tick-based. More...
 
struct  OpticalTimeCategory
 Category for electronics time scale. More...
 
struct  SimulationTimeCategory
 Category for electronics time scale. More...
 
struct  timescale_traits
 A collection of traits for a time scale. More...
 
struct  timescale_traits< ElectronicsTimeCategory >
 Timing types for electronics time scale. More...
 
struct  timescale_traits< OpticalTimeCategory >
 Timing types for optical detector time scale. More...
 
struct  timescale_traits< SimulationTimeCategory >
 Timing types for simulation time scale. More...
 
struct  timescale_traits< TPCelectronicsTimeCategory >
 Timing types for TPC electronics time scale. More...
 
struct  timescale_traits< TriggerTimeCategory >
 Timing types for trigger electronics time scale. More...
 
struct  TPCelectronicsTimeCategory
 Category for TPC electronics time scale. More...
 
struct  TriggerTimeCategory
 Category for trigger time scale. More...
 

Typedefs

using time_interval = util::quantities::intervals::microseconds
 
Continuous times
using electronics_time = timescale_traits< ElectronicsTimeCategory >::time_point_t
 A point in time on the electronics time scale. More...
 
using TPCelectronics_time = timescale_traits< TPCelectronicsTimeCategory >::time_point_t
 A point in time on the TPC electronics time scale. More...
 
using optical_time = timescale_traits< OpticalTimeCategory >::time_point_t
 A point in time on the optical detector electronics time scale. More...
 
using trigger_time = timescale_traits< TriggerTimeCategory >::time_point_t
 A point in time on the trigger time scale. More...
 
using simulation_time = timescale_traits< SimulationTimeCategory >::time_point_t
 A point in time on the simulation time scale. More...
 

Tick-based times

using electronics_tick = timescale_traits< ElectronicsTimeCategory >::tick_t
 A point on the electronics time scale expressed in its ticks. More...
 
using electronics_tick_d = timescale_traits< ElectronicsTimeCategory >::tick_d_t
 A point on the electronics time scale expressed in its ticks (real). More...
 
using electronics_time_ticks = timescale_traits< ElectronicsTimeCategory >::tick_interval_t
 An interval on the electronics time scale expressed in its ticks. More...
 
using electronics_time_ticks_d = timescale_traits< ElectronicsTimeCategory >::tick_interval_d_t
 An interval on the electronics time scale expressed in its ticks (real). More...
 
using TPCelectronics_tick = timescale_traits< TPCelectronicsTimeCategory >::tick_t
 A point on the TPC electronics time scale expressed in its ticks. More...
 
using TPCelectronics_tick_d = timescale_traits< TPCelectronicsTimeCategory >::tick_d_t
 A point on the TPC electronics time scale expressed in its ticks (real). More...
 
using TPCelectronics_time_ticks = timescale_traits< TPCelectronicsTimeCategory >::tick_interval_t
 An interval on the TPC electronics time scale expressed in its ticks. More...
 
using TPCelectronics_time_ticks_d = timescale_traits< TPCelectronicsTimeCategory >::tick_interval_d_t
 
using optical_tick = timescale_traits< OpticalTimeCategory >::tick_t
 
using optical_tick_d = timescale_traits< OpticalTimeCategory >::tick_d_t
 
using optical_time_ticks = timescale_traits< OpticalTimeCategory >::tick_interval_t
 
using optical_time_ticks_d = timescale_traits< OpticalTimeCategory >::tick_interval_d_t
 
using trigger_tick = timescale_traits< TriggerTimeCategory >::tick_t
 A point on the trigger time scale expressed in its ticks. More...
 
using trigger_tick_d = timescale_traits< TriggerTimeCategory >::tick_d_t
 A point on the trigger time scale expressed in its ticks (real). More...
 
using trigger_time_ticks = timescale_traits< TriggerTimeCategory >::tick_interval_t
 An interval on the trigger time scale expressed in its ticks. More...
 
using trigger_time_ticks_d = timescale_traits< TriggerTimeCategory >::tick_interval_d_t
 An interval on the trigger time scale expressed in its ticks (real). More...
 
template<typename T >
constexpr bool is_tick_v = is_tick_type<T>()
 Whether the specified time T is tick-based. More...
 

Detailed Description

Namespace including different time scales as defined in LArSoft.

Typedef Documentation

A point on the electronics time scale expressed in its ticks.

Definition at line 350 of file DetectorTimingTypes.h.

A point on the electronics time scale expressed in its ticks (real).

Definition at line 353 of file DetectorTimingTypes.h.

A point in time on the electronics time scale.

This object is nothing special, but it is meant to represent a time on the electronics time axis, starting at the electronics start time.

This time is natively expressed in microseconds.

Definition at line 286 of file DetectorTimingTypes.h.

An interval on the electronics time scale expressed in its ticks.

Definition at line 356 of file DetectorTimingTypes.h.

An interval on the electronics time scale expressed in its ticks (real).

Definition at line 359 of file DetectorTimingTypes.h.

A point on the optical detector electronics time scale expressed in its ticks.

Definition at line 381 of file DetectorTimingTypes.h.

A point on the optical detector electronics time scale expressed in its ticks (real).

Definition at line 385 of file DetectorTimingTypes.h.

A point in time on the optical detector electronics time scale.

This object is meant to represent a time on the optical detector electronics time axis, starting at the optical detector electronics start time.

Note
Unfortunately, that time is not defined, so the functions that need it pin it down to the start of the electronics time scale.

This time is natively expressed in microseconds.

Definition at line 315 of file DetectorTimingTypes.h.

An interval on the optical detector electronics time scale expressed in its ticks.

Definition at line 389 of file DetectorTimingTypes.h.

An interval on the optical detector electronics time scale expressed in its ticks (real).

Definition at line 393 of file DetectorTimingTypes.h.

A point in time on the simulation time scale.

This object is meant to represent a time on the simulation time axis, starting at the GEANT4 time start.

This time is natively expressed in nanoseconds.

Definition at line 339 of file DetectorTimingTypes.h.

Type of time interval (natively in microseconds). Intentionally cross-category.

Definition at line 91 of file DetectorTimingTypes.h.

A point on the TPC electronics time scale expressed in its ticks.

Definition at line 364 of file DetectorTimingTypes.h.

A point on the TPC electronics time scale expressed in its ticks (real).

Definition at line 367 of file DetectorTimingTypes.h.

A point in time on the TPC electronics time scale.

This object is meant to represent a time on the TPC electronics time axis, starting at the TPC electronics start time.

This time is natively expressed in microseconds.

Definition at line 299 of file DetectorTimingTypes.h.

An interval on the TPC electronics time scale expressed in its ticks.

Definition at line 370 of file DetectorTimingTypes.h.

An interval on the TPC electronics time scale expressed in its ticks (real).

Definition at line 375 of file DetectorTimingTypes.h.

A point on the trigger time scale expressed in its ticks.

Definition at line 398 of file DetectorTimingTypes.h.

A point on the trigger time scale expressed in its ticks (real).

Definition at line 401 of file DetectorTimingTypes.h.

A point in time on the trigger time scale.

This object is nothing special, but it is meant to represent a time on the trigger time axis, starting at the hardware trigger time.

This time is natively expressed in microseconds.

Definition at line 327 of file DetectorTimingTypes.h.

An interval on the trigger time scale expressed in its ticks.

Definition at line 404 of file DetectorTimingTypes.h.

An interval on the trigger time scale expressed in its ticks (real).

Definition at line 407 of file DetectorTimingTypes.h.

Variable Documentation

template<typename T >
constexpr bool detinfo::timescales::is_tick_v = is_tick_type<T>()

Whether the specified time T is tick-based.

Definition at line 416 of file DetectorTimingTypes.h.