Calculate Density

inputPointOrLineFeatures

(Required)

The feature layer that the density will be calculated on.

It can be a point, line or polygon dataset.

Syntax: This parameter can be:

• 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>}
• "inputPointOrLineFeatures":{"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

outputName

(Required)

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 can 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 examples:

"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"}}

countField

Provide a field specifying the number of incidents at each location. If each point represents a single incident, do not provide a count field.

Domain: Integer or float field

Syntax: A string that represents a field name.

Example:

• "countField": "myCountField"

searchDistance

The size of the neighborhood within which to calculate the density. The radius size must be larger than the binSize.

For example, if you provide a search distance of 1800 meters, the density of any location in the output layer is calculated based on features that are within 1800 meters of the location. Any location that does not have any incidents within 1800 meters will receive a density value of zero.

If no distance is provided, a default will be calculated that is based on the locations of the input features and the values in the count field (if a count field is provided).

Domain: Meters, Kilometers, Feet, Miles

Example:

• "searchDistance": {"distance":"60","units":"Meters"}

outputAreaUnits

The desired output units of the density values.

The default is based on the units specified in your profile. If the units are set to Metric, the default is SQUARE_KILOMETERS. If your profile is set to US Standard, the default is SQUARE_MILES.

Possible area units are:

• SQUARE_KILOMETERS
• SQUARE_MILES

Example:

• {"outputAreaUnits" : "SQUARE_KILOMETERS"}

outputCellSize

Specify the cell size to use for the output raster.

Domain: Meters, Kilometers, Feet, Miles

Default: Same as the analysis environment

Example:

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

context

Contains additional settings that affect task execution.

This task has the following settings:

• Extent (extent)—A bounding box that defines the analysis area.
• 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.
• Mask (mask)—Only cells that fall within the analysis mask will be considered in the operation.

f

The response format. The default response format is html.

Values: html | json

outputRaster

This is the density raster.

Example:

{"url": 
"http://<raster analysis url>/CalculateDensity/jobs/<jobId>/results/outputRaster"}

The result has properties for parameter name, data type, and value. The content of value is always the itemid of the output raster dataset 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"
    }
}