moscot.utils.subset_policy.SubsetPolicy.create_mask#

SubsetPolicy.create_mask(value, *, allow_empty=False)[source]#

Create a mask used to subset the data.

Parameters:

value (Union[TypeVar(K, bound= Hashable), Sequence[TypeVar(K, bound= Hashable)]]) – Values in the data which determine the mask.
allow_empty (bool) – Whether to allow empty mask.

Return type:

ndarray[Any, dtype[float64]]

Returns:

: Boolean mask of the same shape as the data.