liana.utils.spatial_neighbors

liana.utils.spatial_neighbors#

liana.utils.spatial_neighbors(adata, bandwidth=None, cutoff=0.1, max_neighbours=100, kernel='gaussian', set_diag=False, zoi=0, standardize=False, reference=None, spatial_key='spatial', key_added='spatial', inplace=True)#

Generate spatial connectivity weights using Euclidean distance.

Parameters:

  • adata (AnnData) – Annotated data object.

  • bandwidth (float (default: None)) – Denotes signaling length and controls the maximum distance at which two spots/cells are considered. Corresponds to the units in which spatial coordinates are expressed.

  • cutoff (float (default: 0.1)) – Values below this cutoff will be set to 0.

  • max_neighbours (int (default: 100)) – Maximum nearest neighbours to be considered when generating spatial connectivity weights. Essentially, the maximum number of edges in the spatial connectivity graph.

  • kernel (str (default: 'gaussian')) – Kernel function used to generate connectivity/proximity weights. It controls the shape of the connectivity weights. The following options are available: [‘gaussian’, ‘exponential’, ‘linear’, ‘misty_rbf’].

  • set_diag (bool (default: False)) – Logical, sets connectivity diagonal to 0 if False. Default is True.

  • zoi (float (default: 0)) – Zone of indifference. Values below this cutoff will be set to np.inf.

  • standardize (bool (default: False)) – Whether to (l1) standardize spatial proximities (connectivities) so that they sum to 1. This plays a role when weighing border regions prior to downstream methods, as the number of spots in the border region (and hence the sum of proximities) is smaller than the number of spots in the center. Relevant for methods with unstandardized scores (e.g. product). Default is False.

  • reference (Union[Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], complex, bytes, str, _NestedSequence[complex | bytes | str]] (default: None)) – Reference coordinates to use when generating spatial connectivity weights. If None, uses the spatial coordinates in adata.obsm[spatial_key]. This is only relevant if you want to use a different set of coordinates to generate spatial connectivity weights.

  • spatial_key (str (default: 'spatial')) – Key in adata.obsm that contains the spatial coordinates. Default is 'spatial'.

  • key_added (str (default: 'spatial')) – Key to add to adata.obsp if inplace = True. If reference is not None, key will be added to adata.obsm.

  • inplace (bool (default: True)) – Whether to store results in place, or else to return them.

Notes

This function is adapted from mistyR, and is set to be consistent with the squidpy.gr.spatial_neighbors function in the squidpy package.

Return type:

ndarray | None

Returns:

If inplace = False, returns an np.array with spatial connectivity weights. Otherwise, modifies the adata object with the following key:

the aforementioned array

Raises:

  • ValueError – If no cutoff or bandwith are provided

  • AssertionError – If the provided spatial_key is not in adata.obs or if kernel function is not valid.

Examples

See here [1] or here [2].