Public Member Functions | Public Attributes | List of all members
diagnostic_updater._update_functions.FrequencyStatusParam Class Reference

Public Member Functions

def __init__ (self, freq_bound, tolerance=0.1, window_size=5)
 

Public Attributes

 freq_bound
 
 tolerance
 
 window_size
 

Detailed Description

A structure that holds the constructor parameters for the FrequencyStatus
class.

Implementation note: the min_freq and max_freq parameters in the C += 1 code
are stored as pointers, so that if they are updated, the new values are used.
To emulate this behavior, we here use a dictionary to hold them: {'min','max'}

freq_bound is a dictionary with keys 'min' and 'max', containing the min
and max acceptable frequencies.

tolerance is the tolerance with which bounds must be satisfied. Acceptable
values are from freq_bound['min'] * (1 - torelance) to
freq_bound['max'] * (1 + tolerance). Common use cases are to set
tolerance to zero, or to assign the same value to freq_bound['min'] and
freq_bound['max']

window_size is the number of events to consider in the statistics.

Definition at line 43 of file _update_functions.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._update_functions.FrequencyStatusParam.__init__ (   self,
  freq_bound,
  tolerance = 0.1,
  window_size = 5 
)
Creates a filled-out FrequencyStatusParam.

Definition at line 63 of file _update_functions.py.

Member Data Documentation

◆ freq_bound

diagnostic_updater._update_functions.FrequencyStatusParam.freq_bound

Definition at line 65 of file _update_functions.py.

◆ tolerance

diagnostic_updater._update_functions.FrequencyStatusParam.tolerance

Definition at line 66 of file _update_functions.py.

◆ window_size

diagnostic_updater._update_functions.FrequencyStatusParam.window_size

Definition at line 67 of file _update_functions.py.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Tue Nov 15 2022 03:17:19