MHeaterFlagByRegularTiming Class Reference
[Modules]

Inheritance diagram for MHeaterFlagByRegularTiming:

MSetHeaterFlag QModule QBaseModule

List of all members.


Detailed Description

Flag heater events by their regular timing.

Author:
Adam Bryant (adam_bryant@berkeley.edu)
  • Config example:
        module HeaterFlagByRegularTiming
        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
        FlagRawEvent = false
        FlagName = HeaterFlagByRegularTiming
        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
    • FlagRawEvent [bool = false]:
      Whether or not to modify QRawEvent
    • FlagName [string = HeaterFlagByRegularTiming]:
      AuxData flag name


Public Member Functions

 MHeaterFlagByRegularTiming (QSequence *s)
 constructor
 ~MHeaterFlagByRegularTiming ()
 destructor
void Init ()
 Init method.
QEventDo (QEvent *ev)
 Do method.
void Done ()
 Done method.

Private Attributes

double fExpectedTimeInterval
 Heater expected time interval in sec.
double fFalsePositiveRate
 False positive rate.
std::string fFlagName
 AuxData variable name.
bool fFlagRawEvent
 Whether to modify raw event or not.
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.
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.
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.
std::vector< double > fTimeAdjustments
 Time adjustments.
double fTimeIntervalStepSize
 Step size for scan of time intervals.
double fTimeIntervalUncertainty
 Uncertainty in expected heater time interval.
std::map< int, QTimingAnalyzerfTimingAnalyzer
 Timing analyzer for each channel.
double fTimeTolerance
 Time tolerance.
bool fUseCoincidences
 Whether or not to use coincidences.

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

Generated on Tue Nov 16 10:50:02 2010 for CUORE Software by  doxygen 1.5.6