Simple utility to generate gates around beam time. More...

#include <BeamGateMaker.h>

Public Types
using	time_interval = detinfo::timescales::time_interval

using	optical_time = detinfo::timescales::optical_time

using	optical_tick = detinfo::timescales::optical_tick

using	optical_time_ticks = detinfo::timescales::optical_time_ticks

Public Member Functions
	BeamGateMaker (detinfo::DetectorTimings const &detTimings)
	Constructor: uses a copy of the specified detector timing provider. More...

	BeamGateMaker (detinfo::DetectorClocksData const &clockData)
	Constructor: uses the specified detector clocks service. More...

Start and end time
optical_time	startTime (time_interval const delay=DefaultDelay) const

optical_time	endTime (time_interval const duration, time_interval const delay=DefaultDelay) const
	Time of beam gate closure, in optical time scale. More...

optical_tick	startTick (time_interval const delay=DefaultDelay) const

optical_tick	endTick (time_interval const duration, time_interval const delay=DefaultDelay) const
	Time of beam gate closure, in optical ticks. More...


template<typename Gate = icarus::trigger::OpticalTriggerGate>
Gate	make (time_interval length, time_interval delay=DefaultDelay) const
	Returns a gate object of the specified duration. More...

template<typename Gate = icarus::trigger::OpticalTriggerGate>
Gate	operator() (time_interval length, time_interval delay=DefaultDelay) const

Private Attributes
detinfo::DetectorTimings const	fDetTimings
	Detector timing provider. More...

Static Private Attributes
static constexpr util::quantities::microsecond	DefaultDelay { 0.0 }
	Value used for default delay. More...

Detailed Description

Simple utility to generate gates around beam time.

Example: to create an object describing a beam gate of 10 s, run:

using namespace util::quantities::time_literals;
icarus::trigger::BeamGateMaker makeBeamGate
  (*lar::providerFrom<detinfo::DetectorClocks>());
auto const beamGate = makeBeamGate(10_us);

The time of the gate is in optical detector electronics ticks.

Definition at line 49 of file BeamGateMaker.h.

Member Typedef Documentation

using icarus::trigger::BeamGateMaker::optical_tick = detinfo::timescales::optical_tick

Definition at line 61 of file BeamGateMaker.h.

using icarus::trigger::BeamGateMaker::optical_time = detinfo::timescales::optical_time

Definition at line 60 of file BeamGateMaker.h.

using icarus::trigger::BeamGateMaker::optical_time_ticks = detinfo::timescales::optical_time_ticks

Definition at line 62 of file BeamGateMaker.h.

using icarus::trigger::BeamGateMaker::time_interval = detinfo::timescales::time_interval

Definition at line 59 of file BeamGateMaker.h.

Constructor & Destructor Documentation

icarus::trigger::BeamGateMaker::BeamGateMaker ( detinfo::DetectorTimings const & detTimings )

inline

Constructor: uses a copy of the specified detector timing provider.

Definition at line 66 of file BeamGateMaker.h.

67 : fDetTimings(detTimings)

68 {}

icarus::trigger::BeamGateMaker::fDetTimings

detinfo::DetectorTimings const fDetTimings

Detector timing provider.

Definition: BeamGateMaker.h:51

detTimings

fDetProps &fDetProps fDetProps &fDetProps detTimings

Definition: ExtractEnergyDepositionSummary_module.cc:301

icarus::trigger::BeamGateMaker::BeamGateMaker ( detinfo::DetectorClocksData const & clockData )

inline

Constructor: uses the specified detector clocks service.

Definition at line 71 of file BeamGateMaker.h.

72 : BeamGateMaker(detinfo::makeDetectorTimings(clockData)) {}

detinfo::makeDetectorTimings

detinfo::DetectorTimings makeDetectorTimings(detinfo::DetectorClocksData const &detClocks)

Definition: DetectorTimings.h:698

icarus::trigger::BeamGateMaker::BeamGateMaker

BeamGateMaker(detinfo::DetectorTimings const &detTimings)

Constructor: uses a copy of the specified detector timing provider.

Definition: BeamGateMaker.h:66

Member Function Documentation

optical_tick icarus::trigger::BeamGateMaker::endTick	(	time_interval const	duration,
		time_interval const	delay = `DefaultDelay`
	)		const

inline

Time of beam gate closure, in optical ticks.

Definition at line 96 of file BeamGateMaker.h.

98 { return fDetTimings.toOpticalTick(endTime(duration, delay)); }

detinfo::DetectorTimings::toOpticalTick

optical_tick toOpticalTick(TimePoint time) const

Returns the time point converted in units of optical time ticks.

Definition: DetectorTimings.h:578

icarus::trigger::BeamGateMaker::fDetTimings

detinfo::DetectorTimings const fDetTimings

Detector timing provider.

Definition: BeamGateMaker.h:51

icarus::trigger::BeamGateMaker::endTime

optical_time endTime(time_interval const duration, time_interval const delay=DefaultDelay) const

Time of beam gate closure, in optical time scale.

Definition: BeamGateMaker.h:85

optical_time icarus::trigger::BeamGateMaker::endTime	(	time_interval const	duration,
		time_interval const	delay = `DefaultDelay`
	)		const

inline

Time of beam gate closure, in optical time scale.

Definition at line 85 of file BeamGateMaker.h.

87 { return startTime(delay) + duration; }

icarus::trigger::BeamGateMaker::startTime

optical_time startTime(time_interval const delay=DefaultDelay) const

Definition: BeamGateMaker.h:80

template<typename Gate = icarus::trigger::OpticalTriggerGate>

Gate icarus::trigger::BeamGateMaker::make	(	time_interval	length,
		time_interval	delay = `DefaultDelay`
	)		const

inline

Returns a gate object of the specified duration.

Template Parameters

Gate	type of gate object to be returned (default: `icarus::trigger::OpticalTriggerGate`)

Parameters

length	duration of the gate to be open
delay	time from beam gate time when this gate opens (default: `0`)

Returns: a Gate object representing a gate opened at beam gate time

The returned object represents a gate opening at beam gate time (with an optional delay) for the specified duration. The time of the gate is in optical ticks.

Definition at line 120 of file BeamGateMaker.h.

     {
       icarus::trigger::OpticalTriggerGate beamGate;
       beamGate.gateLevels().openFor
         (startTick(delay).value(), fDetTimings.toOpticalTicks(length).value());
       return beamGate;
     }