Calculate Adjacent Fields (Cartography Tools)

Summary

Creates fields and calculates values for the neighboring pages (polygon) of a grid polygon feature class.

The most common use case for this tool is to populate fields that can be used to label the adjacent pages in a map book. This tool appends eight new fields (each field representing one of the eight points of the compass: North, Northeast, East, Southeast, South, Southwest, West, and Northwest) to the input feature class and calculates values that identify the adjacent (neighboring) polygons, in each cardinal direction, for each feature in the input feature class.

Usage

This tool creates eight fields whose names are a combination of the Field Name value and direction. The direction is abbreviated. For example, if the Field Name value is PageName, the new field names created by the tool would be PageName_N, PageName_NE, PageName_E, PageName_SE, PageName_S, PageName_SW, PageName_W, and PageName_NW. If the Field Name value is MyPoly, the new field names would be MyPoly_N, MyPoly_NE, MyPoly_E, MyPoly_SE, MyPoly_S, MyPoly_SW, MyPoly_W, and MyPoly_NW.
The tool uses default names for new fields. The field names can be altered after the tool has run.
You can use fields from a joined table.

Label	Explanation	Data type
Input Features	The polygon grid index features that will be appended with adjacent field data.	Feature Layer
Field Name	The field whose values will be used to populate adjacent field data.	Field

Derived output

Label	Explanation	Data type
Output Features	The updated feature class with adjacent field data.	Feature Layer

arcpy.cartography.CalculateAdjacentFields(in_features, in_field)

Name	Explanation	Data type
in_features	The polygon grid index features that will be appended with adjacent field data.	Feature Layer
in_field	The field whose values will be used to populate adjacent field data.	Field

Derived output

Name	Explanation	Data type
out_features	The updated feature class with adjacent field data.	Feature Layer

Code sample

CalculateAdjacentFields example 1 (Python window)

Create and populate fields identifying adjacent features for a polygon grid feature class.

import arcpy
arcpy.env.workspace = "C:\\Data\\ProjectData.gdb"
arcpy.cartography.CalculateAdjacentFields("Index", "PageName")

CalculateAdjacentFields example 2 (stand-alone script)

Create and populate fields identifying adjacent features for a polygon grid feature class.

# Name: calculateadjacentfields_example.py
# Description: Create and populate fields identifying adjacent features for a
# regular polygon grid feature class

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:\\Data\\ProjectData.gdb"

# Set local variables
inFeatures = "MyPolygonIndex"
inField = "PageName"

# Run CalculateAdjacentFields
arcpy.cartography.CalculateAdjacentFields(inFeatures, inField)

Environments

Current Workspace

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes

Calculate Adjacent Fields (Cartography Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics