Label | Explanation | Data Type |
Area of Interest
| The input feature class used to define the extent of the grid or hexagon layer. | Feature Layer |
Output Feature Class
| The feature class that will contain the grid or hexagon features. | Feature Class |
Cell Geometry Type
(Optional) | Specifies the cell type that will be created in the output.
| String |
Enrichment
Type (Optional) | Specifies the method that will be used for variable enrichment.
| String |
Cell Size
(Optional) | The size of the cell to generate squares or hexagons. The default value is 1 square mile. | Areal Unit |
H3 Resolution
(Optional) | The resolution that will be used to generate the H3 hexagons. A value of 15 represents the finest resolution. The default value is 7. | Long |
Variables
(Optional) | A list of variables that will be appended to the output. | String |
Distance Type
(Optional) | The method of travel that will be used for the buffer calculation. | String |
Distance
(Optional) | The distance that will be used for the buffer calculations. | Double |
Distance Units
(Optional) | The units that will be used for the Distance parameter. | String |
Output Enriched Buffers
(Optional) | The feature class that will contain the enriched buffers. | Feature Class |
Travel Direction
(Optional) | Specifies the direction of travel that will be used between the center of the cell and the buffer boundary.
| String |
Time of Day
(Optional) | The time at which the travel will begin. | Date |
Time Zone
(Optional) | Specifies the time zone that will be used for the Time of Day parameter.
| String |
Search Tolerance
(Optional) | The maximum distance that input points can be from the network. Points located beyond the search tolerance will be excluded from processing. | Linear Unit |
Polygon Detail
(Optional) | Specifies the level of detail that will be used for the output drive time polygons.
| String |
Available with Business Analyst license.
Summary
Creates features with vector-based square grid cells, hexagons, or H3 hexagons for a given area.
Usage
Hexagons are preferable when the analysis includes aspects of connectivity or movement paths and to reduce sampling bias due to the edge effects of the grid shape.
-
When the Cell Geometry Type parameter value is set to H3 Hexagon, the Cell Size parameter will become inactive, and the H3 Resolution parameter will become active.
When the Enrichment Type parameter value is set to Enrich Cell, the Buffer and Network Parameters categories will become inactive.
When the Distance Type parameter value is set to Straight Line, the Network Parameters category will become inactive.
The output feature class inherits the coordinate system of the Area of Interest parameter value by default. You can override this by specifying the Output Coordinate System environment setting.
Parameters
arcpy.ba.GenerateGridsAndHexagons(area_of_interest, out_feature_class, {cell_type}, {enrich_type}, {cell_size}, {h3_resolution}, {variables}, {distance_type}, {distance}, {units}, {out_enriched_buffers}, {travel_direction}, {time_of_day}, {time_zone}, {search_tolerance}, {polygon_detail})
Name | Explanation | Data Type |
area_of_interest | The input feature class used to define the extent of the grid or hexagon layer. | Feature Layer |
out_feature_class | The feature class that will contain the grid or hexagon features. | Feature Class |
cell_type (Optional) | Specifies the cell type that will be created in the output.
| String |
enrich_type (Optional) | Specifies the method that will be used for variable enrichment.
| String |
cell_size (Optional) | The size of the cell to generate squares or hexagons. The default value is 1 square mile. | Areal Unit |
h3_resolution (Optional) | The resolution that will be used to generate the H3 hexagons. A value of 15 represents the finest resolution. The default value is 7. | Long |
variables [variables,...] (Optional) | A list of variables that will be appended to the output. | String |
distance_type (Optional) | The method of travel that will be used for the buffer calculation. | String |
distance (Optional) | The distance that will be used for the buffer calculations. | Double |
units (Optional) | The units that will be used for the distance parameter. | String |
out_enriched_buffers (Optional) | The feature class that will contain the enriched buffers. | Feature Class |
travel_direction (Optional) | Specifies the direction of travel that will be used between the center of the cell and the buffer boundary.
| String |
time_of_day (Optional) | The time at which the travel will begin. | Date |
time_zone (Optional) | Specifies the time zone that will be used for the time_of_day parameter.
| String |
search_tolerance (Optional) | The maximum distance that input points can be from the network. Points located beyond the search tolerance will be excluded from processing. | Linear Unit |
polygon_detail (Optional) | Specifies the level of detail that will be used for the output drive time polygons.
| String |
Code sample
The following Python window script demonstrates how to use the GenerateGridsAndHexagons function.
import arcpy
arcpy.ba.GenerateGridsAndHexagons("LoudonCountyVA", "MyProject.gdb\output", "HEXAGON", "ENRICH_BUFFER", "1 SquareMiles", None, "populationtotals.totpop_cy", "Driving Time", 1, "MINUTES", None, "TOWARD_STORES", None, "TIME_ZONE_AT_LOCATION", None, "STANDARD")
Environments
Licensing information
- Basic: Requires Business Analyst, ArcGIS Network Analyst extension
- Standard: Requires Business Analyst, ArcGIS Network Analyst extension
- Advanced: Requires Business Analyst, ArcGIS Network Analyst extension