anndata.acc.MultiAcc

class anndata.acc.MultiAcc(dim, k, *, ref_class)

Bases: RefAcc[R, int]

Reference accessor for arrays from multi-dimensional containers (A.obsm/A.varm).

Examples

>>> from anndata.acc import A, MultiAcc
>>> assert isinstance(A.obsm["pca"], MultiAcc)
>>> A.obsm["pca"][:, 0]
A.obsm['pca'][:, 0]

Note that something like this is invalid, as it references an array that isn’t aligned to an anndata dimension.

A.varm["PCs"]["cell-0", :]

Attributes

dim: Literal['obs', 'var']

Dimension this accessor refers to, e.g. A.obsm[k].dim == 'obs'.

k: str

Key this accessor refers to, e.g. A.varm['x'].k == 'x'.

ref_class: type[AdRef[Hashable]]

Methods

dims(i, /)

Get along which dimensions the referenced array is.

Return type:

Collection[Literal['obs', 'var']]

get(adata, i, /)

Get the referenced array from the AnnData object.

Return type:

anndata.typing.InMemoryArray

idx_repr(i)

Get a string representation of the index.

Return type:

str

isin(adata, idx=None)

Check if the referenced array is in the AnnData object.

Return type:

bool

static process_idx(i, /)