pecos.metrics.qci module

pecos.metrics.qci.qci(mask, tfilter=None, per_day=True)

Quality control index (\(QCI\)) is defined as:

\(QCI=\dfrac{\sum_{d\in D}\sum_{t\in T}X_{dt}}{|DT|}\)

where \(D\) is the set of data columns and \(T\) is the set of timestamps in the analysis. \(X_{dt}\) is a data point for column \(d\) time t` that passed all quality control test. \(|DT|\) is the number of data points in the analysis.

Parameters:

mask : pd.Dataframe

Test results mask, returned from pm.get_test_results_mask()

tfilter : Pandas Series (default = None)

Time filter containing boolean values for each time index

per_day : Boolean (default = True)

Flag indicating if the results shoudl be computed per day

Returns:

QCI : pd.Series

Quality control index