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 fromadata.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 toadata.obsm["X_spatial_random"]
.basis (
Optional
[str
] (default:'spatial'
)) – Coordinates inadata.obsm[X_{basis}]
to use. Defaults tospatial
.
- Return type
- Returns
If
return_positions = True
, returns a list of the randomized coordinates corresponding to the coordinates inadata.obsm["X_spatial"]
. Otherwise, these coordinates are assigned toadata.obsm["X_spatial_random"]
.