Optimal Region Connections

inputRegionsRasterOrFeatures

(Required)

The input regions that are to be connected by the least-cost network. Regions can be defined by either an image service or a feature service.

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.

Raster input examples:

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

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

Feature input examples:

1
2
3
4
5
//Feature layer URL
"inputRegionsRasterOrFeatures":{"url": <feature service layer url>}

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

outputOptimalLinesName

(Required)

The name of the output line feature service that connects each input region.

Each path (or line) is uniquely numbered, and additional fields in the attribute table store specific information about the path. Those additional fields are the following:

• PATHID—The unique identifier for the path
• PATHCOST—The total accumulative distance or cost for the path
• REGION1—The first region the path connects
• REGION2—The other region the path connects

This information provides insight into the paths within the network.

Since each path is represented by a unique line, there will be multiple lines in locations where paths travel the same route.

The task will create a feature service of the results. You can define the name of the service.

Output feature service examples:

1
2
3
4
5
//REST web example
myOutput

//REST scripting example
"outputOptimalLinesName" : "myOutput1"

inputBarrierRasterOrFeatures

The layer that defines the barriers to calculate the back direction around.

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

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

Raster input examples:

1
2
3
4
5
6
7
8
//Portal item as input raster
"inputBarrierRasterOrFeatures":"itemID": <portal item id>}

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

//Cloud raster as input raster
"inputBarrierRasterOrFeatures": {"uri": <cloud raster dataset uri>}

Feature input examples:

1
2
3
4
5
6
//Feature layer URL
"inputBarrierRasterOrFeatures":{"url":
<feature service layer url>}

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

inputCostRaster

A raster defining the impedance or cost to move planimetrically through each cell. The values of the cost raster can be integer or floating point. Negative and zero are invalid values but will be treated as very small positive cost values.

The value at each cell location represents the cost-per-unit distance for moving through the cell. Each cell location value is multiplied by the cell resolution while also compensating for diagonal movement to obtain the total cost of passing through the cell.

Cost raster values that are negative or zero are invalid but will be treated as small positive values. The accumulative cost algorithm is a multiplicative process, and it cannot calculate accumulative cost correctly if cost values are negative or zero. If your cost raster does contain those values, and those locations are to represent areas that should be excluded from the analysis, those cells should be turned into NoData before running the tool. Note that NoData is treated as a barrier in this analysis, so any locations that are NoData in the input will be NoData in the result.

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
"inputCostRaster": {"itemId": <portal item id>}

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

outputNeighborConnectionsName

The task will create a feature service of the results. You can define the name of the service.

Output feature service examples:

1
2
3
4
5
//REST web example
myOutput

//REST scripting example
"outputNeighborConnectionsName" : "myOutput2"

distanceMethod

Determines whether to calculate the distance 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 method.
• GEODESIC : Distances are calculated on the ellipsoid. Therefore, regardless of input or output projection, the results do not change.

connectionsWithinRegions

Specifies whether the paths will continue and connect within the input regions.

• GENERATE_CONNECTIONS : Paths will continue within the input regions to connect all paths that enter a region.
• NO_CONNECTIONS : Paths will stop at the edges of the input regions and will not continue or connect within them.

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