tutorials/notebooks/29_stac_to_geodataframe.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# STAC to GeoDataFrame"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Since STAC items are `.json` files they could be converted directly into a `GeoPandas` `GeoDataFrame`. However, this way you lose data outside the `properties` field of the STAC item, such as `assets` or `links`. To avoid this, the EOTDL can be used.\n",
    "\n",
    "Uncomment the following line to install eotdl if needed."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# !pip install eotdl"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "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>geometry</th>\n",
       "      <th>proj:epsg</th>\n",
       "      <th>proj:shape</th>\n",
       "      <th>proj:transform</th>\n",
       "      <th>constellation</th>\n",
       "      <th>platform</th>\n",
       "      <th>instruments</th>\n",
       "      <th>gsd</th>\n",
       "      <th>eo:bands</th>\n",
       "      <th>datetime</th>\n",
       "      <th>type</th>\n",
       "      <th>stac_version</th>\n",
       "      <th>id</th>\n",
       "      <th>properties</th>\n",
       "      <th>links</th>\n",
       "      <th>assets</th>\n",
       "      <th>bbox</th>\n",
       "      <th>stac_extensions</th>\n",
       "      <th>collection</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>POLYGON ((-0.55703 42.56941, -0.55703 42.57571...</td>\n",
       "      <td>4326</td>\n",
       "      <td>[72, 75]</td>\n",
       "      <td>[0.00012437333333333337, 0.0, -0.557034, 0.0, ...</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>[Sentinel-2]</td>\n",
       "      <td>10</td>\n",
       "      <td>[{'name': 'B02', 'common_name': 'blue', 'descr...</td>\n",
       "      <td>2020-01-09T00:00:00Z</td>\n",
       "      <td>Feature</td>\n",
       "      <td>1.0.0</td>\n",
       "      <td>Jaca_1</td>\n",
       "      <td>{'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...</td>\n",
       "      <td>[{'rel': 'root', 'href': '../../catalog.json',...</td>\n",
       "      <td>{'Jaca_1': {'href': '../../../jaca_dataset/Jac...</td>\n",
       "      <td>[-0.557034, 42.569409, -0.547706, 42.57571]</td>\n",
       "      <td>[https://stac-extensions.github.io/projection/...</td>\n",
       "      <td>sentinel-2-l2a</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>POLYGON ((-0.55703 42.56941, -0.55703 42.57571...</td>\n",
       "      <td>4326</td>\n",
       "      <td>[72, 75]</td>\n",
       "      <td>[0.00012437333333333337, 0.0, -0.557034, 0.0, ...</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>[Sentinel-2]</td>\n",
       "      <td>10</td>\n",
       "      <td>[{'name': 'B02', 'common_name': 'blue', 'descr...</td>\n",
       "      <td>2020-01-01T00:00:00Z</td>\n",
       "      <td>Feature</td>\n",
       "      <td>1.0.0</td>\n",
       "      <td>Jaca_2</td>\n",
       "      <td>{'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...</td>\n",
       "      <td>[{'rel': 'root', 'href': '../../catalog.json',...</td>\n",
       "      <td>{'Jaca_2': {'href': '../../../jaca_dataset/Jac...</td>\n",
       "      <td>[-0.557034, 42.569409, -0.547706, 42.57571]</td>\n",
       "      <td>[https://stac-extensions.github.io/projection/...</td>\n",
       "      <td>sentinel-2-l2a</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>POLYGON ((-0.55703 42.56941, -0.55703 42.57571...</td>\n",
       "      <td>4326</td>\n",
       "      <td>[72, 75]</td>\n",
       "      <td>[0.00012437333333333337, 0.0, -0.557034, 0.0, ...</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>[Sentinel-2]</td>\n",
       "      <td>10</td>\n",
       "      <td>[{'name': 'B02', 'common_name': 'blue', 'descr...</td>\n",
       "      <td>2020-01-06T00:00:00Z</td>\n",
       "      <td>Feature</td>\n",
       "      <td>1.0.0</td>\n",
       "      <td>Jaca_3</td>\n",
       "      <td>{'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...</td>\n",
       "      <td>[{'rel': 'root', 'href': '../../catalog.json',...</td>\n",
       "      <td>{'Jaca_3': {'href': '../../../jaca_dataset/Jac...</td>\n",
       "      <td>[-0.557034, 42.569409, -0.547706, 42.57571]</td>\n",
       "      <td>[https://stac-extensions.github.io/projection/...</td>\n",
       "      <td>sentinel-2-l2a</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>POLYGON ((-0.55703 42.56941, -0.55703 42.57571...</td>\n",
       "      <td>4326</td>\n",
       "      <td>[72, 75]</td>\n",
       "      <td>[0.00012437333333333337, 0.0, -0.557034, 0.0, ...</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>Sentinel-2</td>\n",
       "      <td>[Sentinel-2]</td>\n",
       "      <td>10</td>\n",
       "      <td>[{'name': 'B02', 'common_name': 'blue', 'descr...</td>\n",
       "      <td>2020-01-04T00:00:00Z</td>\n",
       "      <td>Feature</td>\n",
       "      <td>1.0.0</td>\n",
       "      <td>Jaca_4</td>\n",
       "      <td>{'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...</td>\n",
       "      <td>[{'rel': 'root', 'href': '../../catalog.json',...</td>\n",
       "      <td>{'Jaca_4': {'href': '../../../jaca_dataset/Jac...</td>\n",
       "      <td>[-0.557034, 42.569409, -0.547706, 42.57571]</td>\n",
       "      <td>[https://stac-extensions.github.io/projection/...</td>\n",
       "      <td>sentinel-2-l2a</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                                            geometry  proj:epsg proj:shape  \\\n",
       "0  POLYGON ((-0.55703 42.56941, -0.55703 42.57571...       4326   [72, 75]   \n",
       "1  POLYGON ((-0.55703 42.56941, -0.55703 42.57571...       4326   [72, 75]   \n",
       "2  POLYGON ((-0.55703 42.56941, -0.55703 42.57571...       4326   [72, 75]   \n",
       "3  POLYGON ((-0.55703 42.56941, -0.55703 42.57571...       4326   [72, 75]   \n",
       "\n",
       "                                      proj:transform constellation  \\\n",
       "0  [0.00012437333333333337, 0.0, -0.557034, 0.0, ...    Sentinel-2   \n",
       "1  [0.00012437333333333337, 0.0, -0.557034, 0.0, ...    Sentinel-2   \n",
       "2  [0.00012437333333333337, 0.0, -0.557034, 0.0, ...    Sentinel-2   \n",
       "3  [0.00012437333333333337, 0.0, -0.557034, 0.0, ...    Sentinel-2   \n",
       "\n",
       "     platform   instruments  gsd  \\\n",
       "0  Sentinel-2  [Sentinel-2]   10   \n",
       "1  Sentinel-2  [Sentinel-2]   10   \n",
       "2  Sentinel-2  [Sentinel-2]   10   \n",
       "3  Sentinel-2  [Sentinel-2]   10   \n",
       "\n",
       "                                            eo:bands              datetime  \\\n",
       "0  [{'name': 'B02', 'common_name': 'blue', 'descr...  2020-01-09T00:00:00Z   \n",
       "1  [{'name': 'B02', 'common_name': 'blue', 'descr...  2020-01-01T00:00:00Z   \n",
       "2  [{'name': 'B02', 'common_name': 'blue', 'descr...  2020-01-06T00:00:00Z   \n",
       "3  [{'name': 'B02', 'common_name': 'blue', 'descr...  2020-01-04T00:00:00Z   \n",
       "\n",
       "      type stac_version      id  \\\n",
       "0  Feature        1.0.0  Jaca_1   \n",
       "1  Feature        1.0.0  Jaca_2   \n",
       "2  Feature        1.0.0  Jaca_3   \n",
       "3  Feature        1.0.0  Jaca_4   \n",
       "\n",
       "                                          properties  \\\n",
       "0  {'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...   \n",
       "1  {'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...   \n",
       "2  {'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...   \n",
       "3  {'proj:epsg': 4326, 'proj:shape': [72, 75], 'p...   \n",
       "\n",
       "                                               links  \\\n",
       "0  [{'rel': 'root', 'href': '../../catalog.json',...   \n",
       "1  [{'rel': 'root', 'href': '../../catalog.json',...   \n",
       "2  [{'rel': 'root', 'href': '../../catalog.json',...   \n",
       "3  [{'rel': 'root', 'href': '../../catalog.json',...   \n",
       "\n",
       "                                              assets  \\\n",
       "0  {'Jaca_1': {'href': '../../../jaca_dataset/Jac...   \n",
       "1  {'Jaca_2': {'href': '../../../jaca_dataset/Jac...   \n",
       "2  {'Jaca_3': {'href': '../../../jaca_dataset/Jac...   \n",
       "3  {'Jaca_4': {'href': '../../../jaca_dataset/Jac...   \n",
       "\n",
       "                                          bbox  \\\n",
       "0  [-0.557034, 42.569409, -0.547706, 42.57571]   \n",
       "1  [-0.557034, 42.569409, -0.547706, 42.57571]   \n",
       "2  [-0.557034, 42.569409, -0.547706, 42.57571]   \n",
       "3  [-0.557034, 42.569409, -0.547706, 42.57571]   \n",
       "\n",
       "                                     stac_extensions      collection  \n",
       "0  [https://stac-extensions.github.io/projection/...  sentinel-2-l2a  \n",
       "1  [https://stac-extensions.github.io/projection/...  sentinel-2-l2a  \n",
       "2  [https://stac-extensions.github.io/projection/...  sentinel-2-l2a  \n",
       "3  [https://stac-extensions.github.io/projection/...  sentinel-2-l2a  "
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from pystac import Catalog\n",
    "from eotdl.tools import stac_items_to_gdf\n",
    "\n",
    "catalog = Catalog.from_file('example_data/jaca_dataset_stac/catalog.json')\n",
    "collection = catalog.get_child('sentinel-2-l2a')\n",
    "\n",
    "items = collection.get_all_items()\n",
    "gdf = stac_items_to_gdf(items)\n",
    "\n",
    "gdf.head()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "sen12floods",
   "language": "python",
   "name": "python3"
  },
  "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.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}