| Label | Explanation | Data Type |
Input Features
| The input polygon features. | Feature Layer |
Output Table
| The output table. | Table |
Report By Fields
(Optional) | The input attribute field or fields that will be used to identify unique polygons or polygon groups and represent them in the output. | Field |
Include area overlaps
(Optional) | Specifies whether overlapping area relationships will be analyzed and included in the output.
| Boolean |
Include both sides of neighbor relationship
(Optional) | Specifies whether both sides of neighbor relationships will be included in the output.
| Boolean |
XY Tolerance
(Optional) | The minimum distance between coordinates before they will be considered equal. By default, this is the x,y tolerance of the input features. Caution:Changing this parameter's value may cause failure or unexpected results. It is recommended that you do not modify this parameter. It has been removed from view on the tool dialog box. By default, the input feature class's spatial reference x,y tolerance property is used. | Linear Unit |
Output Linear Units
(Optional) | Specifies the units that will be used to report the total length of the coincident edge between neighboring polygons. The default is the input feature units.
| String |
Output Area Units
(Optional) | Specifies the units that will be used to report the area overlap of neighboring polygons. The default is the input feature units. This parameter is only active when the Include area overlaps parameter is checked.
| String |
Summary
Creates a table with statistics based on polygon contiguity (overlaps, coincident edges, or nodes).
Illustration
Usage
The tool analyzes polygon contiguity, summarizing the following between source polygons and neighbor polygons:
- The area of overlaps (overlapping neighbors—optional)
- The length of coincident edges (edge neighbors)
- The number of times boundaries cross or touch at a point (node neighbors)
Only first-order contiguity is analyzed and reported by the tool. Relationships beyond that are not examined, that is, neighbors of neighbors (second-order contiguity) are not examined.
The Report By Fields parameter is used to identify unique polygons or polygon groups and report their neighboring information by the polygons or polygon groups. To find the neighbors of each individual polygon in the input, specify one or more input fields that result in a unique value or set of values (in the case of multiple fields) for every polygon.
If the specified fields identify unique polygon groups, the neighboring information is summarized and reported by the groups.
See How Polygon Neighbors works for details on the use of this parameter.
You can use the Include area overlaps parameter to analyze area overlapping relationships. When Include area overlaps is checked, the output table contains an AREA field that stores the area of overlap for the overlapping neighbor being analyzed. If no overlap is found, the AREA field value is 0.
Tip:
Calculating area overlapping relationships is a high-resource operation, and performance may be slower than determining coincident edge and node neighbor relationships. If you know your data has no overlapping features or you are not interested in analyzing overlapping neighbors, ensure that the Include area overlaps parameter is not checked.
Caution:
The Include area overlaps parameter must be checked to obtain records for neighbors that are completely contained by a source polygon. If the Include area overlaps parameter is not checked, the output table will not contain records for neighbors that are completely contained in a source polygon.
There is no entry in the output table for features that are not neighbors.
The Include both sides of neighbor relationship parameter is used to control the relationships included in the output. To report all contiguity relationships, including reciprocal relationships, check Include both sides of neighbor relationship. For example, if OID1 is a neighbor of OID2, an entry is written to the output table for OID1 having a neighbor OID2 and for OID2 having a neighbor OID1. If you only want the first side of the relationship, uncheck Include both sides of neighbor relationship. Using the example above but with Include both sides of neighbor relationship unchecked, only the entry for OID1 having a neighbor OID2 is entered into the output table.
Output Linear Units specifies the units that will be used for shared boundary length between neighbors. The default is to use the same units as defined by the input feature coordinate system.
Output Area Units is only used when the Include area overlaps parameter is checked. When Include area overlaps is checked, the units used to calculate the area overlap of neighbors are specified in the Output Area Units parameter. The default is to use the same units as defined by the input feature's coordinate system.
The Output Table parameter value can be a file geodatabase table or .dbf table.
For each field specified in the Report By Fields parameter, the output table will contain two fields using the following naming convention: src_<field> and nbr_<field>. The fields represent the source and neighbor field values from the input.
The output table will also contain the following fields:
- AREA—This field stores the total overlapping area between a source polygon and a neighbor polygon (overlapping neighbors). This field is included in the output table only when the Include area overlaps parameter is checked.
- LENGTH—This field stores the total length of coincident edges between a source polygon and a neighbor polygon.
- NODE_COUNT—This field stores the number of times a source polygon and a neighbor polygon cross or touch at a point.
If there is a selection set on the input features, only selected features will be analyzed.
Parameters
arcpy.analysis.PolygonNeighbors(in_features, out_table, {in_fields}, {area_overlap}, {both_sides}, {cluster_tolerance}, {out_linear_units}, {out_area_units})| Name | Explanation | Data Type |
in_features | The input polygon features. | Feature Layer |
out_table | The output table. | Table |
in_fields [in_fields,...] (Optional) | The input attribute field or fields that will be used to identify unique polygons or polygon groups and represent them in the output. | Field |
area_overlap (Optional) | Specifies whether overlapping relationships will be analyzed and included in the output.
| Boolean |
both_sides (Optional) | Specifies whether both sides of neighbor relationships will be included in the output.
| Boolean |
cluster_tolerance (Optional) | The minimum distance between coordinates before they will be considered equal. By default, this is the x,y tolerance of the input features. Caution:Changing this parameter's value may cause failure or unexpected results. It is recommended that you do not modify this parameter. It has been removed from view on the tool dialog box. By default, the input feature class's spatial reference x,y tolerance property is used. | Linear Unit |
out_linear_units (Optional) | Specifies the units that will be used to report the total length of the coincident edge between neighboring polygons. The default is the input feature units.
| String |
out_area_units (Optional) | Specifies the units that will be used to report the area overlap of neighboring polygons. The default is the input feature units. This parameter is only enabled when the area_overlap parameter is set to AREA_OVERLAP.
| String |
Code sample
Find each electoral district's neighbors in the province of Nova Scotia.
import arcpy
arcpy.management.MakeFeatureLayer(r"C:\Data\Canada\CanadaElecDist.shp",
"Canada_ElectoralDist")
arcpy.management.SelectLayerByAttribute("Canada_ElectoralDist", "NEW_SELECTION",
"\"PROVCODE\" = 'NS'")
count = arcpy.management.GetCount("Canada_ElectoralDist")[0]
print("Selected feature count: {}".format(count))
arcpy.analysis.PolygonNeighbors("Canada_ElectoralDist",
r"C:\Data\Output\NS_elec_neigh.dbf", "ENNAME")
print(arcpy.GetMessages())Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes