mantispy.get.features

Contents

mantispy.get.features#

mantispy.get.features(adata, object=None, feature_group=None, channel=None, key=None, canonical_channels=False)#

Names of the features matching every filter given.

Parameters:

  • adata (AnnData) – Object to query.

  • object (str | None (default: None)) – Exact matches against the parsed var columns of the same name.

  • feature_group (str | None (default: None)) – Exact matches against the parsed var columns of the same name.

  • channel (str | None (default: None)) – Matches any component of a multi-channel value, so "DNA" selects "DNA|ER" colocalization features too.

  • key (str | None (default: None)) – Restrict to features where this boolean var column is true, e.g. "selected".

  • canonical_channels (bool (default: False)) – Compare channels through canonical_channel, so that channel="DNA" also matches a dataset whose nuclear stain is named Hoechst or DAPI.

Return type:

list[str]

Returns:

Feature names, in var order.

Raises:

KeyError – key names a column var does not have.

Contents