notebooks/Add GPS Metadata Fields.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Add GPS Metadata fields\n",
    "\n",
    "This notebook is designed for use in ArcGIS Pro 2.5+.  See [this topic](https://pro.arcgis.com/en/pro-app/2.8/arcpy/get-started/pro-notebooks.htm) For information on how to use Jupyter notebooks in ArcGIS Pro.\n",
    "\n",
    "- Use this script to update an existing line or polygon feature class to support GPS metadata\n",
    "- This adds a series of fields, necessary coded value domains, and enables attachments\n",
    "\n",
    "### Steps\n",
    "1. Update the `input_feaature_class` variable\n",
    "2. Run all cells"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 70,
   "metadata": {},
   "outputs": [],
   "source": [
    "# update to location of line or polygon feature class\n",
    "input_feature_class = r\"C:\\Users\\doug-m\\Documents\\ArcGIS\\Projects\\MyProject\\MyGDB.gdb\\service_lines\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 71,
   "metadata": {},
   "outputs": [],
   "source": [
    "import arcpy\n",
    "import os\n",
    "\n",
    "def get_geodatabase_path(input_feature_class):\n",
    "    \"\"\"\n",
    "    Gets the parent geodatabase of the layer\n",
    "    :param input_feature_class: (string) The feature layer to get the parent database of\n",
    "    :return: (string) The path to the geodatabase\n",
    "    \"\"\"\n",
    "    workspace = os.path.dirname(arcpy.Describe(input_feature_class).catalogPath)\n",
    "    if [any(ext) for ext in ('.gdb', '.mdb', '.sde') if ext in os.path.splitext(workspace)]:\n",
    "        return workspace\n",
    "    else:\n",
    "        return os.path.dirname(workspace)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 72,
   "metadata": {},
   "outputs": [],
   "source": [
    "def check_and_create_domains(geodatabase):\n",
    "    \"\"\"\n",
    "    Checks if the Fix Type domain already exists.\n",
    "    If the domains do not exist, they are created\n",
    "    :param geodatabase: (string) the path to the geodatabase to check\n",
    "    :return:\n",
    "    \"\"\"\n",
    "    domains = arcpy.da.ListDomains(geodatabase)\n",
    "    domain_names = [domain.name.lower() for domain in domains]\n",
    "    if 'esri_fix_type_domain' in domain_names:\n",
    "        for domain in domains:\n",
    "            if domain.name.lower() == 'esri_fix_type_domain':\n",
    "                # check if cvs 0,1,2,4,5 are in the codedValues\n",
    "                values = [cv for cv in domain.codedValues]\n",
    "                if not {0, 1, 2, 4, 5}.issubset(values):\n",
    "                    return \"ESRI_FIX_TYPE_DOMAIN is missing a coded value pair.\"\n",
    "    else:\n",
    "        # Add the domain and values\n",
    "      \n",
    "        arcpy.CreateDomain_management(in_workspace=geodatabase,\n",
    "                                      domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                      domain_description=\"Fix Type\",\n",
    "                                      field_type=\"SHORT\",\n",
    "                                      domain_type=\"CODED\",\n",
    "                                      split_policy=\"DEFAULT\",\n",
    "                                      merge_policy=\"DEFAULT\")\n",
    "\n",
    "        arcpy.AddCodedValueToDomain_management(in_workspace=geodatabase,\n",
    "                                               domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                               code=\"0\",\n",
    "                                               code_description=\"Fix not valid\")\n",
    "        arcpy.AddCodedValueToDomain_management(in_workspace=geodatabase,\n",
    "                                               domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                               code=\"1\",\n",
    "                                               code_description=\"GPS\")\n",
    "        arcpy.AddCodedValueToDomain_management(in_workspace=geodatabase,\n",
    "                                               domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                               code=\"2\",\n",
    "                                               code_description=\"Differential GPS\")\n",
    "        arcpy.AddCodedValueToDomain_management(in_workspace=geodatabase,\n",
    "                                               domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                               code=\"4\",\n",
    "                                               code_description=\"RTK Fixed\")\n",
    "        arcpy.AddCodedValueToDomain_management(in_workspace=geodatabase,\n",
    "                                               domain_name=\"ESRI_FIX_TYPE_DOMAIN\",\n",
    "                                               code=\"5\",\n",
    "                                               code_description=\"RTK Float\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 73,
   "metadata": {},
   "outputs": [],
   "source": [
    "def add_gnss_fields(feature_class):\n",
    "    \"\"\"\n",
    "    This adds specific fields required for GPS units to\n",
    "        auto-populate in the Field Maps application\n",
    "        This will report errors if:\n",
    "            1) Any of the fields already exist\n",
    "            2) The input layer is not a line or polygon layer\n",
    "            3) The layer is not found\n",
    "            4) The layer is a shapefile\n",
    "    \"\"\"\n",
    "\n",
    "    if not arcpy.Exists(feature_class):\n",
    "        return \"Feature layer: {} not found!\".format(feature_class)\n",
    "    if arcpy.Describe(feature_class).shapeType != \"Polyline\" and arcpy.Describe(feature_class).shapeType != \"Polygon\":\n",
    "        return \"Feature layer: {} is not a line or polygon layer. Use AddGPSMetadataFields_management instead.\".format(feature_class)\n",
    "    if arcpy.Describe(feature_class).dataType == \"ShapeFile\":\n",
    "        return \"ShapeFiles are not supported.\"\n",
    "\n",
    "    # Check the domains to see if they exist and are valid\n",
    "    # will update if necessary\n",
    "    geodatabase = get_geodatabase_path(feature_class)\n",
    "    check_and_create_domains(geodatabase)      \n",
    "\n",
    "    # Enable Attachments\n",
    "    arcpy.EnableAttachments_management(feature_class)\n",
    "\n",
    "    # Add GNSS metadata fields\n",
    "    existing_fields = [field.name.lower() for field in arcpy.ListFields(feature_class)]\n",
    "\n",
    "    if 'esrignss_avg_h_rms' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_avg_h_rms',\n",
    "                                  field_type=\"DOUBLE\",\n",
    "                                  field_alias='Average horizontal accuracy (m)',\n",
    "                                  field_is_nullable=\"NULLABLE\"\n",
    "                                  )\n",
    "\n",
    "    if 'esrignss_avg_v_rms' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_avg_v_rms',\n",
    "                                  field_type=\"DOUBLE\",\n",
    "                                  field_alias='Average vertical accuracy (m)',\n",
    "                                  field_is_nullable=\"NULLABLE\"\n",
    "                                  )\n",
    "\n",
    "    if 'esrignss_worst_h_rms' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_worst_h_rms',\n",
    "                                  field_type=\"DOUBLE\",\n",
    "                                  field_alias='Worst horizontal accuracy (m)',\n",
    "                                  field_is_nullable=\"NULLABLE\"\n",
    "                                  )\n",
    "\n",
    "    if 'esrignss_worst_v_rms' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_worst_v_rms',\n",
    "                                  field_type=\"DOUBLE\",\n",
    "                                  field_alias='Worst vertical accuracy (m)',\n",
    "                                  field_is_nullable=\"NULLABLE\"\n",
    "                                  )\n",
    "\n",
    "    if 'esrignss_worst_fixtype' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_worst_fixtype',\n",
    "                                  field_type=\"SHORT\",\n",
    "                                  field_alias='Worst Fix Type',\n",
    "                                  field_is_nullable=\"NULLABLE\",\n",
    "                                  field_domain=\"ESRI_FIX_TYPE_DOMAIN\"\n",
    "                                  )\n",
    "\n",
    "    if 'esrignss_manual_locations' not in existing_fields:\n",
    "        arcpy.AddField_management(feature_class,\n",
    "                                  'esrignss_manual_locations',\n",
    "                                  field_type=\"LONG\",\n",
    "                                  field_alias='Number of manual locations',\n",
    "                                  field_is_nullable=\"NULLABLE\"\n",
    "                                  )\n",
    "\n",
    "    # Update GNSS metadata fields with Domains\n",
    "    domain_fields = [field for field in arcpy.ListFields(feature_class) if field.name == 'esrignss_worst_fixtype']\n",
    "\n",
    "    for field in domain_fields:\n",
    "        if field.name == 'esrignss_worst_fixtype' and not field.domain:\n",
    "            arcpy.AssignDomainToField_management(feature_class, field, 'ESRI_FIX_TYPE_DOMAIN')\n",
    "\n",
    "    return \"Successfully updated GPS metadata fields with domains.\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "add_gnss_fields(input_feature_class)"
   ]
  }
 ],
 "metadata": {
  "interpreter": {
   "hash": "2f7d5e7f44707441fdf59f9ea9e91257aa419b0f47527e9654c7357783801722"
  },
  "kernelspec": {
   "display_name": "ArcGISPro",
   "language": "Python",
   "name": "python3"
  },
  "language_info": {
   "file_extension": ".py",
   "name": "python",
   "version": "3.7.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}