Skip to content

check_max

Classes#

CheckMax #

Bases: ThresholdChecker, ABC

Checks for values larger than a specified threshold.

The value of the threshold is specified by an attribute on each data variable, and the attribute to search for is specified as a property of this base class.

If the specified attribute does not exist on the variable being checked then no failures will be reported.

Parameters:

Name Type Description Default
attribute_name str

The name of the attribute containing the maximum threshold. If the attribute ends in '_range' then it is assumed to be a list, and the first value from the list will be used as the minimum threshold.

 required
allow_equal bool

True if values equal to the threshold should pass the check, False otherwise.

 required

Functions#

run #
run(
    dataset: xr.Dataset, variable_name: str
) -> Union[NDArray[np.bool_], None]
Source code in tsdat/qc/checkers/check_max.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def run(
        self, dataset: xr.Dataset, variable_name: str
) -> Union[NDArray[np.bool_], None]:
    var_data = dataset[variable_name]
    failures: NDArray[np.bool_] = np.zeros_like(var_data, dtype=np.bool_)  # type: ignore

    max_value = self._get_threshold(dataset, variable_name, min_=False)
    if max_value is None:
        return None

    if self.allow_equal:
        failures = np.greater(var_data.data, max_value)
    else:
        failures = np.greater_equal(var_data.data, max_value)

    return failures