class FrequencyStatusParam:
Constructor: FrequencyStatusParam(freq_bound, tolerance, window_size)
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.
| Method | __init__ |
Creates a filled-out FrequencyStatusParam. |
| Instance Variable | freq |
Undocumented |
| Instance Variable | tolerance |
Undocumented |
| Instance Variable | window |
Undocumented |