{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "391be3a2",
   "metadata": {},
   "source": [
    "# Notebook Example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "threatened-relative",
   "metadata": {},
   "outputs": [],
   "source": [
    "from gee_zonal import Catalog, ZonalStats\n",
    "import ee\n",
    "import geopandas as gpd"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a0e849fb",
   "metadata": {},
   "source": [
    "## Input Features"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "blank-breakdown",
   "metadata": {},
   "source": [
    "Input target features can be referenced directly as a GEE asset, or can be supplied\n",
    "as a ``geopandas.GeoDataFrame``, or a path to a shapefile/GeoJSON (will be automatically\n",
    "converted to ``ee.FeatureCollection``)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "structural-course",
   "metadata": {
    "scrolled": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'type': 'FeatureCollection',\n",
       " 'columns': {'Area': 'Float', 'Id': 'Integer', 'system:index': 'String'},\n",
       " 'version': 1570633589922603,\n",
       " 'id': 'users/afche18/Ethiopia_AOI',\n",
       " 'properties': {'system:asset_size': 11288},\n",
       " 'features': [{'type': 'Feature',\n",
       "   'geometry': {'type': 'Polygon',\n",
       "    'coordinates': [[[42.06158510035763, 9.397823252053993],\n",
       "      [42.06119314725495, 9.20601121183654],\n",
       "      [42.18901118834056, 9.20584119448768],\n",
       "      [42.316813505733144, 9.205625705724506],\n",
       "      [42.3125304107434, 9.301530485292622],\n",
       "      [42.30825425836041, 9.397435608019856],\n",
       "      [42.184926941544006, 9.39765098188209],\n",
       "      [42.06158510035763, 9.397823252053993]]]},\n",
       "   'id': '00000000000000000000',\n",
       "   'properties': {'Area': 586.656, 'Id': 0}},\n",
       "  {'type': 'Feature',\n",
       "   'geometry': {'type': 'Polygon',\n",
       "    'coordinates': [[[35.164007676333824, 7.315648092803201],\n",
       "      [35.164482803968816, 7.270435726027228],\n",
       "      [35.25634053363444, 7.210965732212082],\n",
       "      [35.348179623989004, 7.151464739986416],\n",
       "      [35.50236858461292, 7.092454680579472],\n",
       "      [35.51569123843248, 7.11196715143379],\n",
       "      [35.461916853024185, 7.22665425180959],\n",
       "      [35.41052043644675, 7.307558148286968],\n",
       "      [35.23872404563077, 7.330402310785946],\n",
       "      [35.164007676333824, 7.315648092803201]]]},\n",
       "   'id': '00000000000000000001',\n",
       "   'properties': {'Area': 523.326, 'Id': 1}}]}"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "AOIs = ee.FeatureCollection('users/afche18/Ethiopia_AOI')\n",
    "AOIs.getInfo()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "0dfd1424",
   "metadata": {},
   "outputs": [],
   "source": [
    "gdf = gpd.read_file(gpd.datasets.get_path('naturalearth_lowres'))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "0259823c",
   "metadata": {
       "tags": [
           "scroll-output"
       ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>pop_est</th>\n",
       "      <th>continent</th>\n",
       "      <th>name</th>\n",
       "      <th>iso_a3</th>\n",
       "      <th>gdp_md_est</th>\n",
       "      <th>geometry</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>889953.0</td>\n",
       "      <td>Oceania</td>\n",
       "      <td>Fiji</td>\n",
       "      <td>FJI</td>\n",
       "      <td>5496</td>\n",
       "      <td>MULTIPOLYGON (((180.00000 -16.06713, 180.00000...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>58005463.0</td>\n",
       "      <td>Africa</td>\n",
       "      <td>Tanzania</td>\n",
       "      <td>TZA</td>\n",
       "      <td>63177</td>\n",
       "      <td>POLYGON ((33.90371 -0.95000, 34.07262 -1.05982...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>603253.0</td>\n",
       "      <td>Africa</td>\n",
       "      <td>W. Sahara</td>\n",
       "      <td>ESH</td>\n",
       "      <td>907</td>\n",
       "      <td>POLYGON ((-8.66559 27.65643, -8.66512 27.58948...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>37589262.0</td>\n",
       "      <td>North America</td>\n",
       "      <td>Canada</td>\n",
       "      <td>CAN</td>\n",
       "      <td>1736425</td>\n",
       "      <td>MULTIPOLYGON (((-122.84000 49.00000, -122.9742...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>328239523.0</td>\n",
       "      <td>North America</td>\n",
       "      <td>United States of America</td>\n",
       "      <td>USA</td>\n",
       "      <td>21433226</td>\n",
       "      <td>MULTIPOLYGON (((-122.84000 49.00000, -120.0000...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "       pop_est      continent                      name iso_a3  gdp_md_est  \\\n",
       "0     889953.0        Oceania                      Fiji    FJI        5496   \n",
       "1   58005463.0         Africa                  Tanzania    TZA       63177   \n",
       "2     603253.0         Africa                 W. Sahara    ESH         907   \n",
       "3   37589262.0  North America                    Canada    CAN     1736425   \n",
       "4  328239523.0  North America  United States of America    USA    21433226   \n",
       "\n",
       "                                            geometry  \n",
       "0  MULTIPOLYGON (((180.00000 -16.06713, 180.00000...  \n",
       "1  POLYGON ((33.90371 -0.95000, 34.07262 -1.05982...  \n",
       "2  POLYGON ((-8.66559 27.65643, -8.66512 27.58948...  \n",
       "3  MULTIPOLYGON (((-122.84000 49.00000, -122.9742...  \n",
       "4  MULTIPOLYGON (((-122.84000 49.00000, -120.0000...  "
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "gdf = gdf.head().copy()\n",
    "gdf"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "29445754",
   "metadata": {},
   "source": [
    "## Initialize Zonal Stats"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ecological-oxford",
   "metadata": {},
   "source": [
    "### Option A: Retrieve results directly   \n",
    "Output: DataFrame with statistics  \n",
    "*Recommended for small areas / low n*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "skilled-angola",
   "metadata": {},
   "outputs": [],
   "source": [
    "zs = ZonalStats(\n",
    "    collection_id='LANDSAT/LC08/C01/T1_8DAY_NDVI', \n",
    "    target_features=AOIs, \n",
    "    statistic_type=\"all\",\n",
    "    frequency=\"annual\",\n",
    "    temporal_stat=\"mean\"\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "proper-woman",
   "metadata": {
     "tags": [
         "scroll-output"
     ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>2013_NDVI_mean_max</th>\n",
       "      <th>2013_NDVI_mean_mean</th>\n",
       "      <th>2013_NDVI_mean_min</th>\n",
       "      <th>2013_NDVI_mean_stdDev</th>\n",
       "      <th>2014_NDVI_mean_max</th>\n",
       "      <th>2014_NDVI_mean_mean</th>\n",
       "      <th>2014_NDVI_mean_min</th>\n",
       "      <th>2014_NDVI_mean_stdDev</th>\n",
       "      <th>2015_NDVI_mean_max</th>\n",
       "      <th>2015_NDVI_mean_mean</th>\n",
       "      <th>...</th>\n",
       "      <th>2021_NDVI_mean_max</th>\n",
       "      <th>2021_NDVI_mean_mean</th>\n",
       "      <th>2021_NDVI_mean_min</th>\n",
       "      <th>2021_NDVI_mean_stdDev</th>\n",
       "      <th>2022_NDVI_mean_max</th>\n",
       "      <th>2022_NDVI_mean_mean</th>\n",
       "      <th>2022_NDVI_mean_min</th>\n",
       "      <th>2022_NDVI_mean_stdDev</th>\n",
       "      <th>Area</th>\n",
       "      <th>Id</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>00000000000000000000</th>\n",
       "      <td>0.478839</td>\n",
       "      <td>0.312925</td>\n",
       "      <td>0.125459</td>\n",
       "      <td>0.041014</td>\n",
       "      <td>0.536693</td>\n",
       "      <td>0.328255</td>\n",
       "      <td>0.133519</td>\n",
       "      <td>0.039759</td>\n",
       "      <td>0.547818</td>\n",
       "      <td>0.325812</td>\n",
       "      <td>...</td>\n",
       "      <td>0.435856</td>\n",
       "      <td>0.292027</td>\n",
       "      <td>0.107515</td>\n",
       "      <td>0.037247</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>586.656</td>\n",
       "      <td>0.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>00000000000000000001</th>\n",
       "      <td>0.669967</td>\n",
       "      <td>0.561163</td>\n",
       "      <td>0.058939</td>\n",
       "      <td>0.056626</td>\n",
       "      <td>0.549813</td>\n",
       "      <td>0.449039</td>\n",
       "      <td>0.028017</td>\n",
       "      <td>0.044816</td>\n",
       "      <td>0.600975</td>\n",
       "      <td>0.491076</td>\n",
       "      <td>...</td>\n",
       "      <td>0.630799</td>\n",
       "      <td>0.478778</td>\n",
       "      <td>0.107342</td>\n",
       "      <td>0.057189</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>523.326</td>\n",
       "      <td>1.0</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>2 rows × 42 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                      2013_NDVI_mean_max  2013_NDVI_mean_mean  \\\n",
       "00000000000000000000            0.478839             0.312925   \n",
       "00000000000000000001            0.669967             0.561163   \n",
       "\n",
       "                      2013_NDVI_mean_min  2013_NDVI_mean_stdDev  \\\n",
       "00000000000000000000            0.125459               0.041014   \n",
       "00000000000000000001            0.058939               0.056626   \n",
       "\n",
       "                      2014_NDVI_mean_max  2014_NDVI_mean_mean  \\\n",
       "00000000000000000000            0.536693             0.328255   \n",
       "00000000000000000001            0.549813             0.449039   \n",
       "\n",
       "                      2014_NDVI_mean_min  2014_NDVI_mean_stdDev  \\\n",
       "00000000000000000000            0.133519               0.039759   \n",
       "00000000000000000001            0.028017               0.044816   \n",
       "\n",
       "                      2015_NDVI_mean_max  2015_NDVI_mean_mean  ...  \\\n",
       "00000000000000000000            0.547818             0.325812  ...   \n",
       "00000000000000000001            0.600975             0.491076  ...   \n",
       "\n",
       "                      2021_NDVI_mean_max  2021_NDVI_mean_mean  \\\n",
       "00000000000000000000            0.435856             0.292027   \n",
       "00000000000000000001            0.630799             0.478778   \n",
       "\n",
       "                      2021_NDVI_mean_min  2021_NDVI_mean_stdDev  \\\n",
       "00000000000000000000            0.107515               0.037247   \n",
       "00000000000000000001            0.107342               0.057189   \n",
       "\n",
       "                      2022_NDVI_mean_max  2022_NDVI_mean_mean  \\\n",
       "00000000000000000000                 NaN                  NaN   \n",
       "00000000000000000001                 NaN                  NaN   \n",
       "\n",
       "                      2022_NDVI_mean_min  2022_NDVI_mean_stdDev     Area   Id  \n",
       "00000000000000000000                 NaN                    NaN  586.656  0.0  \n",
       "00000000000000000001                 NaN                    NaN  523.326  1.0  \n",
       "\n",
       "[2 rows x 42 columns]"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "res = zs.runZonalStats()\n",
    "res"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "mounted-voice",
   "metadata": {},
   "source": [
    "### Option B: Submit a task  \n",
    "Output: csv table on Google Drive   \n",
    "*Recommended for big areas / high n*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "id": "simplified-billy",
   "metadata": {},
   "outputs": [],
   "source": [
    "zs = ZonalStats(\n",
    "    collection_id='LANDSAT/LC08/C01/T1_8DAY_NDVI', \n",
    "    target_features=AOIs, \n",
    "    statistic_type=\"mean\",\n",
    "    frequency=\"annual\",\n",
    "    temporal_stat=\"mean\",\n",
    "    scale=1000,\n",
    "    output_dir=\"pretty_folder\",\n",
    "    output_name=\"pretty_file\"\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "id": "fallen-discretion",
   "metadata": {},
   "outputs": [],
   "source": [
    "zs.runZonalStats()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "id": "amber-financing",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Completed\n",
      "Runtime: 0 minutes and 7 seconds\n"
     ]
    }
   ],
   "source": [
    "zs.reportRunTime()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Package Test",
   "language": "python",
   "name": "pkg"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.0"
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": true,
   "sideBar": true,
   "skip_h1_title": false,
   "title_cell": "Table of Contents",
   "title_sidebar": "Contents",
   "toc_cell": false,
   "toc_position": {},
   "toc_section_display": true,
   "toc_window_display": false
  },
  "varInspector": {
   "cols": {
    "lenName": 16,
    "lenType": 16,
    "lenVar": 40
   },
   "kernels_config": {
    "python": {
     "delete_cmd_postfix": "",
     "delete_cmd_prefix": "del ",
     "library": "var_list.py",
     "varRefreshCmd": "print(var_dic_list())"
    },
    "r": {
     "delete_cmd_postfix": ") ",
     "delete_cmd_prefix": "rm(",
     "library": "var_list.r",
     "varRefreshCmd": "cat(var_dic_list()) "
    }
   },
   "types_to_exclude": [
    "module",
    "function",
    "builtin_function_or_method",
    "instance",
    "_Feature"
   ],
   "window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}