Skip to content

record_quality_results

Classes#

RecordQualityResults #

Bases: QualityHandler

Records the results of the quality check in an ancillary qc variable. Creates the ancillary qc variable if one does not already exist.

Attributes#

parameters instance-attribute #
parameters: Parameters

Classes#

Parameters #

Bases: BaseModel

Attributes#
assessment instance-attribute # 
assessment: Literal['bad', 'indeterminate']

Indicates the quality of the data if the test results indicate a failure.

bit class-attribute instance-attribute # 
bit: Optional[int] = None

DEPRECATED

The bit number (e.g., 1, 2, 3, ...) used to indicate if the check passed.

The quality results are bitpacked into an integer array to preserve space. For example, if 'check #0' uses bit 0 and fails, and 'check #1' uses bit 1 and fails then the resulting value on the qc variable would be 2^(0) + 2^(1) = 3. If we had a third check it would be 2^(0) + 2^(1) + 2^(2) = 7.

meaning instance-attribute # 
meaning: str

A string that describes the test applied.

Functions#
deprecate_bit_parameter # 
deprecate_bit_parameter(
    values: Dict[str, Any]
) -> Dict[str, Any]
Source code in tsdat/qc/handlers/record_quality_results.py 
39
40
41
42
43
@root_validator(pre=True)
def deprecate_bit_parameter(cls, values: Dict[str, Any]) -> Dict[str, Any]:
    if "bit" in values:
        logger.warning("The 'bit' argument is deprecated, please remove it.")
    return values
to_lower # 
to_lower(assessment: Any) -> str
Source code in tsdat/qc/handlers/record_quality_results.py 
45
46
47
48
49
50
51
@validator("assessment", pre=True)
def to_lower(cls, assessment: Any) -> str:
    if isinstance(assessment, str):
        return assessment.lower()
    raise ValueError(
        f"assessment must be 'bad' or 'indeterminate', not {assessment}"
    )

Functions#

get_next_bit_number #
get_next_bit_number(
    dataset: xr.Dataset, variable_name: str
) -> int
Source code in tsdat/qc/handlers/record_quality_results.py 
67
68
69
70
71
72
73
74
75
76
def get_next_bit_number(self, dataset: xr.Dataset, variable_name: str) -> int:
    if (qc_var := dataset.get(f"qc_{variable_name}")) is None:
        return 1
    masks = qc_var.attrs.get("flag_masks")
    if not isinstance(masks, list):
        raise ValueError(
            f"QC Variable {qc_var.name} is not standardized. Expected 'flag_masks'"
            f" attribute to be like [1, 2, ...], but found '{masks}'"
        )
    return len(masks) + 1  # type: ignore
run #
run(
    dataset: xr.Dataset,
    variable_name: str,
    failures: NDArray[np.bool_],
) -> xr.Dataset
Source code in tsdat/qc/handlers/record_quality_results.py 
55
56
57
58
59
60
61
62
63
64
65
def run(
        self, dataset: xr.Dataset, variable_name: str, failures: NDArray[np.bool_]
) -> xr.Dataset:
    dataset.qcfilter.add_test(
        variable_name,
        index=failures if failures.any() else None,
        test_number=self.get_next_bit_number(dataset, variable_name),
        test_meaning=self.parameters.meaning,
        test_assessment=self.parameters.assessment,
    )
    return dataset