Convert Feature to Raster

Convert Feature to Raster diagram

This task converts a point, line or polygon feature dataset to a raster.

Request URL

http://<raster analysis url>/ConvertFeaturetoRaster/submitJob

Request Parameters

Following is the list of parameters with syntax and details for each.

Parameter

Description

inputFeature

(Required)

The feature layer that will be converted.

It can be a point, line or polygon dataset.

Syntax: This parameter can be specified as:

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

Data type: GPString

Examples:

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

outputName

(Required)

The name of the output raster.

This is the output image service name that will be created.

Syntax: A JSON object describes the name of the output or the output raster.

You can specify the name or you create an empty service using Portal Admin Sharing API and use the return JSON object as input to this parameter.

Output name example:

"outputName":{"serviceProperties":{"name":"testrasteranalysis"}}

Output raster example:

"outputName":{"itemId": <portal item id>}
"outputName":{"url": <image service url}
"outputName":{"serviceProperties":{"name":"testrasteranalysis","serviceUrl":"http://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"}, "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}}

outputCellSize

(Required)

Specify the cell size to use for the output raster.

Data type: GPLinearUnit

Domain: Meters, Kilometers, Feet, Miles

Default: Same as the analysis environment

Example:

  • "outputCellSize": {"distance":60,"units":meters}

valueField

The field on the input feature that will be converted on.

It can be an integer or a string field.

Data type: GPString

Domain: Integer or string field

Default: Value

Example:

  • "valueField": "Landuse"

context

Context contains additional settings that affect task execution.

For this tool, there are four settings.

  • Extent (extent) — a bounding box that defines the analysis area. Only those areas in the inputZoneLayer that intersect the bounding box will have the statistics calculated.
  • Output Spatial Reference (outSR) — the output raster will be projected into the output spatial reference.
  • Snap Raster (snapRaster) — the output raster will have its cells aligned with the specified snap raster.
  • Cell Size (cellSize) — the output raster will have the resolution specified by cell size

f

The response format. The default response format is html.

Values: html | 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 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://<raster analysis url>/ConvertFeaturetoRaster/jobs/<jobId>

Accessing results

When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:

http://<raster analysis url>/jobs/<jobId>/results/rasterLayer?token=<your token>&f=json

Parameter

Description

outputRaster

This is the output raster.

Example:

{"url": 
"http://<raster analysis url>/ConvertFeatureToRaster/jobs/<jobId>/results/resultLayer"}

The result has properties for parameter name, data type, and value. The contents of value is always the output raster dataset's itemid and the image service URL. For example:

{
    "paramName": "outRaster",
    "dataType": "GPString",
    "value": {
        "itemId": "f121390b85ef419790479fc75b493efd", 
        "url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
    } 
}

Related topics

9/13/2017