notebooks/Watermark photo attachments with Exif data.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Watermark photo attachments with Exif data\n",
    "\n",
    "This notebook demonstrates how to watermark photo attachments with latitude and longitude from Exif GPS info using the Pillow Library.\n",
    "\n",
    "To use this notebook, you need to update variables at the top of the script, including:\n",
    "\n",
    "1. feature_layer_item_id to the item id of the feature layer to watermark attachments for and feature_layer_id to specify the specific layer\n",
    "2. attachments_query to filter what features to watermark their attachments\n",
    "\n",
    "This notebook assumes that:\n",
    "\n",
    "- You are the owner of the webmap\n",
    "- You are using Enterprise 10.7+ or ArcGIS Online\n",
    "\n",
    "For more information on working with map areas see:\n",
    "\n",
    "- ArcGIS Python API Layer Attachments - https://developers.arcgis.com/python/guide/using-attachments-with-feature-layers/\n",
    "- Pillow Library - https://pillow.readthedocs.io/en/stable/index.html"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import os\n",
    "import shutil\n",
    "import tempfile\n",
    "from arcgis.gis import GIS\n",
    "from datetime import datetime as dt\n",
    "from PIL import ExifTags\n",
    "from PIL import Image\n",
    "from PIL import ImageDraw\n",
    "from PIL import ImageOps\n",
    "\n",
    "\n",
    "# Using built-in user\n",
    "# For information on different authentication schemes see\n",
    "# https://developers.arcgis.com/python/guide/working-with-different-authentication-schemes/\n",
    "# and for protecting your credentials see\n",
    "# https://developers.arcgis.com/python/guide/working-with-different-authentication-schemes/#protecting-your-credentials\n",
    "gis = GIS(\"home\")\n",
    "\n",
    "# The item id of the feature layer to process attachments for\n",
    "feature_layer_item_id = \"7a28f3f872bd4b55bfd7965bf73a46b6\"\n",
    "# The id of the layer to use\n",
    "feature_layer_id = 0\n",
    "# Where clause to filter features and attachments\n",
    "# See FeatureLayer query() for more options - https://developers.arcgis.com/python/api-reference/arcgis.features.toc.html#featurelayer\n",
    "attachments_query = \"field_to_filter=2\"\n",
    "\n",
    "\n",
    "# Converts latitude and longitude from Exif GPS info in degrees, minutes and seconds to decimal degrees\n",
    "def convert_dms_to_dd(gps_info) -> (float, float):\n",
    "\n",
    "    if gps_info is None:\n",
    "        return (0, 0)\n",
    "\n",
    "    lat_degrees = gps_info[ExifTags.GPS.GPSLatitude][0]\n",
    "    lat_minutes = gps_info[ExifTags.GPS.GPSLatitude][1]\n",
    "    lat_seconds = gps_info[ExifTags.GPS.GPSLatitude][2]\n",
    "    lon_degrees = gps_info[ExifTags.GPS.GPSLongitude][0]\n",
    "    lon_minutes = gps_info[ExifTags.GPS.GPSLongitude][1]\n",
    "    lon_seconds = gps_info[ExifTags.GPS.GPSLongitude][2]\n",
    "\n",
    "    lat = float(lat_degrees + lat_minutes / 60 + lat_seconds / 3600)\n",
    "    lon = float(lon_degrees + lon_minutes / 60 + lon_seconds / 3600)\n",
    "\n",
    "    if gps_info[ExifTags.GPS.GPSLatitudeRef] == \"S\":\n",
    "        lat = -lat\n",
    "    if gps_info[ExifTags.GPS.GPSLongitudeRef] == \"W\":\n",
    "        lon = -lon\n",
    "\n",
    "    return (lat, lon)\n",
    "\n",
    "\n",
    "# Watermarks an image with decimal degree latitude and longitude from Exif data\n",
    "def add_dd_watermark(image_path):\n",
    "\n",
    "    image = Image.open(image_path)\n",
    "    image = ImageOps.exif_transpose(image)\n",
    "\n",
    "    # Get the image's Exif data, convert the lat and long to decimal degree and format the string for the watermark\n",
    "    exif = image.getexif()\n",
    "    gps_ifd = exif.get_ifd(ExifTags.IFD.GPSInfo)\n",
    "    (lat, lon) = convert_dms_to_dd(gps_ifd)\n",
    "    watermark_text = f\"Latitude: {lat:.4f} Longitude: {lon:.4f}\"\n",
    "\n",
    "    draw = ImageDraw.Draw(image)\n",
    "\n",
    "    # Draw the watermark in the top left corner of the image in white\n",
    "    # For more drawing options see: https://pillow.readthedocs.io/en/stable/reference/ImageDraw.html#PIL.ImageDraw.ImageDraw.text\n",
    "    # See https://pillow.readthedocs.io/en/stable/reference/ImageFont.html for information on how to change the font, including font size\n",
    "    text_xy_position = (10, 10)\n",
    "    rgb_fill_color = (255, 255, 255)\n",
    "    draw.text(text_xy_position, watermark_text, fill=rgb_fill_color)\n",
    "    image.save(image_path)\n",
    "    # Optional call to show the photo with the watermark\n",
    "    image.show()\n",
    "\n",
    "\n",
    "# Create temporary output directories\n",
    "temporary_attachment_output = tempfile.TemporaryDirectory()\n",
    "temporary_zip_output = tempfile.TemporaryDirectory()\n",
    "temporary_zip_output_name = os.path.join(\n",
    "    temporary_zip_output.name,\n",
    "    \"zipped_photos_{}\".format(dt.now().strftime(\"%Y-%m-%d %H-%M-%S\")),\n",
    ")\n",
    "\n",
    "# Query for features that match the where clause and download their attachments to a temporary output directory\n",
    "layer_item = gis.content.get(feature_layer_item_id)\n",
    "layer = layer_item.layers[feature_layer_id]\n",
    "oid_list = layer.query(where=attachments_query, return_ids_only=True)[\"objectIds\"]\n",
    "attachments = layer.attachments.download(\n",
    "    oid=oid_list, save_path=temporary_attachment_output.name\n",
    ")\n",
    "\n",
    "# For each of the attachments watermark the image\n",
    "for attachment in attachments:\n",
    "    add_dd_watermark(attachment)\n",
    "\n",
    "# Create a zip archive with the watermarked images\n",
    "output_zip = shutil.make_archive(\n",
    "    temporary_zip_output_name, \"zip\", temporary_attachment_output.name\n",
    ")\n",
    "\n",
    "# Create a new Image Collection item with the archived watermarked images\n",
    "item_props = {\n",
    "    \"type\": \"Image Collection\",\n",
    "    \"typeKeywords\": [\"Image\", \"Image Collection\", \"Photo locations\"],\n",
    "    \"description\": \"Images with watermarks\",\n",
    "    \"title\": \"Images with watermarks\",\n",
    "    \"tags\": [],\n",
    "    \"snippet\": \"Images with watermarks\",\n",
    "}\n",
    "new_item = gis.content.add(item_properties=item_props, data=output_zip)\n",
    "\n",
    "# Clean up temporary files\n",
    "os.remove(output_zip)\n",
    "temporary_attachment_output.cleanup()\n",
    "temporary_zip_output.cleanup()\n",
    "\n",
    "display(new_item)\n"
   ]
  }
 ],
 "metadata": {
  "esriNotebookRuntime": {
   "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
   "notebookRuntimeVersion": "9.0"
  },
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.9.18"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}