Bases: ABC
Abstract base class for reference accessors.
See reference accessors for all existing subclasses.
Attributes
-
parent_type[source]
Get the parent to this reference accessor
-
ref_class: type[AdRef[Hashable]][source]
Methods
-
abstractmethod __repr__()[source]
Get a string representation of the accessor.
- Return type:
str
-
abstractmethod dims(idx, /)[source]
Get along which dimensions the referenced array is.
- Return type:
Collection[Literal['obs', 'var']]
-
abstractmethod get(adata, idx, /)[source]
Get the referenced array from the AnnData object.
- Return type:
anndata.typing.InMemoryArray | ExtensionArray | Variable
-
abstractmethod idx_repr(idx, /)[source]
Get a string representation of the index.
- Return type:
str
-
abstractmethod isin(adata, idx=None, /)[source]
Check if the referenced array is in the AnnData object.
- Return type:
bool
-
process_idx(idx, /)[source]
- Return type:
TypeVar(I)