Source code for cf_xarray.groupers

from dataclasses import dataclass

import numpy as np
import pandas as pd
from xarray import Variable
from xarray.groupers import EncodedGroups, Grouper, UniqueGrouper




@dataclass
class FlagGrouper(Grouper):
    """
    Grouper object that allows convenient categorical grouping by a CF flag variable.

    Labels in the grouped output will be restricted to those listed in ``flag_meanings``.
    """



    def factorize(self, group) -> EncodedGroups:
        if "flag_values" not in group.attrs or "flag_meanings" not in group.attrs:
            raise ValueError(
                "FlagGrouper can only be used with flag variables that have"
                "`flag_values` and `flag_meanings` specified in attrs."
            )

        values = np.array(group.attrs["flag_values"])
        full_index = pd.Index(group.attrs["flag_meanings"].split(" "))

        grouper = UniqueGrouper(labels=values)

        # TODO: we could optimize here, since `group` is already factorized,
        # but there are subtleties. For example, the attrs must be up to date,
        # any value that is not in flag_values will cause an error, etc.
        ret = grouper.factorize(group)

        ret.codes.attrs.pop("flag_values")
        ret.codes.attrs.pop("flag_meanings")

        return EncodedGroups(
            codes=ret.codes,
            full_index=full_index,
            unique_coord=Variable(
                dims=ret.codes.name, data=np.array(full_index), attrs=ret.codes.attrs
            ),
            group_indices=ret.group_indices,
        )




    def reset(self):
        raise NotImplementedError()