arcgis.features.analysis module

point_layer

Required point layer. The point features that will be aggregated into the polygons in the polygon_layer. See Feature Input.

keep_boundaries_with_no_points

Optional boolean. A Boolean value that specifies whether the polygons that have no points within them should be returned in the output. The default is true.

group_by_field

Optional string. A field name in the point_layer. Points that have the same value for the group by field will have their own counts and summary field statistics. You can create statistical groups using an attribute in the analysis layer. For example, if you are aggregating crimes to neighborhood boundaries, you may have an attribute Crime_type with five different crime types. Each unique crime type forms a group, and the statistics you choose will be calculated for each unique value of Crime_type. When you choose a grouping attribute, two results are created: the result layer and a related table containing the statistics.

percent_points

Optional boolean. This boolean parameter is applicable only when a group_by_field is specified. If set to true, the percentage count of points for each unique group_by_field value is calculated. A new field is added to the group summary output table containing the percentages of each attribute value within each group.

If minority_majority is true, two additional fields are added to the aggregated_layer containing the percentages of the minority and majority attribute values within each group.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For aggregate_points, there are three settings (overwrite is required).

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 10.9.1+

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
                      "ymin": -9187921.892449,
                      "xmax": 3174104.927313,
                      "ymax": -9175500.875353,
                      "spatialReference":{"wkid":102100,"latestWkid":3857}},
              "outSR": {"wkid": 3857},
              "overwrite": True}
  

estimate

Optional Boolean. If True, the number of credits to run the operation will be returned.

bin_type

Optional String. The type of bin that will be generated and points will be aggregated into. Bin options are as follows: Hexagon and Square. Square is the Default. When generating bins, for Square, the number and units specified determine the height and length of the square. For Hexagon, the number and units specified determine the distance between parallel sides. Either bin_type or polygon_layer must be specified. If bin_type is chosen, then bin_size and bin_size_unit specifying the size of the bins must be included.

bin_size_unit

Optional String. The linear unit to be used with the distance value specified in bin_size. Values: Meters, Kilometers, Feet, Miles, NauticalMiles, or Yards

input_layer

Required layer. The input table or features containing the variables that will be combined into the index.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features

• A FeatureCollection

#Example #1: Feature Layer with selection
>>> output = calculate_composite_index(
                input_layer= {
                    "url": <feature service layer url>,
                    "filter": <where clause>},
                ...
            )

#Example #2: Feature Collection
>>> output = calculate_composite_index(
                input_layer= {"
                    "layerDefinition": {},
                    "featureSet": {},
                    "filter": <where clause>},
                ...,
            )

index_method

Optional string. The methods that will be used to scale the inputVariables and combine the scaled variables to create the index.

Scaling is a type of preprocessing that ensures the variables are on a compatible scale before they are combined. These scaled variables are then combined to create a single index value. The following options are available:

• meanScaled the index by scaling the input variables between 0 and 1 (minimum-maximum scaling) and calculating the mean of the scaled values. This method is useful for creating an index that is easy to interpret. The shape of the distribution and outliers in the input variables will impact the index.

• meanPercentile creates the index by scaling the ranks of the input variables between 0 and 1 (scaling by percentile) and calculating the mean of the scaled ranks. This option is useful when the rankings of the variable values are more important than the differences between values. The shape of the distribution and outliers in the input variables will not impact the index.

• meanRaw creates the index by calculating the mean of the raw input variables. This option is useful when variables are already on a compatible scale.

• geomeanScaled creates the index by scaling the input variables between 0 and 1 (minimum-maximum scaling) and calculating the geometric mean of the scaled values. High values will not cancel low values, so this option is useful for creating an index in which higher index values will occur only when there are high values in multiple variables.

• geomeanPercentile creates the index by scaling the ranks of the input variables between 0 and 1 (scaling by percentile) and calculating the geometric mean of the scaled ranks. This option is useful when the rankings of the variable values are more important than the differences between values and when high variable values should not cancel out low variable values.

• geomeanRaw creates the index by calculating the geometric mean of the raw input variables. This option is useful when variables are already on a compatible scale and when high variable values should not cancel out low variable values.

• sumFlagsPercentile creates the index by counting the number of input variables with values greater than or equal to the 90th percentile. This method is useful for identifying locations that may be considered the most extreme or the most in need.

Values:

• meanScaled

• meanPercentile

• meanRaw

• geomeanScaled

• geomeanPercentile

• geomeanRaw

• sumFlagsPercentile

Default: meanScaled

output_index_min_max

Optional list of one dictionary. The minimum and maximum of the output index values. Specifying a minimum and maximum value will apply minimum-maximum scaling to the combined variables.

# Example:
>>> output = calculate_composite_index(
                ...,
                ouput_index_min_max= [
                        {'min': 0, 'max': 100}
                    ],
                ...,
            )

context

Optional dict. The Context parameter contains the following additional settings that affect task operation:

• Extent (extent)—A bounding box that defines the analysis area. Only input features that intersect the bounding box will be analyzed.

• Output spatial reference (outSR)—The output features will be projected into the output spatial reference.

# Example:
>>> output = calculate_composite_index(
                    ...,
                    context= {
                        "extent" : {extent},
                        "outSR" : {spatial reference}
                    },
                    ...,
            )

future

Optional boolean. If True, the task will be performed asynchronously.

input_layer

Required layer. The point or line features from which to calculate density. See Feature Input.

cell_size

Optional float. This value is used to create a mesh of points where density values are calculated. The default is approximately 1/1000th of the smaller of the width and height of the analysis extent as defined in the context parameter. The smaller the value, the smoother the polygon boundaries will be. Conversely, with larger values, the polygon boundaries will be more coarse and jagged.

radius

Optional float. A distance specifying how far to search to find point or line features when calculating density values.

bounding_polygon_layer

Optional layer. A layer specifying the polygon(s) where you want densities to be calculated. For example, if you are interpolating densities of fish within a lake, you can use the boundary of the lake in this parameter and the output will only draw within the boundary of the lake. See Feature Input.

classification_type

Optional string. Determines how density values will be classified into polygons. Choice list: [‘EqualInterval’, ‘GeometricInterval’, ‘NaturalBreaks’, ‘EqualArea’, ‘StandardDeviation’]

• EqualInterval - Polygons are created such that the range of density values is equal for each area.

• GeometricInterval - Polygons are based on class intervals that have a geometric series. This method ensures that each class range has approximately the same number of values within each class and that the change between intervals is consistent.

• NaturalBreaks - Class intervals for polygons are based on natural groupings of the data. Class break values are identified that best group similar values and that maximize the differences between classes.

• EqualArea - Polygons are created such that the size of each area is equal. For example, if the result has more high density values than low density values, more polygons will be created for high densities.

• StandardDeviation - Polygons are created based upon the standard deviation of the predicted density values.

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional, If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

goal

Optional string. Specify the goal that must be satisfied when allocating demand locations to facilities.

Choice list: [‘Allocate’, ‘MinimizeImpedance’, ‘MaximizeCoverage’, ‘MaximizeCapacitatedCoverage’, ‘PercentCoverage’]

Default value is ‘Allocate’.

demand

Optional float. The amount of demand available at every demand locations.

The default value is 1.0.

max_travel_range

Optional float. Specify the maximum travel time or distance allowed between a demand location and the facility it is allocated to.

The default is unlimited (2,147,483,647.0).

max_travel_range_units

Optional string. The units for the maximum travel time or distance allowed between a demand location and the facility it is allocated to.

Choice list: [‘Seconds’, ‘Minutes’, ‘Hours’, ‘Days’, ‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’].

The default is ‘Minutes’.

time_of_day

Optional datetime.datetime. Specify whether travel times should consider traffic conditions. To use traffic in the analysis, set travel_mode to a travel mode object whose impedance_attribute_name property is set to travel_time and assign a value to time_of_day. (A travel mode with other impedance_attribute_name values don’t support traffic.) The time_of_day value represents the time at which travel begins, or departs, from the origin points. The time is specified as datetime.datetime.

The service supports two kinds of traffic: ty pical and live. Typical traffic references travel speeds that are made up of historical averages for each five-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future.

The data coverage page shows the countries Esri currently provides traffic data for.

Typical Traffic:

To ensure the task uses typical traffic in locations where it is available, choose a time and day of the week, and then convert the day of the week to one of the following dates from 1990:

• Monday - 1/1/1990

• Tuesday - 1/2/1990

• Wednesday - 1/3/1990

• Thursday - 1/4/1990

• Friday - 1/5/1990

• Saturday - 1/6/1990

• Sunday - 1/7/1990

Set the time and date as datetime.datetime.

For example, to solve for 1:03 p.m. on Thursdays, set the time and date to 1:03 p.m., 4 January 1990; and convert to datetime eg. datetime.datetime(1990, 1, 4, 1, 3).

Live Traffic:

To use live traffic when and where it is available, choose a time and date and convert to datetime.

Esri saves live traffic data for 4 hours and references predictive data extending 4 hours into the future. If the time and date you specify for this parameter is outside the 24-hour time window, or the travel time in the analysis continues past the predictive data window, the task falls back to typical traffic speeds.

Examples: from datetime import datetime

• “time_of_day”: datetime(1990, 1, 4, 1, 3) # 13:03, 4 January 1990. Typical traffic on Thursdays at 1:03 p.m.

• “time_of_day”: datetime(1990, 1, 7, 17, 0) # 17:00, 7 January 1990. Typical traffic on Sundays at 5:00 p.m.

• “time_of_day”: datetime(2014, 10, 22, 8, 0) # 8:00, 22 October 2014. If the current time is between 8:00 p.m., 21 Oct. 2014 and 8:00 p.m., 22 Oct. 2014, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

• “time_of_day”: datetime(2015, 3, 18, 10, 20) # 10:20, 18 March 2015. If the current time is between 10:20 p.m., 17 Mar. 2015 and 10:20 p.m., 18 Mar. 2015, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

travel_direction

Optional string. Specify whether to measure travel times or distances from facilities to demand locations or from demand locations to facilities.

Choice list: [‘FacilityToDemand’, ‘DemandToFacility’]

required_facilities_capacity

Optional float. Specify how much demand every facility in the required_facilities_layer is capable of supplying.

The default value is unlimited (2,147,483,647).

candidate_facilities_layer

Optional point layer. A point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are not required to be part of the output solution and will be used only after all the facilities from the candidate_facilities_layer have been used when allocating demand locations.

candidate_facilities_capacity

Optional float. Specify how much demand every facility in the candidate_facilities_layer is capable of supplying.

The default value is unlimited (2,147,483,647.0).

percent_demand_coverage

Optional float. Specify the percentage of the total demand that you want the chosen and required facilities to capture.

The default value is 100.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For choose_best_facilities, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 10.9.1+

  # Example Usage
     context = {"extent": {"xmin": 3164569.408035,
                         "ymin": -9187921.892449,
                         "xmax": 3174104.927313,
                         "ymax": -9175500.875353,
                         "spatialReference":{"wkid":102100,"latestWkid":3857}},
                 "outSR": {"wkid": 3857},
                 "overwrite": True}
  

estimate

Optional boolean. Is true, the number of credits needed to run the operation will be returned as a float.

line_barrier_layer

Optional layer. Specify one or more line features that prohibit travel anywhere the lines intersect the streets.

A line barrier prohibits travel anywhere the barrier intersects the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. See Feature Input.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

origins_layer

Required layer. The starting point or points of the routes to be generated. See Feature Input.

measurement_type

Required string. The origins and destinations can be connected by measuring straight-line distance, or by measuring travel time or travel distance along a street network using various modes of transportation known as travel modes.

Valid values are a string, StraightLine, which indicates Euclidean distance to be used as distance measure or a Python dictionary representing settings for a travel mode.

When using a travel mode for the measurement_type, you need to specify a dictionary containing the settings for a travel mode supported by your organization. The code in the example section below generates a valid Python dictionary and then passes it as the value for the measurement_type parameter.

Supported travel modes: [‘Driving Distance’, ‘Driving Time’, ‘Rural Driving Distance’, ‘Rural Driving Time’, ‘Trucking Distance’, ‘Trucking Time’, ‘Walking Distance’, ‘Walking Time’]

destinations_layer_route_id_field

Optional string. Specify the field in the destinations layer containing the IDs that pair origins with destinations.

• The ID values must uniquely identify points in the destinations layer.

• Each ID value must also correspond with exactly one route ID value in the origins layer. Route IDs that match across the layers create origin-destination pairs, which the tool connects together.

• Specifying destinations_layer_route_id_field is optional when there is exactly one point feature in the origins or destinations layer. The tool will connect all origins to the one destination or the one origin to all destinations, depending on which layer contains one point.

time_zone_for_time_of_day

Optional string. Specify the time zone or zones of the timeOfDay parameter. Choice list: [‘GeoLocal’, ‘UTC’]

GeoLocal-refers to the time zone in which the originsLayer points are located.

UTC-refers to Coordinated Universal Time.

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

point_barrier_layer

Optional layer. Specify one or more point features that act as temporary restrictions (in other words, barriers) when traveling on the underlying streets.

A point barrier can model a fallen tree, an accident, a downed electrical line, or anything that completely blocks traffic at a specific position along the street. Travel is permitted on the street but not through the barrier. See Feature Input.

polygon_barrier_layer

Optional string. Specify one or more polygon features that completely restrict travel on the streets intersected by the polygons.

One use of this type of barrier is to model floods covering areas of the street network and making road travel there impossible. See Feature Input.

route_shape

Optional String. Specify the shape of the route that connects each origin to it’s destination when using a travel mode.

Values: FollowStreets or StraightLine

Default: FollowStreets

• FollowStreets - The shape is based on the underlying street network. This option is best when you want to generate the routes between origins and destinations. This is the default value when using a travel mode.

• StraightLine - The shape is a straight line connecting the origin-destination pair. This option is best when you want to g enerate spider diagrams or desire lines (for example, to show which stores customers are visiting). This is the default value when not using a travel mode.

The best route between an origin and it’s matched destination is always calculated based on the travel mode, regardless of which route shape is chosen.

input_layer

Required point, line or polygon feature layer. The input features to be buffered. See Feature Input.

field

Optional string. A field on the input_layer containing a buffer distance. Buffers will be created using field values. Unlike the distances parameter, multiple distances are not supported on field input.

dissolve_type

Optional string. Determines how overlapping buffers are processed.

Choice list: [‘None’, ‘Dissolve’]

side_type

Optional string. When buffering line features, you can choose which side of the line to buffer.

Typically, you choose both sides (Full, which is the default). Left and right are determined as if you were walking from the first x,y coordinate of the line (the start coordinate) to the last x,y coordinate of the line (the end coordinate). Choosing left or right usually means you know that your line features were created and stored in a particular direction (for example, upstream or downstream in a river network).

When buffering polygon features, you can choose whether the buffer includes or excludes the polygon being buffered.

Choice list: [‘Full’, ‘Left’, ‘Right’, ‘Outside’]

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

input_layer

Required point feature layer. The points around which travel areas based on a mode of transportation will be drawn. See Feature Input.

break_values

Optional list of floats. The size of the polygons to create. The units for break_values is specified with the break_units parameter.

By setting many unique values in the list, polygons of different sizes are generated around each input location.

The default is [5, 10, 15].

overlap_policy

Optional string. Determines how overlapping areas are processed.

Choice list: [‘Overlap’, ‘Dissolve’, ‘Split’]

The default is ‘Overlap’

time_zone_for_time_of_day

Optional string. Specify the time zone or zones of the time_of_day parameter.

Choice list: [‘GeoLocal’, ‘UTC’]

GeoLocal-refers to the time zone in which the originsLayer points are located.

UTC-refers to Coordinated Universal Time.

The default is ‘GeoLocal’.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For create_drive_time_areas, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 10.9.1+

# Example Usage
     context = {"extent": {"xmin": 3164569.408035,
                         "ymin": -9187921.892449,
                         "xmax": 3174104.927313,
                         "ymax": -9175500.875353,
                         "spatialReference":{"wkid":102100,"latestWkid":3857}},
                 "outSR": {"wkid": 3857},
                 "overwrite": True}

estimate

Optional boolean. If True, the estimated number of credits required to run the operation will be returned.

line_barrier_layer

Optional layer. Specify one or more line features that prohibit travel anywhere the lines intersect the streets.

A line barrier prohibits travel anywhere the barrier intersects the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. See Feature Input.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

show_holes

Optional boolean. When set to true, the output areas will include holes if some streets couldn’t be reached without exceeding the cutoff or due to travel restrictions imposed by the travel mode.

route_data

Required item. The item id for the route data item that is used to create route layer items. Before running this task, the route data must be added to your portal as an item.

tags

Optional string. Tags used to describe and identify the route layer items. Individual tags are separated using a comma. The route name is always added as a tag even when a value for this argument is not specified.

route_name_prefix

Optional string. A qualifier added to the title of every route layer item. This can be used to designate all routes that are shared for a specific purpose to have the same prefix in the title. The name of the route is always appended after this qualifier. If a value for the route_name_prefix is not specified, the title for the route layer item is created using only the route name.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

input_layer

Required point feature layer. The features to use as the observer locations. See Feature Input.

maximum_distance

Optional float. This is a cutoff distance where the computation of visible areas stops. Beyond this distance, it is unknown whether the analysis points and the other objects can see each other.

It is useful for modeling current weather conditions or a given time of day, such as dusk. Large values increase computation time.

Unless specified, a default maximum distance will be computed based on the resolution and extent of the source DEM. The allowed maximum value is 50 kilometers. Use max_distance_units to set the units for maximum_distance.

observer_height

Optional float. This is the height above the ground of the observer locations.

The default is 1.75 meters, which is approximately the average height of a person. If you are looking from an elevated location, such as an observation tower or a tall building, use that height instead.

Use observer_height_units to set the units for observer_height.

target_height

Optional float. This is the height of structures or people on the ground used to establish visibility. The result viewshed are those areas where an input point can see these other objects. The converse is also true; the other objects can see an input point.

• If your input points represent wind turbines and you want to determine where people standing on the ground can see the turbines, enter the average height of a person (approximately 6 feet). The result is those areas where a person standing on the ground can see the wind turbines.

• If your input points represent fire lookout towers and you want to determine which lookout towers can see a smoke plume 20 feet high or higher, enter 20 feet for the height. The result is those areas where a fire lookout tower can see a smoke plume at least 20 feet high.

• If your input points represent scenic overlooks along roads and trails and you want to determine where wind turbines 400 feet high or higher can be seen, enter 400 feet for the height. The result is those areas where a person standing at a scenic overlook can see a wind turbine at least 400 feet high.

• If your input points represent scenic overlooks and you want to determine how much area on the ground people standing at the overlook can see, enter zero. The result is those areas that can be seen from the scenic overlook.

Use target_height_units to set the units for target_height.

generalize

Optional boolean. Determines whether or not the viewshed polygons are to be generalized.

The viewshed calculation is based on a raster elevation model that creates a result with stair-stepped edges. To create a more pleasing appearance and improve performance, the default behavior is to generalize the polygons. The generalization process smooths the boundary of the visible areas and may remove some single-cell visible areas.

The default value is True.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For create_viewshed, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 10.9.1+

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
                      "ymin": -9187921.892449,
                      "xmax": 3174104.927313,
                      "ymax": -9175500.875353,
                      "spatialReference":{"wkid":102100,"latestWkid":3857}},
              "outSR": {"wkid": 3857},
              "overwrite": True}
  

estimate

Optional boolean. If True, the estimated number of credits required to run the operation will be returned.

input_layer

Required point feature layer. The point features used for calculating watersheds. These are referred to as pour points, because it is the location at which water pours out of the watershed. See Feature Input.

search_units

Optional string. The linear units specified for the search distance.

Choice list: [‘Meters’, ‘Kilometers’, ‘Feet’, ‘Miles’, ‘Yards’]

generalize

Optional boolean. Determines if the output watersheds will be smoothed into simpler shapes or conform to the cell edges of the original DEM.

• True: The polygons will be smoothed into simpler shapes. This is the default.

• False: The edge of the polygons will conform to the edges of the original DEM.

The default value is True.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For create_watersheds, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 10.9.1+

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
                      "ymin": -9187921.892449,
                      "xmax": 3174104.927313,
                      "ymax": -9175500.875353,
                      "spatialReference":{"wkid":102100,"latestWkid":3857}},
              "outSR": {"wkid": 3857},
              "overwrite": True}
  

estimate

Optional boolean. If True, the estimated number of credits required to run the operation will be returned.

input_layers

Required list of feature layers. A list of layers that will be used in the expressions parameter. Each layer in the list can be:

• a feature service layer with an optional filter to select specific features, or

• a feature collection

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional. The GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

input_layer

Required layer. The layer containing polygon features that will be dissolved. See Feature Input.

summary_fields

Optional list of strings. A list of field names and statistical summary types that you wish to calculate from the polygons that are dissolved together:

[“fieldName summaryType”, “fieldName2 summaryType”]

fieldName is the name of one of the numeric fields found in the input_layer. summary type is one of the following:

• Sum - Adds the total value of all the points in each polygon

• Mean - Calculates the average of all the points in each polygon.

• Min - Finds the smallest value of all the points in each polygon.

• Max - Finds the largest value of all the points in each polygon.

• Stddev - Finds the standard deviation of all the points in each polygon.

For example, if you are dissolving counties based on State_Name, and each county has a Population field, you can sum the Population for all the counties sharing the same State_Name attribute. The result would be a layer of state boundaries with total population.

# Usage Example

>>> dissolve_boundaries(input_layer="US_Counties",
                        dissolve_fields="State_Name",
                        summary_fields=["Population Sum"],
                        output_name="US_States")

context

Optional dict. Additional settings such as processing extent and output spatial reference. For calculate_density, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 11+

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
                      "ymin": -9187921.892449,
                      "xmax": 3174104.927313,
                      "ymax": -9175500.875353,
                      "spatialReference":{"wkid":102100,"latestWkid":3857}},
              "outSR": {"wkid": 3857},
              "overwrite": True}
  

estimate

Optional Boolean. If True, the number of credits to run the operation will be returned.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

input_layer

Required layer. The features to enrich with new data. See Feature Input.

analysis_variables

Optional list of strings. The parameter defines the specific variables within a data collection you want to use to your features. Its value is a list of strings in the form of “dataCollection.VariableName”. If you don’t provide this parameter, you must provide the dataCollections parameter. You can provide both parameters. For example, if you want all variables in the KeyGlobalFacts data collection, specify it in the dataCollections parameter and use this parameter for specific variables in other collections.

For more information about variables in data collections, visit the Esri Demographics site. Each data collection has a PDF file describing variables and their names.

buffer_type (Required if input_layer contains point or line features)

Optional string. If your input features are points or lines, you must define an area around your features that you want to enrich. Features that are within (or equal to) the distances you enter will be enriched.

Choice list: [‘StraightLine’, ‘Driving Distance’, ‘Driving Time ‘, ‘Rural Driving Distance’, ‘Rural Driving Time’, ‘Trucking Distance’, ‘Trucking Time’, ‘Walking Distance’, ‘Walking Time’]

units

Optional string. The linear unit to be used with the distance value(s) specified in the distance parameter.

Choice list: [‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘Seconds’, ‘Minutes’. ‘Hours’]

context

Optional dict. Additional settings such as processing extent and output spatial reference. For enrich_layer, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online or Enterprise 11+

# Example Usage

                          "ymin": -9187921.892449,
                          "xmax": 3174104.927313,
                          "ymax": -9175500.875353,
                          "spatialReference":{"wkid":102100,"latestWkid":3857}},
                  "outSR": {"wkid": 3857},
                  "overwrite": True}

return_boundaries

Optional boolean. Applies only for point and line input features. If True, a result layer of areas is returned. The returned areas are defined by the specified buffer_type. For example, if using a buffer_type of StraightLine with a distance of 5 miles, your result will contain areas with a 5 mile radius around the input features and requested analysis_variables variables. If False, the resulting layer will return the same features as the input layer with analysis_variables variables.

The default value is False.

input_layers

Required list of feature layers and tables. A list of input layers to be extracted. See Feature Input.

clip

Optional boolean. A Boolean value that specifies whether the features within the input layer are clipped within the extent. By default, features are not clipped and all features intersecting the extent are returned.

The default is false.

output_name

Optional string or dict.

When output_name is a string, the output item in your My contents page will be named by the value. Other item properties will receive default values.

output_name = "my_extracted_item"

To explicitly provide other item properties, use a dict with the following Syntax.

output_name = {"title": "<title>",
              "tag": "<tags>",
              "snippet": "<snippet>",
              "description": "<description>"}

For more information on these and other item properties, see the Item resource page in the ArcGIS REST API.

estimate

Optional boolean. If True, the number of credits to run the operation will be returned.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For extract_data, there are two settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
              "ymin": -9187921.892449,
              "xmax": 3174104.927313,
              "ymax": -9175500.875353,
              "spatialReference":{"wkid":102100,"latestWkid":3857}},
      "outSR": {"wkid": 3857}}
  

input_layer

Required feature layer. The multipoint, line, or polygon features that will be used to generate centroid point features. See Feature Input.

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service.

• If overwrite is True in *contextI, new layer will overwrite existing layer.

• If output_name not provided, a new FeatureCollection is created.

gis

Optional. The GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean.

• If True, a future object will be returned which can be queried for results. The process will return control to user.

• If False, the process completes before returning control to the user. The default is False.

input_layers

Required list of feature layers. A list of layers that will be used in the expressions parameter. Each layer in the list can be:

• a feature service layer with an optional filter to select specific features, or

• a feature collection

See Feature Input.

output_name

Optional string or FeatureLayer . Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional. The GIS on which this tool runs. If not specified, the active GIS is used.

analysis_layer

Required layer. The point or polygon feature layer for which hot spots will be calculated. See Feature Input.

divided_by_field

Optional string. The numeric field in the analysis_layer that will be used to normalize your data. For example, if your points represent crimes, dividing by total population would result in an analysis of crimes per capita rather than raw crime counts.

You can use esriPopulation to geoenrich each area feature with the most recent population values, which will then be used as the attribute to divide by. This option will use credits.

aggregation_polygon_layer

Optional layer. When the analysis_layer contains points and no analysis_field is specified, you can provide polygon features into which the points will be aggregated and analyzed, such as administrative units. The number of points that fall within each polygon are counted, and the point count in each polygon is analyzed. See Feature Input.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For find_hot_spots, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online and ArcGIS Enterprise 11.1+.

  # Example Usage
  context = {"extent": {"xmin": 3164569.408035,
                      "ymin": -9187921.892449,
                      "xmax": 3174104.927313,
                      "ymax": -9175500.875353,
                      "spatialReference":{"wkid":102100,"latestWkid":3857}},
              "outSR": {"wkid": 3857},
              "overwrite": True}
  

estimate

Optional Boolean. Is true, the number of credits needed to run the operation will be returned as a float.

cell_size

Optional float. The size of the grid cells used to aggregate your features. When aggregating into a hexagon grid, this distance is used as the height to construct the hexagon polygons.

distance_band

Optional float. The spatial extent of the analysis neighborhood. This value determines which features are analyzed together in order to assess local clustering.

future

Optional, If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

analysis_layer

Required layer. The features from which the nearest locations are found. This layer can have point, line, or polygon features. See Feature Input.

measurement_type

Required string. Specify the mode of transportation for the analysis.

Choice list: [‘StraightLine’, ‘Driving Distance’, ‘Driving Time ‘, ‘Rural Driving Distance’, ‘Rural Driving Time’, ‘Trucking Distance’, ‘Trucking Time’, ‘Walking Distance’, ‘Walking Time’]

The default is ‘StraightLine’.

search_cutoff

Optional float. The maximum range to search for nearest locations from each feature in the analysis_layer. The units for this parameter is always minutes when measurement_type is set to a time based travel mode; otherwise the units are set in the search_cutoff_units parameter.

The default is to search without bounds.

time_of_day

Optional datetime.datetime. Specify whether travel times should consider traffic conditions. To use traffic in the analysis, set measurement_type to a travel mode object whose impedance_attribute_name property is set to travel_time and assign a value to time_of_day. (A travel mode with other impedance_attribute_name values don’t support traffic.) The time_of_day value represents the time at which travel begins, or departs, from the origin points. The time is specified as datetime.datetime.

The service supports two kinds of traffic: typical and live. Typical traffic references travel speeds that are made up of historical averages for each five-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future.

The data coverage page shows the countries Esri currently provides traffic data for.

Typical Traffic:

To ensure the task uses typical traffic in locations where it is available, choose a time and day of the week, and then convert the day of the week to one of the following dates from 1990:

• Monday - 1/1/1990

• Tuesday - 1/2/1990

• Wednesday - 1/3/1990

• Thursday - 1/4/1990

• Friday - 1/5/1990

• Saturday - 1/6/1990

• Sunday - 1/7/1990

Set the time and date as datetime.datetime.

For example, to solve for 1:03 p.m. on Thursdays, set the time and date to 1:03 p.m., 4 January 1990; and convert to datetime eg. datetime.datetime(1990, 1, 4, 1, 3).

Live Traffic:

To use live traffic when and where it is available, choose a time and date and convert to datetime.

Esri saves live traffic data for 4 hours and references predictive data extending 4 hours into the future. If the time and date you specify for this parameter is outside the 24-hour time window, or the travel time in the analysis continues past the predictive data window, the task falls back to typical traffic speeds.

Examples: from datetime import datetime

• “time_of_day”: datetime(1990, 1, 4, 1, 3) # 13:03, 4 January 1990. Typical traffic on Thursdays at 1:03 p.m.

• “time_of_day”: datetime(1990, 1, 7, 17, 0) # 17:00, 7 January 1990. Typical traffic on Sundays at 5:00 p.m.

• “time_of_day”: datetime(2014, 10, 22, 8, 0) # 8:00, 22 October 2014. If the current time is between 8:00 p.m., 21 Oct. 2014 and 8:00 p.m., 22 Oct. 2014, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

• “time_of_day”: datetime(2015, 3, 18, 10, 20) # 10:20, 18 March 2015. If the current time is between 10:20 p.m., 17 Mar. 2015 and 10:20 p.m., 18 Mar. 2015, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

include_route_layers

Optional boolean. When include_route_layers is set to True, each route from the result is also saved as a route layer item. A route layer includes all the information for a particular route such as the stops assigned to the route as well as the travel directions. Creating route layers is useful if you want to share individual routes with other members in your organization. The route layers use the output feature service name provided in the output_name parameter as a prefix and the route name generated as part of the analysis is added to create a unique name for each route layer.

Caution:

Route layers cannot be created when the output is a feature collection. The task will raise an error if output_name is not specified (which indicates feature collection output) and include_route_layers is True.

The maximum number of route layers that can be created is 1,000. If the result contains more than 1,000 routes and include_route_layers is True, the task will only create the output feature service.

line_barrier_layer

Optional layer. Specify one or more line features that prohibit travel anywhere the lines intersect the streets.

A line barrier prohibits travel anywhere the barrier intersects the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier.

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

analysis_layer

Required layer. The point feature layer for which density-based clustering will be calculated. See Feature Input.

search_distance

Optional float. The maximum distance to consider. The Minimum Features per Cluster specified must be found within this distance for cluster membership. Individual clusters will be separated by at least this distance. If a feature is located further than this distance from the next closest feature in the cluster, it will not be included in the cluster.

output_name

Optional string or FeatureLayer. Existing feature layer will cause the new layer to be appended to the Feature Service. If overwrite is True in context, new layer will overwrite existing layer. If output_name not indicated then new FeatureCollection created.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

future

Optional boolean. If True, the result will be a GPJob object and results will be returned asynchronously.

sensitivity

Optional float. A double value between 0 and 100 that determines the compactness of the clusters.

This parameter is available in ArcGIS Enterprise 11.2 or higher.

search_time_interval

Optional float. A value that will be used to determine whether features form a space-time cluster. The search time interval spans before and after the time of each feature. This parameter is only available in ArcGIS Online.

Example: search_time_interval = 4

input_layer

Required feature layer. The input_layer contains one or more reference locations against which features in the search_layer will be evaluated for similarity. For example, the input_layer might contain your top performing stores or the villages hardest hit by a disease. It is not uncommon that the input_layer and search_layer are the same feature service. For example, the feature service contains locations of all stores, one of which is your top performing store. If you want to rank the remaining stores from most to least similar to your top performing store, you can provide a filter for both the inputLayer and the search_layer. The filter on the input_layer would select the top performing store while the filter on the search_layer would select all stores except for the top performing store. You can also use the optional input_query parameter to specify reference locations.

If there is more than one reference location, similarity will be based on averages for the fields you specify in the analysis_fields parameter. So, for example, if there are two reference locations and you are interested in matching population, the task will look for candidate locations in the search_layer with populations that are most like the average population for both reference locations. If the values for the reference locations are 100 and 102, for example, the method will look for candidate locations with populations near 101. Consequently, you will want to use fields for the reference locations fields that have similar values. If, for example, the population values for one reference location is 100 and the other is 100,000, the tool will look for candidate locations with population values near the average of those two values: 50,050. Notice that this averaged value is nothing like the population for either of the reference locations. See Feature Input.

analysis_fields

Optional list of strings. A list of fields whose values are used to determine similarity. They must be numeric fields and the fields must exist on both the input_layer and the search_layer. The method will find features in the search_layer that have field values closest to those of the features in your input_layer.

number_of_results

Optional int. The number of ranked candidate locations output to the similar_result_layer. If number_of_results is not specified, or set to zero, all candidate locations will be ranked and output.

context

Optional dict. Additional settings such as processing extent and output spatial reference. For find_similar_locations, there are three settings.

• extent - a bounding box that defines the analysis area. Only those features in the input_layer that intersect the bounding box will be analyzed.

• outSR - the output features will be projected into the output spatial reference referred to by the wkid.

• overwrite - if True, then the feature layer in output_name will be overwritten with new feature layer. Available for ArcGIS Online and ArcGIS Enterprise 11.1+.

# Example Usage
>>> locations_output = find_similar_locations(
                                    ...
                                    context = {
                                            "extent": {
                                                "xmin": 3164569.408035,
                                                "ymin": -9187921.892449,
                                                "xmax": 3174104.927313,
                                                "ymax": -9175500.875353,
                                                "spatialReference":{
                                                        "wkid":102100,
                                                        "latestWkid":3857}
                                                    },
                                            "outSR": {"wkid": 3857},
                                            "overwrite": True}
                                    ...
                            )

estimate

Optional boolean. If True, the number of credits to run the operation will be returned.

criteria_fields

Optional list of dicts. The fields in the inputLayer value that correspond to the fields in the search_layer value that will be used to determine similarity. All fields must be numeric fields. The task will rank the features in the search_layer value based on the similarity of their field values to the corresponding field values in the input_layer value. Either an analysis_fields or criteria_fields value must be provided.

This parameter is available in ArcGIS Enterprise 11.2 or higher.

Examples:

• [{“referenceField”:”population”, “candidateField”:”pop”}] # (single criteria field)

• [

  {“referenceField”:”population”, “candidateField”:” pop”}, {“referenceField”:”age”, “candidateField”:”age”}, {“referenceField”:”edu”, “candidateField”:”education”}

  ] # (multiple criteria field)