Struct FrequencyStatusParam

Struct Documentation

struct FrequencyStatusParam

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

Public Functions

inline FrequencyStatusParam(double *min_freq, double *max_freq, double tolerance = 0.1, int window_size = 5): Creates a filled-out FrequencyStatusParam.

Public Members

double *min_freq_

Minimum acceptable frequency.

A pointer is used so that the value can be updated.

double *max_freq_

Maximum acceptable frequency.

A pointer is used so that the value can be updated.

double tolerance_

Tolerance with which bounds must be satisfied.

Acceptable values are from *min_freq_ * (1 - torelance_) to *max_freq_ * (1 + tolerance_).

Common use cases are to set tolerance_ to zero, or to assign the same value to *max_freq_ and min_freq_.