tsdat.qc.checkers
¶
Classes¶
Checks for deltas between consecutive values larger than 'fail_delta'. |
|
Checks for values greater than 'fail_max'. |
|
Checks for values less than 'fail_min'. |
|
Checks for values greater than 'fail_range'. |
|
Checks for values less than 'fail_range'. |
|
Checks if any data are missing. A variable's data are considered missing if they are |
|
Checks if any values are not ordered strictly monotonically (i.e. values must all be |
|
Checks for deltas between consecutive values larger than 'valid_delta'. |
|
Checks for values greater than 'valid_max'. |
|
Checks for values less than 'valid_min'. |
|
Checks for values greater than 'valid_range'. |
|
Checks for values less than 'valid_range'. |
|
Checks for deltas between consecutive values larger than 'warn_delta'. |
|
Checks for values greater than 'warn_max'. |
|
Checks for values less than 'warn_min'. |
|
Checks for values greater than 'warn_range'. |
|
Checks for values less than 'warn_range'. |
- class tsdat.qc.checkers.CheckFailDelta[source]¶
Bases:
_CheckDelta
Checks for deltas between consecutive values larger than ‘fail_delta’.
- class tsdat.qc.checkers.CheckFailMax[source]¶
Bases:
_CheckMax
Checks for values greater than ‘fail_max’.
- class tsdat.qc.checkers.CheckFailMin[source]¶
Bases:
_CheckMin
Checks for values less than ‘fail_min’.
- class tsdat.qc.checkers.CheckFailRangeMax[source]¶
Bases:
_CheckMax
Checks for values greater than ‘fail_range’.
- class tsdat.qc.checkers.CheckFailRangeMin[source]¶
Bases:
_CheckMin
Checks for values less than ‘fail_range’.
- class tsdat.qc.checkers.CheckMissing[source]¶
Bases:
tsdat.qc.base.QualityChecker
Checks if any data are missing. A variable’s data are considered missing if they are set to the variable’s _FillValue (if it has a _FillValue) or NaN (NaT for datetime- like variables).
Class Methods
Identifies and flags quality problems with the data.
Method Descriptions
- run(self, dataset: xarray.Dataset, variable_name: str) numpy.typing.NDArray[numpy.bool8] [source]¶
Identifies and flags quality problems with the data.
Checks the quality of a specific variable in the dataset and returns the results of the check as a boolean array where True values represent quality problems and False values represent data that passes the quality check.
QualityCheckers should not modify dataset variables; changes to the dataset should be made by QualityHandler(s), which receive the results of a QualityChecker as input.
- Parameters
dataset (xr.Dataset) – The dataset containing the variable to check.
variable_name (str) – The name of the variable to check.
- Returns
NDArray[np.bool8] – The results of the quality check, where True values indicate a quality problem.
- class tsdat.qc.checkers.CheckMonotonic[source]¶
Bases:
tsdat.qc.base.QualityChecker
Checks if any values are not ordered strictly monotonically (i.e. values must all be increasing or all decreasing). The check marks all values as failed if any data values are not ordered monotonically.
Class Methods
Identifies and flags quality problems with the data.
Method Descriptions
- run(self, dataset: xarray.Dataset, variable_name: str) numpy.typing.NDArray[numpy.bool8] [source]¶
Identifies and flags quality problems with the data.
Checks the quality of a specific variable in the dataset and returns the results of the check as a boolean array where True values represent quality problems and False values represent data that passes the quality check.
QualityCheckers should not modify dataset variables; changes to the dataset should be made by QualityHandler(s), which receive the results of a QualityChecker as input.
- Parameters
dataset (xr.Dataset) – The dataset containing the variable to check.
variable_name (str) – The name of the variable to check.
- Returns
NDArray[np.bool8] – The results of the quality check, where True values indicate a quality problem.
- class tsdat.qc.checkers.CheckValidDelta[source]¶
Bases:
_CheckDelta
Checks for deltas between consecutive values larger than ‘valid_delta’.
- class tsdat.qc.checkers.CheckValidMax[source]¶
Bases:
_CheckMax
Checks for values greater than ‘valid_max’.
- class tsdat.qc.checkers.CheckValidMin[source]¶
Bases:
_CheckMin
Checks for values less than ‘valid_min’.
- class tsdat.qc.checkers.CheckValidRangeMax[source]¶
Bases:
_CheckMax
Checks for values greater than ‘valid_range’.
- class tsdat.qc.checkers.CheckValidRangeMin[source]¶
Bases:
_CheckMin
Checks for values less than ‘valid_range’.
- class tsdat.qc.checkers.CheckWarnDelta[source]¶
Bases:
_CheckDelta
Checks for deltas between consecutive values larger than ‘warn_delta’.
- class tsdat.qc.checkers.CheckWarnMax[source]¶
Bases:
_CheckMax
Checks for values greater than ‘warn_max’.
- class tsdat.qc.checkers.CheckWarnMin[source]¶
Bases:
_CheckMin
Checks for values less than ‘warn_min’.