metobs_toolkit.dataset.Dataset.make_gee_plot#

Dataset.make_gee_plot(gee_manager: GEEStaticDatasetManager | GEEDynamicDatasetManager = GEEStaticDatasetManager(name=LCZ, location=RUB / RUBCLIM / LCZ / global_lcz_map / latest), timeinstance: Timestamp | str | None = None, modelobstype: str = None, save: bool = False, filepath: str | PathLike = None, vmin: int | float | None = None, vmax: int | float | None = None, overwrite: bool = False, initialize_gee: bool = True)[source]#

Create an interactive spatial plot of the GEE dataset and stations.

This method generates an interactive plot of the GEE dataset and the stations are added as markers on it. The interactive plot (a folium map) can be displayed in a Jupyter notebook (or Ipython console) or saved as an HTML file.

If a GEEDynamicDatasetManager is used, the timeinstance and modelobstype parameters are required to specify the time and model variable for the plot.

Parameters:

  • gee_manager (GEEStaticDatasetManager | GEEDynamicDatasetManager, optional) – The GEE dataset manager to plot. If a GEEDynamicDatasetManager is provided, a timinstance and modelobstype is required. The default is default_datasets[“LCZ”]

  • timeinstance (pandas.Timestamp or string or None, optional) – The timinstance to plot the GEE dataset for. This is only used and required when gee_manager is a GEEDynamicDatasetManager. The default is None.

  • modelobstype (str, optional) – The modelobstype to plot the GEE dataset for. This is only used and required when gee_manager is a GEEDynamicDatasetManager. The default is None.

  • save (bool, optional) – If True, the plot will be saved as a (HTML) file, that can be opened by a webbrowser. The default is False.

  • filepath (str or path-like or None, optional) – Path to the file to save the HTML output, if save is True. If the path does not end with ‘.html’, it will be appended. If None, defaults to ‘gee_plot.html’ in the current working directory. Default is None.

  • vmin (int | float | None, optional) – The minimum value for the color scale of the plot. If None, the scale is determined automatically. The default is None.

  • vmax (int | float | None, optional) – The maximum value for the color scale of the plot. If None, the scale is determined automatically. The default is None.

  • overwrite (bool, optional) – If True, the plot will be overwritten if it already exists. This is only relevant when save is True. The default is False.

  • initialize_gee (bool, optional) – If True, initializes the GEE API before creating the plot. Default is True.

Returns:

The interactive map.

Return type:

geemap.foliummap.Map

On this page
Show Source