Generate Spatial Weights Matrix (Spatial Statistics)

Summary

Constructs a spatial weights matrix (.swm) file to represent the spatial relationships among features in a dataset.

Learn more about how Generate Spatial Weights Matrix works

Illustration

Spatial relationships based on polygon contiguity, Queen's case: shared edges or nodes

Usage

• Output from this tool is a spatial weights matrix file (.swm). Tools, such as Hot Spot Analysis, that require you to specify a Conceptualization of Spatial Relationships will accept a spatial weights matrix file; select Get spatial weights from file for the Conceptualization of Spatial Relationships parameter, and for the Weights Matrix File parameter, specify the full path to the spatial weights file you create using this tool.

• This tool also reports characteristics of the resultant spatial weights matrix file: number of features, connectivity, minimum, maximum, and average number of neighbors. This summary is written as messages at the bottom of the Geoprocessing pane during tool execution. You may access the messages by hovering over the progress bar, clicking the pop-out button or expanding the messages section in the Geoprocessing pane. You may also access the messages for a previously run tool via the Geoprocessing History. This summary will indicate if all features have at least one neighbor. In general, especially with large datasets, a minimum of 8 neighbors and a low value for feature connectivity is desirable.

• For space/time analyses, select Space time window for the Conceptualization of Spatial Relationships parameter. You define space by specifying a Threshold Distance value; you define time by specifying a Date/Time Field and both a Date/Time Type (such as hours or days) and a Date/Time Interval Value. The Date/Time Interval Value is an integer. For example, if you enter 1000 feet, select Hours and provide a Date/Time Interval Value of 3, features within 1,000 feet and occurring within 3 hours of each other would be considered neighbors.

• The spatial weights matrix file (.swm) was designed to allow you to generate, store, reuse, and share your conceptualization of the relationships among a set of features. To improve performance, the file is created in a binary file format. Feature relationships are stored as a sparse matrix, so only nonzero relationships are written to the SWM file. In general, tools will perform well even when the SWM file contains more than 15 million nonzero relationships. If a memory error is encountered when using the SWM file, however, you should revisit how you are defining your feature relationships. As a rule of thumb, you should aim for a spatial weights matrix where every feature has at least 1 neighbor, most have about 8 neighbors, and no feature has more than about 1,000 neighbors.

• Coincident points are not used in the calculation of the default Threshold Distance.

• When using data with coordinates that include a z-value, the Threshold Distance is a 3D distance.

• When using data with coordinates that include a z-value, the only Conceptualization of Spatial Relationships supported are Inverse Distance, Fixed Distance, K nearest neighbors, and Space time window.

• If the Input Feature Class is z-enabled, the linear units of the vertical coordinate system (VCS) must match the linear units of the horizontal coordinate system. If the Input Feature Class does not have a vertical coordinate system, it is assumed the vertical linear unit is the same as the horizontal linear unit.

• When the Input Feature Class is not projected (that is, when coordinates are given in degrees, minutes, and seconds) or when the output coordinate system is set to a Geographic Coordinate System, distances are computed using chordal measurements. Chordal distance measurements are used because they can be computed quickly and provide good estimates of true geodesic distances, at least for points within about 30 degrees of each other. Chordal distances are based on an oblate spheroid. Given any two points on the earth's surface, the chordal distance between them is the length of a line, passing through the three-dimensional earth, to connect those two points. Chordal distances are reported in meters.

  Caution:

  Be sure to project your data if your study area extends beyond 30 degrees. Chordal distances are not a good estimate of geodesic distances beyond 30 degrees.

• When chordal distances are used in the analysis, the Threshold Distance parameter, if specified, should be given in meters.

• For line and polygon features, feature centroids are used in distance computations. For multipoints, polylines, or polygons with multiple parts, the centroid is computed using the weighted mean center of all feature parts. The weighting for point features is 1, for line features is length, and for polygon features is area.

• The Unique ID Field is linked to feature relationships derived from running this tool. Consequently, the Unique ID Field values must be unique for every feature and typically should be in a permanent field that remains with the feature class. If you don't have a unique ID field, you can create one by adding a new integer field (Add Field) to your feature class table and calculating the field values to be equal to the FID or OBJECTID field (Calculate Field). Because the FID and OBJECTID field values may change when you copy or edit a feature class, you cannot use these fields directly for the Unique ID Field parameter.

• The Number of Neighbors parameter may override the Threshold Distance parameter for inverse or fixed distance conceptualizations of spatial relationships. If you specify a threshold distance of 10 miles and 3 for the Number of Neighbors parameter, all features will receive a minimum of 3 neighbors, even if the distance threshold has to be increased to find them. The threshold distance is only increased in those cases where the minimum number of neighbors is not met.

• The Convert table option for the Conceptualization of Spatial Relationships parameter may be used to convert an ASCII spatial weights matrix file to a SWM formatted spatial weights matrix file. First, you will need to put your ASCII weights into a formatted table (using Excel, for example).

  Caution:

  If your table includes weights for self-potential, they will be omitted from the SWM output file, and the default self-potential value will be used in analyses. The default self-potential value for the Hot Spot Analysis tool is one, but this value can be overwritten by specifying a Self-Potential Field value; for all other tools, the default self-potential value is zero.

• For polygon features, you will almost always want to choose Row for the Row Standardization parameter. Row Standardization mitigates bias when the number of neighbors each feature has is a function of the aggregation scheme or sampling process, rather than reflecting the actual spatial distribution of the variable you are analyzing.

• The Modeling Spatial Relationships help topic provides additional information about this tool's parameters.

• The tools that can use a spatial weights matrix file project feature geometry to the output coordinate system prior to analysis and all mathematical computations are based on the output coordinate system. Consequently, if the output coordinate system setting does not match the input feature class spatial reference, either make sure, for all analyses using the spatial weights matrix file, that the output coordinate system matches the settings used when the spatial weights matrix file was created, or project the input feature class so it does match the spatial reference associated with the spatial weights matrix file.

Caution:

When using shapefiles, keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from nonshapefile inputs may store or interpret null values as zero. In some cases, nulls are stored as very large negative values in shapefiles. This can lead to unexpected results. See Geoprocessing considerations for shapefile output for more information.

Syntax

arcpy.stats.GenerateSpatialWeightsMatrix(Input_Feature_Class, Unique_ID_Field, Output_Spatial_Weights_Matrix_File, Conceptualization_of_Spatial_Relationships, {Distance_Method}, {Exponent}, {Threshold_Distance}, {Number_of_Neighbors}, {Row_Standardization}, {Input_Table}, {Date_Time_Field}, {Date_Time_Interval_Type}, {Date_Time_Interval_Value}, Use_Z_values)

Parameter	Explanation	Data Type
Input_Feature_Class	The feature class for which spatial relationships of features will be assessed.	Feature Class
Unique_ID_Field	An integer field containing a different value for every feature in the input feature class. If you don't have a Unique ID field, you can create one by adding an integer field to your feature class table and calculating the field values to equal the FID or OBJECTID field.	Field
Output_Spatial_Weights_Matrix_File	The full path for the spatial weights matrix file (.swm) you want to create.	File
Conceptualization_of_Spatial_Relationships	Specifies how spatial relationships among features are conceptualized. INVERSE_DISTANCE —The impact of one feature on another feature decreases with distance. FIXED_DISTANCE —Everything within a specified critical distance of each feature is included in the analysis; everything outside the critical distance is excluded. K_NEAREST_NEIGHBORS —The closest k features are included in the analysis; k is a specified numeric parameter. CONTIGUITY_EDGES_ONLY —Polygon features that share a boundary are neighbors. CONTIGUITY_EDGES_CORNERS —Polygon features that share a boundary and/or share a node are neighbors. DELAUNAY_TRIANGULATION —A mesh of nonoverlapping triangles is created from feature centroids; features associated with triangle nodes that share edges are neighbors. SPACE_TIME_WINDOW —Features within a specified critical distance and specified time interval of each other are neighbors. CONVERT_TABLE —Spatial relationships are defined in a table.	String
Distance_Method (Optional)	Specifies how distances are calculated from each feature to neighboring features. EUCLIDEAN —The straight-line distance between two points (as the crow flies) MANHATTAN —The distance between two points measured along axes at right angles (city block); calculated by summing the (absolute) difference between the x- and y-coordinates	String
Exponent (Optional)	Parameter for inverse distance calculation. Typical values are 1 or 2.	Double
Threshold_Distance (Optional)	Specifies a cutoff distance for Inverse distance and Fixed distance conceptualizations of spatial relationships. Enter this value using the units specified in the environment output coordinate system. Defines the size of the space window for the Space time window conceptualization of spatial relationships. A value of zero indicates that no threshold distance is applied. When this parameter is left blank, a default threshold value is computed based on output feature class extent and the number of features.	Double
Number_of_Neighbors (Optional)	An integer reflecting either the minimum or the exact number of neighbors. For K_NEAREST_NEIGHBORS, each feature will have exactly this specified number of neighbors. For INVERSE_DISTANCE or FIXED_DISTANCE, each feature will have at least this many neighbors (the threshold distance will be temporarily extended to ensure this many neighbors, if necessary). When one of the contiguity Conceptualizations of Spatial Relationships is selected, each polygon will be assigned this minimum number of neighbors. For polygons with fewer than this number of contiguous neighbors, additional neighbors will be based on feature centroid proximity.	Long
Row_Standardization (Optional)	Row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme. ROW_STANDARDIZATION —Spatial weights are standardized by row. Each weight is divided by its row sum. This is the default. NO_STANDARDIZATION —No standardization of spatial weights is applied.	Boolean
Input_Table (Optional)	A table containing numeric weights relating every feature to every other feature in the input feature class. Required fields are the Input Feature Class, Unique ID field, NID (neighbor ID), and WEIGHT.	Table
Date_Time_Field (Optional)	A date field with a timestamp for each feature.	Field
Date_Time_Interval_Type (Optional)	The units to use for measuring time. SECONDS —Seconds MINUTES —Minutes HOURS —Hours DAYS —Days WEEKS —Weeks MONTHS —30 Days YEARS —Years	String
Date_Time_Interval_Value (Optional)	An integer reflecting the number of time units comprising the time window. For example, if you select HOURS for the Date/Time Interval Type and 3 for the Date/Time Interval Value, the time window would be 3 hours; features within the specified space window and within the specified time window would be neighbors.	Long
Use_Z_values	USE_Z_VALUES —Z-values are used in the construction of the spatial weights matrix. DO_NOT_USE_Z_VALUES —Z-values are ignored and only X and Y coordinates are considered in the construction of the spatial weights matrix. This is the default.	Boolean

Code sample

GenerateSpatialWeightsMatrix example 1 (Python window)

The following Python window script demonstrates how to use the GenerateSpatialWeightsMatrix tool.

import arcpy
arcpy.env.workspace = "C:/data"
arcpy.GenerateSpatialWeightsMatrix_stats("911Count.shp", "MYID", "euclidean6Neighs.swm", "K_NEAREST_NEIGHBORS", "#", "#", "#", 6, "NO_STANDARDIZATION")

GenerateSpatialWeightsMatrix example 2 (stand-alone script)

The following stand-alone Python script demonstrates how to use the GenerateSpatialWeightsMatrix tool.

# Analyze the spatial distribution of 911 calls in a metropolitan area
# using the Hot-Spot Analysis Tool (Local Gi*)

# Import system modules
import arcpy

# Set property to overwrite existing output, by default
arcpy.env.overwriteOutput = True

# Local variables...
workspace = "C:/Data"

try:
    # Set the current workspace (to avoid having to specify the full path to the feature classes each time)
    arcpy.env.workspace = workspace

    # Copy the input feature class and integrate the points to snap
    # together at 500 feet
    # Process: Copy Features and Integrate
    cf = arcpy.CopyFeatures_management("911Calls.shp", "911Copied.shp",
                         "#", 0, 0, 0)

    integrate = arcpy.Integrate_management("911Copied.shp #", "500 Feet")

    # Use Collect Events to count the number of calls at each location
    # Process: Collect Events
    ce = arcpy.CollectEvents_stats("911Copied.shp", "911Count.shp", "Count", "#")

    # Add a unique ID field to the count feature class
    # Process: Add Field and Calculate Field
    af = arcpy.AddField_management("911Count.shp", "MyID", "LONG", "#", "#", "#", "#",
                     "NON_NULLABLE", "NON_REQUIRED", "#",
                     "911Count.shp")
    
    cf = arcpy.CalculateField_management("911Count.shp", "MyID", "[FID]", "VB")

    # Create Spatial Weights Matrix for Calculations
    # Process: Generate Spatial Weights Matrix... 
    swm = arcpy.GenerateSpatialWeightsMatrix_stats("911Count.shp", "MYID",
                        "euclidean6Neighs.swm",
                        "K_NEAREST_NEIGHBORS",
                        "#", "#", "#", 6,
                        "NO_STANDARDIZATION") 

    # Hot Spot Analysis of 911 Calls
    # Process: Hot Spot Analysis (Getis-Ord Gi*)
    hs = arcpy.HotSpots_stats("911Count.shp", "ICOUNT", "911HotSpots.shp", 
                     "GET_SPATIAL_WEIGHTS_FROM_FILE",
                     "EUCLIDEAN_DISTANCE", "NONE",
                     "#", "#", "euclidean6Neighs.swm")

except:
    # If an error occurred when running the tool, print out the error message.
    print(arcpy.GetMessages())

Environments

Current Workspace, Scratch Workspace, Output Coordinate System, Geographic Transformations

Output Coordinate System

Feature geometry is projected to the output coordinate system prior to analysis, so values entered for the Threshold Distance parameter should match those specified in the output coordinate system. All mathematical computations are based on the spatial reference of the output coordinate system. When the output coordinate system is based on degrees, minutes, and seconds, geodesic distances are estimated using chordal distances in meters.

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes