rest_getsamples.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import requests"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# TODO: Choose between versions and finish"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# helper.py version\n",
    "\n",
    "def getSamples(test_section, variable_name, bbox, base_url, img_format, time_info, opacity):\n",
    "    '''\n",
    "        TODO: Write function summary\n",
    "        Inputs:\n",
    "        Outputs:\n",
    "    '''\n",
    "\n",
    "    # Get the current timestamp\n",
    "    timestamp = time.strftime(\"%Y%m%d-%H%M%S\")\n",
    "\n",
    "    # Define the ArcGIS API Operation endpoint URL\n",
    "    arcgisOperationURL = '/getSamples/'\n",
    "\n",
    "    # Define the mosaicRule as a Python dictionary\n",
    "    mosaicRule = {\n",
    "        \"multidimensionalDefinition\": [\n",
    "            {\"variableName\": variable_name}\n",
    "        ]\n",
    "    }\n",
    "\n",
    "\n",
    "    # Convert bbox to string format required by the API\n",
    "    bbox_str = ','.join([str(x) for x in bbox])\n",
    "\n",
    "    # Define parameters for the request\n",
    "    params = {\n",
    "        \"bbox\": bbox_str,\n",
    "        \"format\": img_format,\n",
    "        \"time\": time_info,\n",
    "        \"mosaicRule\": json.dumps(mosaicRule)  # Convert the mosaicRule dictionary to a JSON string\n",
    "    }\n",
    "\n",
    "    # API URL construction\n",
    "    get_samples_url = base_url + arcgisOperationURL\n",
    "\n",
    "    # Make the request to the API\n",
    "    response = requests.get(get_samples_url, params=params)\n",
    "    #data = response.json()\n",
    "\n",
    "    # Export details to a CSV file\n",
    "    with open('samples_logs.csv', mode='a', newline='') as file:\n",
    "        writer = csv.writer(file)\n",
    "        # Check if the file is empty to write headers\n",
    "        if file.tell() == 0:\n",
    "            writer.writerow(['TimeStamp'])\n",
    "        writer.writerow([timestamp])\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# rest_gethistograms.ipynb version\n",
    "\n",
    "# Differences from exportImage to address - getSamples; geometry vs bbox; time vs time range\n",
    "\n",
    "def getSamples(test_section, variable_name, bbox, base_url, format, time, opacity):\n",
    "    '''\n",
    "        TODO: Write summary for function\n",
    "        - PURPOSE:\n",
    "            - \n",
    "            \n",
    "        - INPUTS:\n",
    "            - \n",
    "            \n",
    "        - OUTPUTS:\n",
    "            - \n",
    "    '''\n",
    "    # Define the ArcGIS API Operation Type\n",
    "    arcgisOperationType = 'getSamples'\n",
    "    # Define the ArcGIS API Operation endpoint URL\n",
    "    arcgisOperationURL = '/getSamples/'\n",
    "\n",
    "    # Define the mosaicRule as a Python dictionary\n",
    "    mosaicRule = {\n",
    "        \"multidimensionalDefinition\": [\n",
    "            {\"variableName\": variable_name}\n",
    "        ]\n",
    "    }\n",
    "\n",
    "    # Convert bbox to string format required by the API\n",
    "    # bbox_str = ','.join([str(x) for x in bbox])\n",
    "    geometry = \"0,0\",\n",
    "    \n",
    "    # Define parameters for the request\n",
    "    params = {\n",
    "        #\"bbox\": bbox_str,\n",
    "        #\"format\": format,\n",
    "        \"time\": time, # f\"{start_time},{end_time}\" - likely want to provide a time range as that would require multiple 'slices' to be queriried significantly changing the response time\n",
    "        \"mosaicRule\": json.dumps(mosaicRule),  # Convert the mosaicRule dictionary to a JSON string\n",
    "        \"geometry\": geometry,\n",
    "        \"geometryType\": \"esriGeometryPoint\",\n",
    "        \"sampleDistance\": \"\",\n",
    "        \"sampleCount\": \"\",\n",
    "        \"pixelSize\": \"\",\n",
    "        \"returnFirstValueOnly\": \"false\",\n",
    "        \"interpolation\": \"RSP_BilinearInterpolation\",\n",
    "        \"outFields\": \"\",\n",
    "        \"sliceId\": \"\",\n",
    "        \"f\": \"pjson\"\n",
    "    }\n",
    "\n",
    "    # API URL construction\n",
    "    get_samples_url = base_url + arcgisOperationURL\n",
    "\n",
    "    # Make the request to the API\n",
    "    response = requests.get(get_samples_url, params=params)\n",
    "    #data = response.json()\n",
    "\n",
    "\n",
    "\n",
    "\n"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}