dynamo.pl.show_landscape
- dynamo.pl.show_landscape(adata, Xgrid, Ygrid, Zgrid, basis='umap', save_show_or_return='show', save_kwargs={})[source]
Plot the quasi-potential landscape.
- Parameters:
adata (
AnnData) – an AnnData object that contains Xgrid, Ygrid and Zgrid data for visualizing potential landscape.Xgrid (
ndarray) – x-coordinates of the Grid produced from the meshgrid function.Ygrid (
ndarray) – y-coordinates of the Grid produced from the meshgrid function.Zgrid (
ndarray) – z-coordinates or potential at each of the x/y coordinate.basis (
str) – the method of dimension reduction. By default, it is trimap. Currently, it is not checked with Xgrid and Ygrid. Defaults to “umap”.save_show_or_return (
Literal['save','show','return']) – whether to save, show, or return the generated figure. Defaults to “show”.save_kwargs (
Dict[str,Any]) – a dictionary that will be passed to the save_show_ret function. By default, it is an empty dictionary and the save_show_ret function will use the {“path”: None, “prefix”: ‘show_landscape’, “dpi”: None, “ext”: ‘pdf’, “transparent”: True, “close”: True, “verbose”: True} as its parameters. Otherwise, you can provide a dictionary that properly modify those keys according to your need. Defaults to {}.
- Return type:
- Returns:
None would be returned by default. If save_show_or_return is set to be ‘return’, the matplotlib axes of the figure would be returned.