dynamo.vf.speed

dynamo.vf.speed(adata, basis='umap', VecFld=None, method='analytical')[source]

Calculate the speed for each cell with the reconstructed vector field function.

Parameters

  • adata (AnnData) – AnnData object that contains the reconstructed vector field function in the uns attribute.

  • basis (str or None (default: umap)) – The embedding data in which the vector field was reconstructed.

  • VecFld (dict) – The true ODE function, useful when the data is generated through simulation.

  • method (str (default: analytical)) – The method that will be used for calculating speed, either analytical or numeric. analytical method will use the analytical form of the reconstructed vector field for calculating Jacobian. Otherwise, raw velocity vectors are used.

Returns

adata – AnnData object that is updated with the speed key in the .obs.

Return type

AnnData