Flow Distance

inputStreamRaster

(Required)

An input raster that represents a linear stream network.

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.

Examples:

1
2
3
4
5
//Portal item as input raster
"inputStreamRaster": {"itemId": <portal item id>}

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

inputSurfaceRaster

(Required)

The input raster representing a continuous surface.

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.

Examples:

1
2
3
4
5
//Portal item as input raster
"inputSurfaceRaster": {"itemId": <portal item id>}

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

outputName

(Required)

The name of the output image service that will be created.

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.

Output name example:

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

Output raster examples:

1
2
3
4
5
6
7
8
9
10
11
12
//Output portal item:
"outputName":{"itemId": <portal item id>}

//Output url:
"outputName":{"url": <image service url}

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

inputFlowDirectionRaster

The input raster that shows the direction of flow out of 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.

Examples:

1
2
3
4
5
//Portal item as input raster
"inputFlowDirectionRaster": {"itemId": <portal item id>}

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

distanceType

Determines whether the vertical or horizontal component of flow distance is calculated.

Syntax: A string describing the distance calculation type, which can be one of the following:

• VERTICAL calculations represent the vertical component of flow distance, following the flow path, from each cell in the domain to the cells on the stream into which they flow. This is the default.
• HORIZONTAL calculations represent the horizontal component of flow distance, following the flow path, from each cell in the domain to the cells on the stream into which they flow.

Example:

1
"distanceType": "HORIZONTAL"

flowDirectionType

The input flow direction raster can be of type D8, Multi Flow Direction (MFD), or D-Infinity (DINF).

Syntax: A string describing the flow direction type, which can be one of the following:

• D8 is for the D8 flow direction type. This is the default.

• MFD is for the Multi Flow Direction type.

• DINF is for the D-Infinity type.

Example:

1
"flowDirectionType": "DINF"

statisticsType

Determines the statistics type used to compute flow distance over multiple flow paths. If there is only a single flow path from each cell to a cell on the stream, all statistics types produce the same result.

Syntax: A string describing the statistics type, which can be one of the following:

• MINIMUM —Where multiple flow paths exist, minimum flow distance in computed. This is the default.
• WEIGHTED_MEAN —Where multiple flow paths exist, a weighted mean of flow distance is computed. Flow proportion from a cell to its downstream neighboring cells are used as weights for computing weighted mean.
• MAXIMUM —When multiple flow paths exist, maximum flow distance is computed.

context

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.

f

The response format. The default response format is html .

Values: html | json | pjson