Flag heater events by their regular timing. More...

Inheritance diagram for MPulserFlagByRegularTiming:

Public Member Functions
void	Init (Diana::QEvent &ev)
	Init method. More...

void	Do (Diana::QEvent &ev)
	Do method. More...

void	Done ()
	Done method. More...

Private Attributes
double	fExpectedTimeInterval
	Pulser expected time interval in sec. More...

double	fFalsePositiveRate
	False positive rate. More...

int	fMaxRandomCoincidentEvents
	If UseCoincidence = true, the maximum number of allowed coincident events in different heater groups if the timing of the current event is wrong. More...

int	fNecessaryCoincidentEvents
	If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group if the timing of the current event is right. More...

int	fSufficientCoincidentEvents
	If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group regardless of whether the timing of the current event is right. More...

std::vector< double >	fTimeAdjustments
	Time adjustments. More...

double	fTimeIntervalStepSize
	Step size for scan of time intervals. More...

double	fTimeIntervalUncertainty
	Uncertainty in expected heater time interval. More...

std::map< int, QTimingAnalyzer >	fTimingAnalyzer
	Timing analyzer for each channel. More...

double	fTimeTolerance
	Time tolerance. More...

bool	fUseCoincidences
	Whether or not to use coincidences. More...

Detailed Description

Flag heater events by their regular timing.

Author: Adam Bryant (adam_.nosp@m.brya.nosp@m.nt@be.nosp@m.rkel.nosp@m.ey.ed.nosp@m.u) and Marco Vignati

Config example:

   module PulserFlagByRegularTiming
   verbosity = info
   enable = true
   ExpectedTimeInterval = 305.536
   TimeIntervalUncertainty = 0.500
   TimeIntervalStepSize = 0.008
   NumberOfTimeAdjustments = 2
   TimeAdjustment_1 = 267.224
   TimeAdjustment_2 = 343.448
   TimeTolerance = 1.0
   FalsePositiveRate = 0.001
   UseCoincidence = false
   NecessaryCoincidentEvents = 2
   SufficientCoincidentEvents = 5
   MaxRandomCoincidentEvents = 2
   endmod

Parameters
- ExpectedTimeInterval [double = 305.536]:
  Time interval between heater pulses (seconds)
- TimeIntervalUncertainty [double = 0.500]: Uncertainty in expected time interval between heater pulses (seconds)
- TimeIntervalStepSize [double = 0.008]:
  Module will attempt to find the interval between heater pulses by scanning between ExpectedTimeInterval - TimeIntervalUncertainty and ExpectedTimeInterval + TimeIntervalUncertainty in steps of size TimeIntervalStepSize (seconds)
- NumberOfTimeAdjustments [int = 0]:
  For some channels, the high-energy and low-energy heater pulses do not occur at the ExpectedTimeInterval. The time adjustment parameters are offsets to apply to the time of high-energy or low-energy heater pulses to bring their adjusted times into synchronization with the stabilization heater pulses. An arbitrary number of time adjustments can be given, but the number should be specified in NumberOfTimeAdjustments.
- TimeAdjustment_1 [double]:
  First time adjustment, for example the time offset required to bring the high-energy heater pulses into sync with the stabilization heater pulses.
- TimeAdjustment_2 [double]:
  Second time adjustment, for example the time offset required to bring the low-energy heater pulses into sync with the stabilization heater pulses.
- TimeTolerance [double = 1.0]:
  Module will search for events separated by ExpectedTimeInterval within +/- TimeTolerance (seconds)
- FalsePositiveRate [double = 0.001]:
  Desired false positive rate under the null hypothesis that the events passing the filters are randomly distributed. (The true false positive rate is different from this because the events passing the filters should be mostly uniformly distributed heater pulses.)
- UseCoincidence [bool = false]:
  Whether or not to use coincidences on the same heater group to help flag heater events and reduce the false positive rate
- NecessaryCoincidentEvents [int = 2]:
  If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group if the timing of the current event is right
- SufficientCoincidentEvents [int = 5]:
  If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group regardless of whether the timing of the current event is right
- MaxRandomCoincidentEvents [int = 2]:
  If UseCoincidence = true, the maximum number of allowed coincident events in different heater groups if the timing of the current event is wrong
Reads:
- DAQ@Pulse (QHeader)
- DAQ@QPulseInfo (QPulseInfo)
- CoincidenceTiming_PulserFlag@Timing (QCoincidenceTiming)
Writes
- IsPulser (QBool)
- Goodness (QInt)
- GoodnessThreshold (QInt)

Definition at line 94 of file MPulserFlagByRegularTiming.hh.

Member Function Documentation

◆ Do()

void MPulserFlagByRegularTiming::Do ( Diana::QEvent & ev )

Do method.

Definition at line 62 of file MPulserFlagByRegularTiming.cc.

References channel, QCoincidenceTiming::fNumberOfCoincidentEvents, QCoincidenceTiming::fNumberOfCoincidentEvents_SameHeaterGroup, QEvent::Get(), and QHeader::GetTime().

◆ Done()

void MPulserFlagByRegularTiming::Done ( )

Done method.

Definition at line 118 of file MPulserFlagByRegularTiming.cc.

References QTimingAnalyzer::ComputeGoodnessThreshold(), QTimingAnalyzer::FindPeriod(), QTimingAnalyzer::GetPeriod(), QTimingAnalyzer::SetAdjustments(), QTimingAnalyzer::SetExpectedPeriod(), and QTimingAnalyzer::SetTolerance().

◆ Init()

void MPulserFlagByRegularTiming::Init ( Diana::QEvent & ev )

Init method.

Definition at line 17 of file MPulserFlagByRegularTiming.cc.

Member Data Documentation

◆ fExpectedTimeInterval

double MPulserFlagByRegularTiming::fExpectedTimeInterval

private

Pulser expected time interval in sec.

Definition at line 108 of file MPulserFlagByRegularTiming.hh.

◆ fFalsePositiveRate

double MPulserFlagByRegularTiming::fFalsePositiveRate

private

False positive rate.

Definition at line 111 of file MPulserFlagByRegularTiming.hh.

◆ fMaxRandomCoincidentEvents

int MPulserFlagByRegularTiming::fMaxRandomCoincidentEvents

private

If UseCoincidence = true, the maximum number of allowed coincident events in different heater groups if the timing of the current event is wrong.

Definition at line 118 of file MPulserFlagByRegularTiming.hh.

◆ fNecessaryCoincidentEvents

int MPulserFlagByRegularTiming::fNecessaryCoincidentEvents

private

If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group if the timing of the current event is right.

Definition at line 124 of file MPulserFlagByRegularTiming.hh.

◆ fSufficientCoincidentEvents

int MPulserFlagByRegularTiming::fSufficientCoincidentEvents

private

If UseCoincidence = true, the minimum number of required coincident events (not counting the current event) in the same heater group regardless of whether the timing of the current event is right.

Definition at line 130 of file MPulserFlagByRegularTiming.hh.