act.qc.QCFilter.add_delta_test¶
- QCFilter.add_delta_test(var_name, diff_limit=1, test_meaning=None, limit_attr_name=None, test_assessment='Indeterminate', test_number=None, flag_value=False, prepend_text=None)¶
Method to perform a difference test on adjacent values in time series. Will flag both values where a difference is greater than or equal to the difference limit. Tested with 1-D data only. Not sure what will happen with higher dimentioned data.
- Parameters:
var_name (str) – Data variable name.
diff_limit (int or float) – Difference limit
test_meaning (str) – Optional text description to add to flag_meanings describing the test. Will use a default if not set.
limit_attr_name (str) – Optional attribute name to store the limit_value under quality control ancillary variable.
test_assessment (str) – Optional single word describing the assessment of the test. Will use a default if not set.
test_number (int) – Optional test number to use. If not set will use next available test number.
flag_value (boolean) – Indicates that the tests are stored as integers not bit packed values in quality control variable.
prepend_text (str) – Optional text to prepend to the test meaning. Example is indicate what institution added the test.
- Returns:
test_info (tuple) – A tuple containing test information including var_name, qc variable name, test_number, test_meaning, test_assessment