00_map.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Copyright 2022 Google LLC\n",
    "#\n",
    "# Licensed under the Apache License, Version 2.0 (the \"License\");\n",
    "# you may not use this file except in compliance with the License.\n",
    "# You may obtain a copy of the License at\n",
    "# \n",
    "#     https://www.apache.org/licenses/LICENSE-2.0\n",
    "# \n",
    "# Unless required by applicable law or agreed to in writing, software\n",
    "# distributed under the License is distributed on an \"AS IS\" BASIS,\n",
    "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n",
    "# See the License for the specific language governing permissions and\n",
    "# limitations under the License."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#| default_exp map"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# map -- An interactive map\n",
    "\n",
    "> A simple API for displaying an interactive map that can display Earth Engine generated results."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#|hide\n",
    "from nbdev.showdoc import *"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#|export\n",
    "import ee\n",
    "import ipyleaflet\n",
    "import ipywidgets as widgets\n",
    "import traitlets\n",
    "\n",
    "DEFAULT_MAP_HEIGHT = '400px'\n",
    "\n",
    "class TileLayerEE(ipyleaflet.TileLayer):\n",
    "  \"\"\"Class for a tile layer generated by Earth Engine.\n",
    "  \n",
    "  Attributes:\n",
    "    ee_object: An Earth Engine object.\n",
    "  \"\"\"\n",
    "  def __init__(self, ee_object, *args, **kwargs):\n",
    "\n",
    "    self.ee_object = ee_object\n",
    "\n",
    "    super(TileLayerEE, self).__init__(*args, **kwargs)\n",
    "\n",
    "\n",
    "class JupyterMap(ipyleaflet.Map):\n",
    "  \"\"\"An interactive map class for Jupyter clients.\n",
    "  \n",
    "  Attributes:\n",
    "    layers_control: a boolean indicating whether to display a layers control.\n",
    "  \"\"\"\n",
    "\n",
    "  layers_control = traitlets.Bool(True)\n",
    "\n",
    "  def __init__(self, *args, **kwargs):\n",
    "\n",
    "    self.layers_control_instance = None\n",
    "\n",
    "    # Set default values for the map.\n",
    "    if 'zoom' not in kwargs:\n",
    "      kwargs['zoom'] = 4\n",
    "    \n",
    "    if 'basemap' not in kwargs:\n",
    "      kwargs['basemap'] = ipyleaflet.basemap_to_tiles(ipyleaflet.basemaps.Stamen.Watercolor)\n",
    "\n",
    "    if 'height' not in kwargs:\n",
    "      kwargs['height'] = DEFAULT_MAP_HEIGHT\n",
    "    \n",
    "    super(JupyterMap, self).__init__(*args, **kwargs)\n",
    "    \n",
    "    if self.layers_control:\n",
    "      self.layers_control_instance = ipyleaflet.LayersControl(position='topright')\n",
    "      self.add_control(self.layers_control_instance)\n",
    "        \n",
    "    self.default_style.cursor = 'crosshair'\n",
    "        \n",
    "  def addLayer(self, eeObject, visParams={}, name=None, shown=True, opacity=1):\n",
    "    \"\"\"Adds a layer for an Earth Engine object.\"\"\"\n",
    "    \n",
    "    if name is None:\n",
    "      # Provide a default name for the layer in the form \"Layer ##\"\n",
    "      name = f'Layer {len(self.layers)}'\n",
    "\n",
    "    def get_tile_layer_url(ee_image_object):\n",
    "      map_id_dict = ee.Image(ee_image_object).getMapId()\n",
    "      return map_id_dict['tile_fetcher'].url_format\n",
    "\n",
    "    # Assume that the eeObject is an ee.Image.\n",
    "    # TODO: Generalize this to other EE objects.\n",
    "    ee_image = eeObject\n",
    "\n",
    "    tile_url = get_tile_layer_url(\n",
    "      ee_image.visualize(**visParams)\n",
    "    )\n",
    "    self.add_layer(TileLayerEE(ee_object=eeObject, url=tile_url, name=name, visible=shown))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/markdown": [
       "---\n",
       "\n",
       "### JupyterMap\n",
       "\n",
       ">      JupyterMap (*args, **kwargs)\n",
       "\n",
       "An interactive map class for Jupyter clients.\n",
       "\n",
       "Attributes:\n",
       "  layers_control: a boolean indicating whether to display a layers control."
      ],
      "text/plain": [
       "---\n",
       "\n",
       "### JupyterMap\n",
       "\n",
       ">      JupyterMap (*args, **kwargs)\n",
       "\n",
       "An interactive map class for Jupyter clients.\n",
       "\n",
       "Attributes:\n",
       "  layers_control: a boolean indicating whether to display a layers control."
      ]
     },
     "execution_count": null,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "show_doc(JupyterMap)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Examples"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Display the default interactive map."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "822893acbea4458abc6aafb32b18b8fe",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "JupyterMap(center=[0.0, 0.0], controls=(ZoomControl(options=['position', 'zoom_in_text', 'zoom_in_title', 'zoo…"
      ]
     },
     "execution_count": null,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "map = JupyterMap()\n",
    "map"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Display an Earth Engine raster layer."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import ee"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "ee.Initialize()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "53b14d97eced4725aed254089521f6ad",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "JupyterMap(center=[0.0, 0.0], controls=(ZoomControl(options=['position', 'zoom_in_text', 'zoom_in_title', 'zoo…"
      ]
     },
     "execution_count": null,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dem = ee.Image('USGS/SRTMGL1_003')\n",
    "sample_image = dem.updateMask(dem.gt(0))\n",
    "\n",
    "map2 = JupyterMap()\n",
    "map2.addLayer(sample_image, {'min':0, 'max':4000}, name=\"My layer\", shown=True)\n",
    "map2"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}