arcgis.geoanalytics.analyze_patterns module¶
These tools help you identify, quantify, and visualize spatial patterns in your data.
calculate_density takes known quantities of some phenomenon and spreads these quantities across the map. find_hot_spots identifies statistically significant clustering in the spatial pattern of your data.
calculate_density¶
-
analyze_patterns.calculate_density(input_layer, fields: str = None, weight: str = 'Uniform', bin_type: str = 'Square', bin_size: float = None, bin_size_unit: str = None, time_step_interval: int = None, time_step_interval_unit: str = None, time_step_repeat_interval: int = None, time_step_repeat_interval_unit: str = None, time_step_reference: datetime.datetime = None, radius: float = None, radius_unit: str = None, area_units: str = 'SquareKilometers', output_name: str = None, gis=None)¶ Parameters:
input_layer: Input Points (Feature layer). Required parameter.
fields: Population Field (str). Optional parameter.
- weight: Weight (str). Required parameter.
- Choice list:[‘Uniform’, ‘Kernel’]
- bin_type: Output Bin Type (str). Required parameter.
- Choice list:[‘Square’, ‘Hexagon’]
bin_size: Output Bin Size (float). Required parameter.
- bin_size_unit: Output Bin Size Unit (str). Required parameter.
- Choice list:[‘Feet’, ‘Yards’, ‘Miles’, ‘Meters’, ‘Kilometers’, ‘NauticalMiles’]
time_step_interval: Time Step Interval (int). Optional parameter.
- time_step_interval_unit: Time Step Interval Unit (str). Optional parameter.
- Choice list:[‘Years’, ‘Months’, ‘Weeks’, ‘Days’, ‘Hours’, ‘Minutes’, ‘Seconds’, ‘Milliseconds’]
time_step_repeat_interval: Time Step Repeat Interval (int). Optional parameter.
- time_step_repeat_interval_unit: Time Step Repeat Interval Unit (str). Optional parameter.
- Choice list:[‘Years’, ‘Months’, ‘Weeks’, ‘Days’, ‘Hours’, ‘Minutes’, ‘Seconds’, ‘Milliseconds’]
time_step_reference: Time Step Reference (_datetime). Optional parameter.
radius: Radius (float). Required parameter.
- radius_unit: Radius Unit (str). Required parameter.
- Choice list:[‘Feet’, ‘Yards’, ‘Miles’, ‘Meters’, ‘Kilometers’, ‘NauticalMiles’]
- area_units: Area Unit Scale Factor (str). Optional parameter.
- Choice list:[‘SquareMeters’, ‘SquareKilometers’, ‘Hectares’, ‘SquareFeet’, ‘SquareYards’, ‘SquareMiles’, ‘Acres’]
output_name: Output Features Name (str). Required parameter.
gis: Optional, the GIS on which this tool runs. If not specified, the active GIS is used.
- Returns:
- output - Output Features as a feature layer collection item
find_hot_spots¶
-
analyze_patterns.find_hot_spots(point_layer, bin_size: float = 5, bin_size_unit: str = 'Miles', neighborhood_distance: float = 5, neighborhood_distance_unit: str = 'Miles', time_step_interval: int = None, time_step_interval_unit: str = None, time_step_alignment: str = None, time_step_reference: datetime.datetime = None, output_name: str = None, gis=None)¶ Parameters:
point_layer: Input Points (FeatureSet). Required parameter.
bin_size: Bin Size (float). Optional parameter.
- bin_size_unit: Bin Size Unit (str). Optional parameter.
- Choice list:[‘Feet’, ‘Yards’, ‘Miles’, ‘Meters’, ‘Kilometers’, ‘NauticalMiles’]
neighborhood_distance: Neighborhood Distance (float). Optional parameter.
- neighborhood_distance_unit: Neighborhood Distance Unit (str). Optional parameter.
- Choice list:[‘Feet’, ‘Yards’, ‘Miles’, ‘Meters’, ‘Kilometers’, ‘NauticalMiles’]
time_step_interval: Time Step Interval (int). Optional parameter.
- time_step_interval_unit: Time Step Interval Unit (str). Optional parameter.
- Choice list:[‘Years’, ‘Months’, ‘Weeks’, ‘Days’, ‘Hours’, ‘Minutes’, ‘Seconds’, ‘Milliseconds’]
- time_step_alignment: Time Step Alignment (str). Optional parameter.
- Choice list:[‘EndTime’, ‘StartTime’, ‘ReferenceTime’]
time_step_reference: Time Step Reference (_datetime). Optional parameter.
output_name: Output Features Name (str). Optional parameter.
gis: Optional, the GIS on which this tool runs. If not specified, the active GIS is used.
- Returns:
- output - Output Features as a feature layer collection item
create_space_time_cube¶
-
analyze_patterns.create_space_time_cube(point_layer: arcgis.features.feature.FeatureSet, bin_size: float, bin_size_unit: str, time_step_interval: int, time_step_interval_unit: str, time_step_alignment: str = None, time_step_reference: datetime.datetime = None, summary_fields: str = None, output_name: str = None, context: str = None, gis=None) → arcgis.geoprocessing._types.DataFile¶ Summarizes a set of points into a netCDF data structure by aggregating them into space-time bins. Within each bin, the points are counted and specified attributes are aggregated. For all bin locations, the trend for counts and summary field values are evaluated.
Parameters:
point_layer: Input Features (FeatureSet). Required parameter.
bin_size: Distance Interval (float). Required parameter.
- bin_size_unit: Distance Interval Unit (str). Required parameter.
- Choice list:[‘Feet’, ‘Yards’, ‘Miles’, ‘Meters’, ‘Kilometers’, ‘NauticalMiles’]
time_step_interval: Time Step Interval (int). Required parameter.
- time_step_interval_unit: Time Step Interval Unit (str). Required parameter.
- Choice list:[‘Years’, ‘Months’, ‘Weeks’, ‘Days’, ‘Hours’, ‘Minutes’, ‘Seconds’, ‘Milliseconds’]
- time_step_alignment: Time Step Alignment (str). Optional parameter.
- Choice list:[‘EndTime’, ‘StartTime’, ‘ReferenceTime’]
time_step_reference: Time Step Reference (datetime). Optional parameter.
summary_fields: Summary Fields (str). Optional parameter.
output_name: Output Name (str). Required parameter.
context: Context (str). Optional parameter.
gis: Optional, the GIS on which this tool runs. If not specified, the active GIS is used.- Returns:
- output_cube - Output Space Time Cube as a DataFile