cellrank.models.Obsm

class cellrank.models.Obsm(key, column)[source]

A single column of an obsm array or DataFrame.

Parameters:
  • key (str) – Key in obsm.

  • column (int | str) – Column to select: an integer position for an array, or a label for a DataFrame.

Attributes table

layer

Layer the values are fetched from, if any.

name

Human-readable name, used for titles, labels and result keys.

use_raw

Whether the values are fetched from raw.

ylabel

Default y-axis label used when the signal name is shown as a title instead.

key

column

Methods table

fetch(adata, *[, dtype])

Return the signal as a dense 1D ndarray aligned to obs_names.

validate(adata)

Raise a descriptive error if this signal cannot be fetched from adata.

Attributes

layer

Obsm.layer: str | None = None

Layer the values are fetched from, if any. Only meaningful for Gene.

name

Obsm.name

use_raw

Obsm.use_raw: bool = False

Whether the values are fetched from raw. Only meaningful for Gene.

ylabel

Obsm.ylabel: str = 'value'

Default y-axis label used when the signal name is shown as a title instead.

key

Obsm.key: str

column

Obsm.column: int | str

Methods

fetch

Obsm.fetch(adata, *, dtype=<class 'numpy.float64'>)

Return the signal as a dense 1D ndarray aligned to obs_names.

Return type:

ndarray

Parameters:

validate

Obsm.validate(adata)[source]

Raise a descriptive error if this signal cannot be fetched from adata.

Return type:

None

Parameters:

adata (AnnData)