monkeybread.util.randomize_positions

monkeybread.util.randomize_positions(adata, radius, return_positions=False, basis='spatial')

Randomizes positions within a given radius.

Parameters
  • adata (AnnData) – Annotated data matrix. Coordinates are taken from adata.obsm["X_spatial"].

  • radius (float) – Radius to randomize within. Measured in same units as coordinates.

  • return_positions (Optional[bool] (default: False)) – Whether to return the randomized positions or assign them to adata.obsm["X_spatial_random"].

  • basis (Optional[str] (default: 'spatial')) – Coordinates in adata.obsm[X_{basis}] to use. Defaults to spatial.

Return type

Optional[ndarray]

Returns

If return_positions = True, returns a list of the randomized coordinates corresponding to the coordinates in adata.obsm["X_spatial"]. Otherwise, these coordinates are assigned to adata.obsm["X_spatial_random"].