- URL:
- https://<rasteranalysistools-url>/ClassifyPixelsUsingDeepLearning
- Methods:
GET
- Version Introduced:
- 10.7
Description
The Classify
operation can be used to classify pixels in the imagery data using the designated deep learning model and generate an image service for the classified raster.
Request parameters
Parameter | Details |
---|---|
(Required) | The image that will be classified. This can be specified as the portal item ID, image service URL, cloud raster dataset, shared raster dataset, or raster dataset or image collection in the data store. At least one type of input must be provided in the JSON object. If multiple inputs are provided, the Syntax: A JSON object describes the input raster. Example:
|
(Required) | The output hosted image service properties. If the hosted image service is an existing service, the portal item ID or service URL can be used for the service tool. The output path of the raster dataset generated in the raster store will be used to update the existing service definition. The service tool can also generate a new hosted image service with the given service properties. The output hosted image service is stored in the raster store and shared on either the raster analysis image server or image hosting image server, depending on the enterprise configuration. If the Syntax: A JSON object describes the output image service. Example
|
(Required) | The deep learning model to use to classify objects. This can be specified as the deep learning model portal item ID, as an Syntax: A JSON object describes the model. Example:
Example for JSON:
|
| The name value pairs of arguments and their values that can be customized by the clients. Syntax: A JSON object describes the value pairs of arguments. Example:
|
| Specifies how all raster items in an image service will be processed. If set to Values: |
| Contains additional settings that affect task execution. This parameter has the following settings:
|
| The response format. The default response format is Values: |
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 job
to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use job
to retrieve the results. To track the status, you can make a request of the following form:
https://<raster analysis tools url>/ClassifyPixelsUsingDeepLearning/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://<raster analysis url>/ClassifyPixelsUsingDeepLearning/jobs/<jobId>/results/outRaster
Example usage
A sample request URL for Classify
is below.
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/ClassifyPixelsUsingDeepLearning
JSON Response example
The response returns the out
output parameter, which has properties for parameter name, data type, and value. The content of the value is always the output raster dataset and image service URL.
{
"paramName": "outRaster",
"dataType": "GPString",
"value": {
"itemId": "f121390b85ef419790479fc75b493efd",
"url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
}
}