- URL:
- https://<rasteranalysistools-url>/GenerateMultidimensionalAnomaly
- Methods:
GET
- Version Introduced:
- 10.8
Description
The Generate
task is used to compute the anomaly for each slice in a multidimensional raster to generate a multidimensional raster. An anomaly is the deviation of an observation from its standard or mean value.
Request parameters
Parameter | Details |
---|---|
(Required) | The portal folder ID, portal item ID, image service URL, cloud multidimensional raster dataset, or shared raster dataset that will be added to the image collection. At least one type of input needs to be provided in the JSON object. Syntax: A JSON object describes the input multidimensional raster.
|
(Required) | Output hosted image service properties. If the hosted image service is already created, the portal item ID or service URL can be given to the service tool. The output path of the multidimensional raster dataset generated in the raster store will be used to update the existing service definition. The service tool can also generate new hosted image service with the given service properties. The output hosted image service is stored in a raster store and shared on either the Raster Analysis Image Server or Image Hosting Image Server depending on the Enterprise configuration. Syntax: JSON object describes the output multidimensional raster. At least one type of input needs to be provided in the JSON object. If multiple inputs are given. The Example
|
(Optional) | The variable or variables that will be predicted in the analysis. If no variables are specified, all variables will be used. Syntax: Either a string representing the variables, with multiple variables separated by comma, or list containing the variables. Example
|
(Optional) | Specifies the method that will be used to calculate the anomaly. The default value, Values: Syntax: A string representing the method. Example
|
(Optional) | Specifies the temporal interval that will be used to calculate the mean: Values: |
| Specifies the reference raster dataset that contains a previously calculated mean for each pixel. The anomalies will be calculated in comparison to this mean. At least one type of input must be provided in the JSON object. If multiple inputs are given, the Syntax: JSON object describes the input raster. Example
|
(Optional) | Specifies whether Values: |
(Optional) | Contains additional settings that affect task execution. This task has the following settings:
|
|
The response format. The default response format is html. Values: |
Example usage
Below is a sample request URL for Generate
:
https://machine.domain.com/webadaptor/rest/services/System/RasterAnalysisTools/GPServer/GenerateMultidimensionalAnomaly?inputMultidimensionalRaster={"itemId": "1780d648db3545bba8661ad98df824a4"}&
outputName={"serviceProperties": {"name":"watertemp_anomaly"}}&f=json
Below is a sample POST request for Generate
:
POST /webadaptor/rest/services/System/RasterAnalysisTools/GPServer/GenerateMultidimensionalAnomaly HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
inputMultidimensionalRaster={"itemId": "1780d648db3545bba8661ad98df824a4"}&outputName={"serviceProperties": {"name": "watertemp_anomaly"}}&f=json
Both of the above requests use the following parameters and values in their requests:
inputMultidimensionalRaster={"itemId": "1780d648db3545bba8661ad98df824a4"}
outputName={"serviceProperties": {"name": "watertemp_anomaly"}}
f=json
Response
When you submit a request, the task 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 job
to periodically check the status of the job and messages, as described in Check job status. Once the job has successfully completed, use the job
to retrieve the results. To track the status, you can make a request of the following form:
https://<rasterAnalysisTools-url>/GenerateMultidimensionalAnomaly/jobs/<jobId>
When the status of the job request is esri
, you can access the results of the analysis by making a request of the following form:
https://<rasterAnalysisTools-url>/GenerateMultidimensionalAnomaly/jobs/<jobId>/results/result
JSON Response example
The response returns the results
output parameter, which has properties for parameter name, data type, and value. The content of value is always the image service URL.
{
"paramName": "outputMultidimensionalRaster",
"dataType": "GPString",
"value": {
"itemId": "c267610d0feb4370bf38cc6e2c4ac261",
"url": "https://<servername>/arcgis/rest/services/Hosted/<servicename>/ImageServer"
}
}