Interpolate Points

inputLayer

(Required)

The point features that will be interpolated.

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 feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

field

(Required)

Name of the numeric field containing the values you wish to interpolate.

interpolateOption

Integer value declaring your preference for speed versus accuracy, from 1 (fastest) to 9 (most accurate). More accurate predictions take longer to calculate.

The default is 5.

Values: 1 | 5 | 9

outputPredictionError

If True, a polygon layer of standard errors for the interpolation predictions will be returned in the predictionError output parameter.

Standard errors are useful because they provide information about the reliability of the predicted values. A simple rule of thumb is that the true value will fall within two standard errors of the predicted value 95 percent of the time. For example, suppose a new location gets a predicted value of 50 with a standard error of 5. This means that this task's best guess is that the true value at that location is 50, but it reasonably could be as low as 40 or as high as 60. To calculate this range of reasonable values, multiply the standard error by 2, add this value to the predicted value to get the upper end of the range, and subtract it from the predicted value to get the lower end of the range.

Values: True | False

classificationType

Determines how predicted values will be classified into areas:

• EqualArea—Polygons are created such that the number of data values in each area is equal. For example, if the data has more large values than small values, more areas will be created for large values.
• EqualInterval—Polygons are created such that the range of predicted values is equal for each area.
• GeometricInterval—Polygons are based on class intervals that have a geometrical 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.
• Manual—You to define your own range of values for areas. These values will be entered in the classBreaks parameter below.

The default value is GeometricInterval.

Example: "classificationType": "EqualArea"

numClasses

This value is used to divide the range of interpolated values into distinct classes. The range of values in each class is determined by the classificationType parameter. Each class defines the boundaries of the result polygons.

The default is 10. The maximum value is 32.

Example: "numClasses": "20"

classBreaks

If classificationType is Manual, supply desired class break values as a list. These values define the upper limit of each class, so the number of classes will equal the number of entered values. Areas will not be created for any locations with predicted values above the largest entered break value. You must enter at least two values and no more than 32.

Example: "classBreaks": [0.5, 1.5, 3, 7]

boundingPolygonLayer

A layer specifying the polygon(s) where you want values to be interpolated. 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 contain polygons within the boundary of the lake.

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 feature collection

predictAtPointLayer

An optional layer specifying point locations to calculate prediction values. This allows you to make predictions at specific locations of interest. For example, if the inputLayer represents measurements of pollution levels, you can use this parameter to predict the pollution levels of locations with large at-risk populations, such as schools or hospitals. You can then use this information to give recommendations to health officials in those locations.

If supplied, the output predictedPointLayer will contain predictions at the specified locations.

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 feature collection

outputName

If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection.

Syntax:

1
2
3
4
5
{
  "serviceProperties": {
    "name": "<service name>"
  }
}

In ArcGIS Online or ArcGIS Enterprise 10.9.1 and later, you can overwrite an existing feature service by providing the itemId value of the existing feature service and setting the overwrite property to true. Including the serviceProperties parameter is optional. As described in the Feature output topic, you must either be the owner of the feature service or have administrative privileges to perform the overwrite.

Syntax:

1
2
3
4
5
6
7
{

  "itemProperties": {
			"itemId": "<itemID of the existing feature service>",
			"overwrite": true
	}
}

or

1
2
3
4
5
6
7
8
9
{
"serviceProperties": {
    "name": "<existing service name>"
  },
"itemProperties": {
				"itemId": "<itemID of the existing feature service>",
				"overwrite": true
	}
}

context

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.

Syntax:

1
2
3
4
{
  "extent" : {extent},
  "outSR" : {spatial reference}
}

f

The response format. The default response format is html.

Values: html | json

resultLayer

These are polygon features where each polygon surrounds interpolated values based on the classificationType and numClasses.

The result polygon features has the following attributes:

• Classes—The class break of the polygon as defined by numClasses, zero based.
• Value_Min—The minimum interpolated value of the polygon.
• Value_Max—The maximum interpolated value of the polygon.
• AnalysisArea—The area of the polygon in the units specified in your profile, which will either be square miles or square kilometers.

Request example:

1
{"url":"http://<analysis url>/InterpolatePoints/jobs/<jobId>/results/resultLayer"}

The result has properties for parameter name, data type, and value. The contents of value depends upon the outputName parameter provided in the initial request.

• If outputName was provided, value contains the url to the feature service layer.

1
2
3
4
5
{
"paramName":"resultLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}

• If outputName was not provided, value contains a feature collection.

1
2
3
4
5
{
"paramName":"resultLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}  }
}

See Feature Output for more information about how the result layer or collection is accessed.

predictionError

Contains the predicted error for each point in the inputLayer.

The output has the following fields:

• Classes—The class break of the polygon as defined by numClasses, starting a zero.
• Value_Min—The lower bound of the standard errors in the polygon.
• Value_Max—The upper bound of the standard errors in the polygon.

Request example:

1
{"url":"http://<analysis url>/InterpolatePoints/jobs/<jobId>/results/predictionError"}

The result has properties for parameter name, data type, and value. The contents of value depends upon the outputName parameter provided in the initial request.

• If outputName was provided, value contains the url to the feature service layer.

1
2
3
4
5
{
"paramName":"predictionError",
"dataType":"GPString",
"value":{"url":"<hosted featureservice table url>"}
}

• If outputName was not provided, value contains a feature collection.

1
2
3
4
5
{
"paramName":"predictionError",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}  }
}

See Feature Output for more information about how the group summary table is accessed.

predictedPointLayer

Point layer containing points from the predictAtPointLayer along with their predicted values.

Output fields are:

• Included—Contains "Yes" if a predicted value for the point could be found. If a value could not be found, the field value will be a string describing the issue.
• Predicted—The interpolated value at the point.
• StdError—The standard error of the interpolated value.

Request example:

1
{"url":"http://<analysis url>/InterpolatePoints/jobs/<jobId>/results/predictedPointLayer"}

The result has properties for parameter name, data type, and value. The contents of value depends upon the outputName parameter provided in the initial request.

• If outputName was provided, value contains the url to the feature service layer.

1
2
3
4
5
{
"paramName":"predictedPointLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice table url>"}
}

• If outputName was not provided, value contains a feature collection.

1
2
3
4
5
{
"paramName":"predictedPointLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}  }
}

See Feature Output for more information about how the group summary table is accessed.