metobs_toolkit.dataset.Dataset.make_gee_plot#

Dataset.make_gee_plot(geedatasetmanager: ~metobs_toolkit.geedatasetmanagers.GEEStaticDatasetManager | ~metobs_toolkit.geedatasetmanagers.GEEDynamicDatasetManager = GeeStaticDatasetManager representation of LCZ, timeinstance: ~pandas._libs.tslibs.timestamps.Timestamp | str | None = None, modelobstype: str = None, save: bool = False, outputfolder: str = '/home/docs/checkouts/readthedocs.org/user_builds/metobs-toolkit/checkouts/v0.4.3/docs', filename: str = 'gee_plot.html', vmin: int | float | None = None, vmax: int | float | None = None, overwrite: bool = False)[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:

  • geedatasetmanager (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 geedatasetmanager 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 geedatasetmanager 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.

  • outputfolder (str, optional) – The folder to save the file too. This is only used when save is True. The default is os.getcwd() (the current working directory).

  • filename (str, optional) – The name of the file to save the plot to. This is only used when save is True. The default is “gee_plot.html”.

  • 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.

Returns:

The interactive map.

Return type:

geemap.foliummap.Map

On this page
Show Source