The Interpolate Points task allows you to predict values at new locations based on measurements from a collection of points. The task takes point data with values at each point and returns areas classified by predicted values.
For example:
Interpolate Points uses the Empirical Bayesian Kriging geoprocessing tool to perform the interpolation. The parameters that are supplied to the Empirical Bayesian Kriging tool are controlled by the interpolateOption request parameter.
If a value of 1 is provided for interpolateOption, empirical Bayesian kriging will use the following parameters:
If a value of 5 is provided for interpolateOption, empirical Bayesian kriging will use the following parameters:
If a value of 9 is provided for interpolateOption, empirical Bayesian kriging will use the following parameters:
http://<analysis url>/InterpolatePoints/submitJob
Request Parameters Parameter Description
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:
Examples:
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:
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:
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:
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:
{
"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:
{
"itemProperties": {
"itemId": "<itemID of the existing feature service>",
"overwrite": true
}
}
or
{
"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:
Syntax:
{
"extent" : {extent},
"outSR" : {spatial reference}
}
f
The response format. The default response format is html.
Values: html | json
ResponseWhen you submit a request, the service assigns a unique job ID for the transaction.
Syntax:
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}
After the initial request is submitted you can use the jobId to periodically check the status of the job and messages as described in the topic Checking job status. Once the job has successfully completed, you use the jobId to retrive the results. To track the status, you can make a request of the following form:
http://<analysis url>/InterpolatePoints/jobs/<jobId>
Accessing results
When the status of the job request is esriJobSucceded, you can access the results of the analysis by making a request of the following form:
http://<analysis url>/InterpolatePoints/jobs/<jobId>/results/<output parameter name>?token=<your token>&f=json
Parameter Description
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:
Request example:
{"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.
{
"paramName":"resultLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}
{
"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:
Request example:
{"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.
{
"paramName":"predictionError",
"dataType":"GPString",
"value":{"url":"<hosted featureservice table url>"}
}
{
"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:
Request example:
{"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.
{
"paramName":"predictedPointLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice table url>"}
}
{
"paramName":"predictedPointLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {} }
}
See Feature Output for more information about how the group summary table is accessed.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4