spatialdata.concatenate

Contents

spatialdata.concatenate#

spatialdata.concatenate(sdatas, region_key=None, instance_key=None, concatenate_tables=False, **kwargs)#

Concatenate a list of spatial data objects.

Parameters:
  • sdatas (list[SpatialData]) – The spatial data objects to concatenate.

  • region_key (Optional[str] (default: None)) – The key to use for the region column in the concatenated object. If all region_keys are the same, the region_key is used.

  • instance_key (Optional[str] (default: None)) – The key to use for the instance column in the concatenated object.

  • concatenate_tables (bool (default: False)) – Whether to merge the tables in case of having the same element name.

  • kwargs (Any) – See anndata.concat() for more details.

Return type:

SpatialData

Returns:

: The concatenated spatialdata.SpatialData object.