act.qc.QCFilter.add_inside_test¶
- QCFilter.add_inside_test(var_name, limit_value_lower, limit_value_upper, test_meaning=None, test_assessment='Bad', test_number=None, flag_value=False, limit_attr_names=None, prepend_text=None, use_dask=False)¶
Method to perform a greater than or less than test (i.e. between minimum and maximum value) and add result to ancillary quality control variable. If ancillary quality control variable does not exist it will be created.
- Parameters:
var_name (str) – Data variable name.
limit_value_lower (int or float) – Lower limit value to use in test. The value will be written to the quality control variable as an attribute.
limit_value_upper (int or float) – Upper limit value to use in test. The value will be written to the quality control variable as an attribute.
test_meaning (str) – The optional text description to add to flag_meanings describing the test. Will add a default if not set.
test_assessment (str) – Optional single word describing the assessment of the test. Will set a default if not set.
test_number (int) – Optional test number to use. If not set will ues next available test number.
flag_value (boolean) – Indicates that the tests are stored as integers not bit packed values in quality control variable.
limit_attr_names (list of str) – Optional attribute name to store the limit_value under quality control ancillary variable. First value is lower limit attribute name and second value is upper limit attribute name.
prepend_text (str) – Optional text to prepend to the test meaning. Example is indicate what institution added the test.
use_dask (boolean) – Option to use Dask for searching if data is stored in a Dask array
- Returns:
test_info (tuple) – A tuple containing test information including var_name, qc variable name, test_number, test_meaning, test_assessment