dynamo.vf.curl(adata, basis='umap', vector_field_class=None, method='analytical', **kwargs)[source]

Calculate Curl for each cell with the reconstructed vector field function. AnnData object is updated with the ‘curl’ information in the . obs. When vector field has three dimension, adata.obs[‘curl’] (magnitude of curl) and adata.obsm[‘curl’] (curl vector) will be added; when vector field has two dimension, only adata.obs[‘curl’] (magnitude of curl) will be provided.

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

  • basis (str) – The embedding data in which the vector field was reconstructed.

  • vector_field_class (Optional[BaseVectorField]) – If not None, the divergene will be computed using this class instead of the vector field stored in adata.

  • method (str) – The method that will be used for calculating curl, either analytical or numeric. analytical method will use the analytical form of the reconstructed vector field for calculating curl while numeric method will use numdifftools for calculation. analytical method is much more efficient.

  • kwargs – Any additional keys that will be passed to vector_field_class.compute_curl function.