A layer that identifies the locations from or to which the least accumulated cost distance for every output cell location is calculated.

Syntax: This parameter can have either a raster input or a feature input. For raster input, this parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset. For feature input, this parameter can be specified as either a URL to a feature service layer or a feature collection.

"inputSourceRasterOrFeatures":{"itemID": <portal item ID>}
"inputSourceRasterOrFeature":{"url": <image service layer url>}

//Feature layer URL
"inputSourceRasterOrFeatures":{"url": <feature service layer url>}

//Feature collection
"inputSourceRasterOrFeatures":{"layerDefinition": {}, "featureSet": {}}

The output distance image service name that will be created.

This calculates, for each cell, the accumulative distance to the closest source.

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.

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

"outputDistanceAccumulationRasterName":{"serviceProperties":{"name":"testrasteranalysis"}}

//Output portal item
"outputDistanceAccumulationRasterName":{"itemId": <portal item id>}

//Output URL
"outputDistanceAccumulationRasterName":{"url": <image service url>}

//Output raster layer service
"outputDistanceAccumulationRasterName":{"serviceProperties":
  {"name":"testrasteranalysis",
    "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}
}

The dataset that defines the barriers.

The barriers can be defined by an integer or a floating-point raster, or by a feature layer.

For a raster barrier, the barrier must have a valid value, including zero, and the areas that are not barriers must be NoData.

Syntax: This parameter can have either a raster input or a feature input. For raster input, this parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset. For feature input, this parameter can be specified as either a URL to a feature service layer or a feature collection.

"inputBarrierRasterOrFeatures":{"itemID": <portal item ID>}
"inputBarrierRasterOrFeatures":{"url": <image service layer url>}

//Feature layer URL
"inputBarrierRasterOrFeatures":{"url": <feature service layer url>}

//Feature collection
"inputBarrierRasterOrFeatures":{"layerDefinition": {}, "featureSet": {}}

A raster defining the elevation values at each cell location.

The values are used to calculate the actual surface distance covered when passing between cells.

If the input surface raster has a vertical coordinate system (VCS), the values of the surface raster are considered to be in the units of the VCS. If the input surface raster does not have a VCS and the data is projected, the surface values are considered to be in the linear units of the spatial reference. If the input surface raster does not have a VCS and the data is not projected, the surface values are considered to be in meters.

Syntax: This parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset.

//Portal item as input raster
"inputSurfaceRaster": {"itemId": <portal item Id>}

//URL as input raster
"inputSurfaceRaster": {"url": <image service layer url>}

A raster defining the impedance or cost to move planimetrically through each cell.

Syntax: This parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset.

//Portal item as input raster
"inputCostRaster": {"itemId": <portal item id>}

//URL as input raster
"inputCostRaster": {"url": <image service layer url>}

A raster defining the vertical (z) value for each cell.

Syntax: This parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset.

//Portal item as input raster
"inputVerticalRaster": {"itemId": <portal item id>}

//URL as input raster
"inputVerticalRaster": {"url": <image service layer url>}

Defines the relationship between the vertical cost factor and the vertical relative moving angle.

There are several factors with modifiers from which to select that identify a defined vertical factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the vertical factor used in calculating the total cost of moving into a neighboring cell.

For each factor, a particular selection of characteristic modifiers will apply. See the section below for details on the factor settings and how to set the characteristic modifiers.

Values: BINARY | LINEAR | SYMMETRIC_LINEAR | INVERSE_LINEAR | SYMMETRIC_INVERSE_LINEAR | COS | SEC | COS_SEC | SEC_COS | TABLE

Characteristics: Zero factor | Low cut angle | High Cut Angle | Slope

Syntax: This parameter is a string.

"verticalFactor": "BINARY 1 30"

"verticalFactor": "LINEAR 1 -60 60 0.02"

A raster defining the horizontal direction at each cell.

Syntax: This parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset.

//Portal item as input raster
"inputHorizontalRaster": {"itemId": <portal item Id>}

//URL as input raster
"inputHorizontalRaster": {"url": <image service layer url>}

Defines the relationship between the horizontal cost factor and the horizontal relative moving angle.

There are several factors with modifiers from which to select that identify a defined horizontal factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the horizontal factor used in calculating the total cost of moving into a neighboring cell.

For each factor, a particular selection of characteristic modifiers will apply. See the Horizontal factor additional information section below for details on the factor settings and how to set the characteristic modifiers.

Values: BINARY | FORWARD | LINEAR | INVERSE_LINEAR | TABLE

Characteristics: Zero factor | Cut angle | Slope | Side value

Syntax: The parameter is a string.

"horizontalFactor": "BINARY 1 30"

"horizontalFactor": "LINEAR 1 -60 60 0.02"

The output back direction image service name that will be created.

The back direction raster contains the calculated direction in degrees. The direction identifies the next cell along the shortest path back to the closest source while avoiding barriers.

The range of values is from 0 degrees to 360 degrees, with 0 reserved for the source cells. Due east (right) is 90, and the values increase clockwise (180 is south, 270 is west, and 360 is north).

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.

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

"outputBackDirectionRasterName":{"serviceProperties":{"name":"testrasteranalysis"}}

//Output portal item
"outputBackDirectionRasterName":{"itemId": <portal item id>}

//Output URL
"outputBackDirectionRasterName":{"url": <image service url>}

//Output raster layer service
"outputBackDirectionRasterName":{"serviceProperties":
  {"name":"testrasteranalysis",
    "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}
}

The source direction raster identifies the direction of the least accumulated cost source cell as an azimuth in degrees.

The range of values is from 0 degrees to 360 degrees, with 0 reserved for the source cells. Due east (right) is 90, and the values increase clockwise (180 is south, 270 is west, and 360 is north).

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.

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

"outputSourceDirectionRasterName":{"serviceProperties":{"name":"testrasteranalysis"}}

//Output portal item
"outputSourceDirectionRasterName":{"itemId": <portal item id>}

//Output URL
"outputSourceDirectionRasterName":{"url": <image service url>}

//Output raster layer service
"outputSourceDirectionRasterName":{"serviceProperties":
  {"name":"testrasteranalysis",
    "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}
}

The source location raster is a multiband output. The first band contains a row index, and the second band contains a column index. These indexes identify the location of the source cell that is the least accumulated cost distance away.

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.

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

"outputSourceLocationRasterName":{"serviceProperties":{"name":"testrasteranalysis"}}

//Output portal item
"outputSourceLocationRasterName":{"itemId": <portal item id>}

//Output URL
"outputSourceLocationRasterName":{"url": <image service url>}

//Output raster layer service
"outputSourceLocationRasterName":{"serviceProperties":
  {"name":"testrasteranalysis",
    "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}
}

The starting cost from which to begin the cost calculations.

Syntax: This parameter can be specified as a Double value or as a field.

//Double example
"sourceInitialAccumulation": 2.7

//Field example
"sourceInitialAccumulation": startCost

Defines the maximum accumulative cost of the traveler from a source.

Syntax: This parameter can be specified as a Double value or as a field.

//Double example
"sourceMaximumAccumulation": 100

//Field example
"sourceMaximumAccumulation": MaximumAccumCost

Multiplier to apply to the cost values.

Syntax: This parameter can be specified as a Double value or as a field.

//Double example
"sourceCostMultiplier": 2

//Field example
"sourceCostMultiplier": sourceMult

Defines the direction of the traveler when applying horizontal and vertical factors and the initial accumulation.

Syntax: A string describing the optimization method, which can be one of the following:

• FROM_SOURCE—The horizontal factor, vertical factor, and the initial cost accumulation will be applied beginning at the input source and moving out to the nonsource cells. This is the default.
• TO_SOURCE—The horizontal factor, vertical factor, and the initial cost accumulation will be applied beginning at each nonsource cell and moving back to the input source.

"sourceDirection": "TO_SOURCE"

Determines whether the distance will be calculated using a planar (flat earth) or a geodesic (ellipsoid) method.

• PLANAR—The calculation will be performed on a projected flat plane using a 2D Cartesian coordinate system. This is the default.
• GEODESIC—The calculation will be performed on the ellipsoid. Therefore, regardless of the input or output projection, the results will not change.

"distanceMethod": "GEODESIC"

Contains additional settings that affect task processing. 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.

The response format. The default response format is html.

Values: html | json | pjson