spatialdata.models.TableModel

class spatialdata.models.TableModel

Attributes table

ATTRS_KEY
INSTANCE_KEY
REGION_KEY
REGION_KEY_KEY

Methods table

parse(adata[, region, region_key, instance_key])	Parse the anndata.AnnData to be compatible with the model.
validate(data)	Validate the data.

Attributes

TableModel.ATTRS_KEY = 'spatialdata_attrs'

TableModel.INSTANCE_KEY = 'instance_key'

TableModel.REGION_KEY = 'region'

TableModel.REGION_KEY_KEY = 'region_key'

Methods

classmethod TableModel.parse(adata, region=None, region_key=None, instance_key=None)

Parse the anndata.AnnData to be compatible with the model.

Parameters:

• adata (AnnData) – The AnnData object.

• region (Union[str, list[str], None] (default: None)) – Region(s) to be used.

• region_key (Optional[str] (default: None)) – Key in adata.obs that specifies the region.

• instance_key (Optional[str] (default: None)) – Key in adata.obs that specifies the instance.

Return type:

AnnData

Returns:

: The parsed data.

TableModel.validate(data)

Validate the data.

Parameters:

data (AnnData) – The data to validate.

Return type:

AnnData

Returns:

: The validated data.