Skip to content

sort_dataset_by_coordinate

Classes:

Name Description
SortDatasetByCoordinate

Classes#

SortDatasetByCoordinate #

Bases: QualityHandler

Sorts the dataset by the failed variable, if there are any failures.

Classes:

Name Description
Parameters

Methods:

Name Description
run

Attributes:

Name Type Description
parameters Parameters

Attributes#

parameters class-attribute instance-attribute #
parameters: Parameters = Parameters()

Classes#

Parameters #

Bases: BaseModel

Attributes:

Name Type Description
ascending bool

Whether to sort the dataset in ascending order. Defaults to True.
correction str
Attributes#
ascending class-attribute instance-attribute # 
ascending: bool = True

Whether to sort the dataset in ascending order. Defaults to True.

correction class-attribute instance-attribute # 
correction: str = (
    "Coordinate data was sorted in order to ensure monotonicity."
)

Functions#

run #
run(
    dataset: xr.Dataset,
    variable_name: str,
    failures: NDArray[np.bool_],
) -> xr.Dataset
Source code in tsdat/qc/handlers/sort_dataset_by_coordinate.py 
25
26
27
28
29
30
31
32
33
34
35
36
def run(
    self,
    dataset: xr.Dataset,
    variable_name: str,
    failures: NDArray[np.bool_],
) -> xr.Dataset:
    if failures.any():
        dataset = dataset.sortby(variable_name, ascending=self.parameters.ascending)  # type: ignore
        record_corrections_applied(
            dataset, variable_name, self.parameters.correction
        )
    return dataset

Modules#