updated phoreal example for atl08 ancillary data

jpswinski · jpswinski · commit 4a098afdebdc · 2023-12-04T15:10:31.000Z
diff --git a/examples/phoreal.ipynb b/examples/phoreal.ipynb
@@ -30,14 +30,17 @@
     "import matplotlib.pyplot as plt\n",
     "import matplotlib\n",
     "import geopandas\n",
+    "import logging\n",
     "import sliderule\n",
     "from sliderule import icesat2"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "a9cdeed4-810c-4540-869b-78e09591b68c",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Initialize Client\n",
     "* Organization currently set to \"utexas\"; if you want to be a member of the utexas SlideRule organization, make a request through the SlideRule provisioning system (https://ps.slideruleearth.io); otherwise, remove the organization parameter to default to the public SlideRule cluster.\n",
@@ -53,19 +56,23 @@
    },
    "outputs": [],
    "source": [
-    "icesat2.init(\"slideruleearth.io\", verbose=False)"
+    "logging.basicConfig(level=logging.INFO)\n",
+    "icesat2.init(\"slideruleearth.io\", verbose=True, loglevel=logging.INFO)"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "f4c96101-53cf-4614-80a2-e50afcf65a03",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Processing parameters\n",
     "* 100m segments stepped every 100m\n",
     "* Subsetted to the Grand Mesa region\n",
     "* Time range is one day, Nov 14, 2019\n",
     "* Only processing ground, canopy, and top of canopy photons\n",
+    "* Request the \"h_dif_ref\" variable as an ancillary field to be included in the results\n",
     "* Running PhoREAL algorithm using a binsize of 1m, and geolocating each segment at the center of the segment\n",
     "* Sending reconstructed waveforms along with metrics (for diagnostics and demonstration purposes only)"
    ]
@@ -88,14 +95,17 @@
     "    \"res\": 100,\n",
     "    \"pass_invalid\": True, \n",
     "    \"atl08_class\": [\"atl08_ground\", \"atl08_canopy\", \"atl08_top_of_canopy\"],\n",
+    "    \"atl08_fields\": [\"h_dif_ref\"],\n",
     "    \"phoreal\": {\"binsize\": 1.0, \"geoloc\": \"center\", \"use_abs_h\": False, \"send_waveform\": True}\n",
     "}"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "e9bd5e72-f5d5-4686-94b2-c65f6715a877",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Make Atl08 Request"
    ]
@@ -115,7 +125,9 @@
   {
    "cell_type": "markdown",
    "id": "60702b08-c333-4502-b948-26015c1520d5",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Print Resulting GeoDataFrame"
    ]
@@ -135,7 +147,9 @@
   {
    "cell_type": "markdown",
    "id": "23a8280a-844e-4405-a8a2-53e2dd51f5e0",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Plot Canopy Height"
    ]
@@ -156,7 +170,9 @@
   {
    "cell_type": "markdown",
    "id": "d3665d73-2745-4ba6-b209-5cf7a6abe693",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Plot Landcover"
    ]
@@ -176,7 +192,9 @@
   {
    "cell_type": "markdown",
    "id": "6fc1e14d-8936-4f26-a6ca-a2361f54ef4d",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Create and Plot 75th percentile Across All Ground Tracks"
    ]
@@ -191,13 +209,15 @@
    "outputs": [],
    "source": [
     "atl08['75'] = atl08.apply(lambda row : row[\"canopy_h_metrics\"][icesat2.P['75']], axis = 1)\n",
-    "atl08.plot.scatter(x='distance', y='75')"
+    "atl08.plot.scatter(x='x_atc', y='75')"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "22804320-47c7-4965-a4d2-afc855cfd1b9",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Create Sample Waveform Plots"
    ]
@@ -222,7 +242,9 @@
   {
    "cell_type": "markdown",
    "id": "5da80824-8569-4d87-9544-6bc409956893",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Make Atl06 Request\n",
     "* Below we run an ATL06-SR processing request on the same source data using the same parameters.  Because the `keep_id` argument is set to true here and above when we made the ATL08 request, we can merge the resulting dataframes and have a single table of both elevation data using the customized ATL06-SR algorithm, and vegatation data using the PhoREAL algorithm."
@@ -243,7 +265,9 @@
   {
    "cell_type": "markdown",
    "id": "fd03f4ab-163a-49e3-b810-2f7d3bb37ffc",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "#### Merge Atl06 and Atl08 GeoDataFrames"
    ]
@@ -272,9 +296,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "IPython - SlideRule",
    "language": "python",
-   "name": "python3"
+   "name": "sliderule_env"
   },
   "language_info": {
    "codemirror_mode": {
@@ -286,7 +310,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,
