anndata.acc.GraphAcc

anndata.acc.GraphAcc#

class anndata.acc.GraphAcc(dim, k, *, ref_class)[source]#

Bases: RefAcc[R, Idx2D]

Reference accessor for arrays from graph containers (A.obsp/A.varp).

Examples

>>> from anndata.acc import A, GraphAcc
>>> assert isinstance(A.obsp["distances"], GraphAcc)
>>> A.obsp["distances"][:, "cell-1"]
A.obsp['distances'][:, 'cell-1']

Attributes

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

Axis this accessor refers to, e.g. A.varp[k].dim == "var".

k: str[source]#

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

ref_class: type[AdRef[Hashable]][source]#

Methods

dims(idx, /)[source]#

Get along which dimensions the referenced array is.

Return type:

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

get(adata, idx, /)[source]#

Get the referenced array from the AnnData object.

Return type:

ndarray | MaskedArray | csr_matrix | csc_matrix | csr_array | csc_array | Array | ndarray | spmatrix

idx_repr(idx)[source]#

Get a string representation of the index.

Return type:

str

isin(adata, idx=None)[source]#

Check if the referenced array is in the AnnData object.

Return type:

bool

process_idx(idx, /)[source]#
Return type:

tuple[str | slice, slice] | tuple[slice, str | slice]

Contents