Source code for geemap.basemaps

"""Module for basemaps. Each basemap is defined as item in the basemaps dictionary. For example, to access Google basemaps, use the following:

basemaps['ROADMAP'], basemaps['SATELLITE'], basemaps['HYBRID'].

More WMS basemaps can be found at the following websites:

1. USGS National Map: https://viewer.nationalmap.gov/services/

2. MRLC NLCD Land Cover data: https://viewer.nationalmap.gov/services/

3. FWS NWI Wetlands data: https://www.fws.gov/wetlands/Data/Web-Map-Services.html

"""

import collections
import os
import requests
import folium
import ipyleaflet
import xyzservices.providers as xyz
from xyzservices import TileProvider
from .common import check_package, planet_tiles

# Custom XYZ tile services.
xyz_tiles = {
    "OpenStreetMap": {
        "url": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
        "attribution": "OpenStreetMap",
        "name": "OpenStreetMap",
    },
    "ROADMAP": {
        "url": "https://mt1.google.com/vt/lyrs=m&x={x}&y={y}&z={z}",
        "attribution": "Google",
        "name": "Google Maps",
    },
    "SATELLITE": {
        "url": "https://mt1.google.com/vt/lyrs=s&x={x}&y={y}&z={z}",
        "attribution": "Google",
        "name": "Google Satellite",
    },
    "TERRAIN": {
        "url": "https://mt1.google.com/vt/lyrs=p&x={x}&y={y}&z={z}",
        "attribution": "Google",
        "name": "Google Terrain",
    },
    "HYBRID": {
        "url": "https://mt1.google.com/vt/lyrs=y&x={x}&y={y}&z={z}",
        "attribution": "Google",
        "name": "Google Satellite",
    },
}

# Custom WMS tile services.
wms_tiles = {
    "FWS NWI Wetlands": {
        "url": "https://www.fws.gov/wetlands/arcgis/services/Wetlands/MapServer/WMSServer?",
        "layers": "1",
        "name": "FWS NWI Wetlands",
        "attribution": "FWS",
        "format": "image/png",
        "transparent": True,
    },
    "FWS NWI Wetlands Raster": {
        "url": "https://www.fws.gov/wetlands/arcgis/services/Wetlands_Raster/ImageServer/WMSServer?",
        "layers": "0",
        "name": "FWS NWI Wetlands Raster",
        "attribution": "FWS",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2019 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2019_Land_Cover_L48/wms?",
        "layers": "NLCD_2019_Land_Cover_L48",
        "name": "NLCD 2019 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2016 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2016_Land_Cover_L48/wms?",
        "layers": "NLCD_2016_Land_Cover_L48",
        "name": "NLCD 2016 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2013 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2013_Land_Cover_L48/wms?",
        "layers": "NLCD_2013_Land_Cover_L48",
        "name": "NLCD 2013 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2011 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2011_Land_Cover_L48/wms?",
        "layers": "NLCD_2011_Land_Cover_L48",
        "name": "NLCD 2011 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2008 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2008_Land_Cover_L48/wms?",
        "layers": "NLCD_2008_Land_Cover_L48",
        "name": "NLCD 2008 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2006 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2006_Land_Cover_L48/wms?",
        "layers": "NLCD_2006_Land_Cover_L48",
        "name": "NLCD 2006 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2004 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2004_Land_Cover_L48/wms?",
        "layers": "NLCD_2004_Land_Cover_L48",
        "name": "NLCD 2004 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "NLCD 2001 CONUS Land Cover": {
        "url": "https://www.mrlc.gov/geoserver/mrlc_display/NLCD_2001_Land_Cover_L48/wms?",
        "layers": "NLCD_2001_Land_Cover_L48",
        "name": "NLCD 2001 CONUS Land Cover",
        "attribution": "MRLC",
        "format": "image/png",
        "transparent": True,
    },
    "USGS NAIP Imagery": {
        "url": "https://imagery.nationalmap.gov/arcgis/services/USGSNAIPImagery/ImageServer/WMSServer?",
        "layers": "USGSNAIPImagery:NaturalColor",
        "name": "USGS NAIP Imagery",
        "attribution": "USGS",
        "format": "image/png",
        "transparent": True,
    },
    "USGS NAIP Imagery False Color": {
        "url": "https://imagery.nationalmap.gov/arcgis/services/USGSNAIPImagery/ImageServer/WMSServer?",
        "layers": "USGSNAIPImagery:FalseColorComposite",
        "name": "USGS NAIP Imagery False Color",
        "attribution": "USGS",
        "format": "image/png",
        "transparent": True,
    },
    "USGS NAIP Imagery NDVI": {
        "url": "https://imagery.nationalmap.gov/arcgis/services/USGSNAIPImagery/ImageServer/WMSServer?",
        "layers": "USGSNAIPImagery:NDVI_Color",
        "name": "USGS NAIP Imagery NDVI",
        "attribution": "USGS",
        "format": "image/png",
        "transparent": True,
    },
    "USGS Hydrography": {
        "url": "https://basemap.nationalmap.gov/arcgis/services/USGSHydroCached/MapServer/WMSServer?",
        "layers": "0",
        "name": "USGS Hydrography",
        "attribution": "USGS",
        "format": "image/png",
        "transparent": True,
    },
    "USGS 3DEP Elevation": {
        "url": "https://elevation.nationalmap.gov/arcgis/services/3DEPElevation/ImageServer/WMSServer?",
        "layers": "33DEPElevation:Hillshade Elevation Tinted",
        "name": "USGS 3DEP Elevation",
        "attribution": "USGS",
        "format": "image/png",
        "transparent": True,
    },
    "ESA WorldCover 2020": {
        "url": "https://services.terrascope.be/wms/v2",
        "layers": "WORLDCOVER_2020_MAP",
        "name": "ESA Worldcover 2020",
        "attribution": "ESA",
        "format": "image/png",
        "transparent": True,
    },
    "ESA WorldCover 2020 S2 FCC": {
        "url": "https://services.terrascope.be/wms/v2",
        "layers": "WORLDCOVER_2020_S2_FCC",
        "name": "ESA Worldcover 2020 S2 FCC",
        "attribution": "ESA",
        "format": "image/png",
        "transparent": True,
    },
    "ESA WorldCover 2020 S2 TCC": {
        "url": "https://services.terrascope.be/wms/v2",
        "layers": "WORLDCOVER_2020_S2_TCC",
        "name": "ESA Worldcover 2020 S2 TCC",
        "attribution": "ESA",
        "format": "image/png",
        "transparent": True,
    },
}


[docs]def get_xyz_dict(free_only=True, _collection=None, _output=None): """Returns a dictionary of xyz services. Args: free_only (bool, optional): Whether to return only free xyz tile services that do not require an access token. Defaults to True. Returns: dict: A dictionary of xyz services. """ if _collection is None: _collection = xyz if _output is None: _output = {} for v in _collection.values(): if isinstance(v, TileProvider): if not (v.requires_token() and free_only): _output[v.name] = v else: # it's a Bunch get_xyz_dict(free_only, v, _output) return collections.OrderedDict(sorted(_output.items()))
[docs]def xyz_to_leaflet(): """Convert xyz tile services to ipyleaflet tile layers. Returns: dict: A dictionary of ipyleaflet tile layers. """ leaflet_dict = {} for key, tile in xyz_tiles.items(): name = tile["name"] url = tile["url"] attribution = tile["attribution"] leaflet_dict[key] = ipyleaflet.TileLayer( url=url, name=name, attribution=attribution, max_zoom=22 ) for key, tile in wms_tiles.items(): leaflet_dict[key] = ipyleaflet.WMSLayer( url=tile["url"], layers=tile["layers"], name=tile["name"], attribution=tile["attribution"], format=tile["format"], transparent=tile["transparent"], ) for item in get_xyz_dict().values(): leaflet_dict[item.name] = ipyleaflet.TileLayer( url=item.build_url(), name=item.name, max_zoom=item.get("max_zoom", 22), attribution=item.attribution, ) if os.environ.get("PLANET_API_KEY") is not None: planet_dict = planet_tiles(tile_format="ipyleaflet") leaflet_dict.update(planet_dict) return leaflet_dict
[docs]def xyz_to_pydeck(): """Convert xyz tile services to pydeck custom tile layers. Returns: dict: A dictionary of pydeck tile layers. """ check_package("pydeck", "https://deckgl.readthedocs.io/en/latest/installation.html") import pydeck as pdk pydeck_dict = {} for key, tile in xyz_tiles.items(): url = tile["url"] pydeck_dict[key] = url for key, item in get_xyz_dict().items(): url = item.build_url() pydeck_dict[key] = url if os.environ.get("PLANET_API_KEY") is not None: planet_dict = planet_tiles(tile_format="ipyleaflet") for id_, tile in planet_dict.items(): pydeck_dict[id_] = tile.url pdk.settings.custom_libraries = [ { "libraryName": "MyTileLayerLibrary", "resourceUri": "https://cdn.jsdelivr.net/gh/giswqs/pydeck_myTileLayer@master/dist/bundle.js", } ] for key in pydeck_dict: pydeck_dict[key] = pdk.Layer("MyTileLayer", pydeck_dict[key], key) return pydeck_dict
[docs]def xyz_to_folium(): """Convert xyz tile services to folium tile layers. Returns: dict: A dictionary of folium tile layers. """ folium_dict = {} for key, tile in xyz_tiles.items(): folium_dict[key] = folium.TileLayer( tiles=tile["url"], attr=tile["attribution"], name=tile["name"], overlay=True, control=True, max_zoom=22, ) for key, tile in wms_tiles.items(): folium_dict[key] = folium.WmsTileLayer( url=tile["url"], layers=tile["layers"], name=tile["name"], attr=tile["attribution"], fmt=tile["format"], transparent=tile["transparent"], overlay=True, control=True, ) for item in get_xyz_dict().values(): folium_dict[item.name] = folium.TileLayer( tiles=item.build_url(), attr=item.attribution, name=item.name, max_zoom=item.get("max_zoom", 22), overlay=True, control=True, ) if os.environ.get("PLANET_API_KEY") is not None: planet_dict = planet_tiles(tile_format="folium") folium_dict.update(planet_dict) return folium_dict
[docs]def xyz_to_plotly(): """Convert xyz tile services to plotly tile layers. Returns: dict: A dictionary of plotly tile layers. """ plotly_dict = {} for key, tile in xyz_tiles.items(): plotly_dict[key] = { "below": "traces", "sourcetype": "raster", "sourceattribution": tile["attribution"], "source": [tile["url"]], "name": key, } for item in get_xyz_dict().values(): plotly_dict[item.name] = { "below": "traces", "sourcetype": "raster", "sourceattribution": item.attribution, "source": [item.build_url()], "name": item.name, } return plotly_dict
[docs]def xyz_to_heremap(): """Convert xyz tile services to hermap tile layers. Returns: dict: A dictionary of heremap tile layers. """ try: import here_map_widget except ImportError: raise ImportError( 'This module requires the hermap package. Please install it using "pip install here-map-widget-for-jupyter".' ) # Built-in heremap tile services. here_tiles = { "HERE_RASTER_NORMAL_MAP": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.map ), "HERE_RASTER_NORMAL_BASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.base ), "HERE_RASTER_NORMAL_BASE_NIGHT": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.basenight ), "HERE_RASTER_NORMAL_LABELS": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.labels ), "HERE_RASTER_NORMAL_TRANSIT": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.transit ), "HERE_RASTER_NORMAL_XBASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.xbase ), "HERE_RASTER_NORMAL_XBASE_NIGHT": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.normal.xbasenight ), "HERE_RASTER_SATELLITE_MAP": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.satellite.map ), "HERE_RASTER_SATELLITE_LABELS": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.satellite.labels ), "HERE_RASTER_SATELLITE_BASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.satellite.base ), "HERE_RASTER_SATELLITE_XBASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.satellite.xbase ), "HERE_RASTER_TERRAIN_MAP": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.terrain.map ), "HERE_RASTER_TERRAIN_LABELS": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.terrain.labels ), "HERE_RASTER_TERRAIN_BASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.terrain.base ), "HERE_RASTER_TERRAIN_XBASE": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.raster.terrain.xbase ), "HERE_VECTOR_NORMAL_MAP": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.vector.normal.map ), "HERE_VECTOR_NORMAL_TRUCK": here_map_widget.DefaultLayers( layer_name=here_map_widget.DefaultLayerNames.vector.normal.truck ), } heremap_dict = {} for key, tile in xyz_tiles.items(): heremap_dict[key] = here_map_widget.TileLayer( provider=here_map_widget.ImageTileProvider( url=tile["url"], attribution=tile["attribution"], name=tile["name"] ) ) for item in get_xyz_dict().values(): heremap_dict[item.name] = here_map_widget.TileLayer( provider=here_map_widget.ImageTileProvider( url=item.build_url(), attribution=item.attribution, name=item.name, max_zoom=item.get("max_zoom", 22), ) ) heremap_dict.update(here_tiles) return heremap_dict
[docs]def search_qms(keywords, limit=10): """Search qms files for keywords. Reference: https://github.com/geopandas/xyzservices/issues/65 Args: keywords (str): Keywords to search for. limit (int): Number of results to return. """ QMS_API = "https://qms.nextgis.com/api/v1/geoservices" services = requests.get( f"{QMS_API}/?search={keywords}&type=tms&epsg=3857&limit={str(limit)}" ) services = services.json() if services["count"] == 0: return None elif services["count"] <= limit: return services["results"] else: return services["results"][:limit]
[docs]def get_qms(service_id): QMS_API = "https://qms.nextgis.com/api/v1/geoservices" service_details = requests.get(f"{QMS_API}/{service_id}") return service_details.json()
[docs]def qms_to_geemap(service_id): service_details = get_qms(service_id) name = service_details["name"] url = service_details["url"] attribution = service_details["copyright_text"] layer = ipyleaflet.TileLayer(url=url, name=name, attribution=attribution) return layer