Create Viewshed

inputElevationSurface

(Required)

The input elevation surface for calculating viewshed.

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

Examples:

• "inputElevationSurface": {"itemId": <portal item id>}
• "inputElevationSurface": {"url": <image service layer url>}

inputObserverFeatures

(Required)

The input observer locations features.

Syntax: This parameter can be specified as one of the following:

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

Examples:

• "inputObserverFeatures": {"url": <feature service layer url>, "filter": <where clause>}
• "inputObserverFeatures": {"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"}}

optimizeFor

Choose the optimization method to use for calculating the viewshed.

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

• SPEED — The method used to calculate the viewshed is optimized for processing speed, trading some accuracy in the result for higher performance. This is the default.
• ACCURACY — The method used to calculate the viewshed is optimized for accuracy, at the expense of a longer processing time.

Example:

• "optimizeFor": "ACCURACY"

maximumViewingDistance

This is a cutoff distance where the computation of visible areas stops. Beyond this distance, it is unknown whether the analysis points and the other objects can see each other.

The value must be supplied through either the maximumViewingDistance parameter or the maximumViewingDistanceField parameter.

Syntax: A linear unit specifying the distance and units.

Supported units: Meters, Kilometers, Feet, Yards, Miles

• "maximumViewingDistance": {"distance": <value>, "units": <unit>}

maximumViewingDistanceField

Provide a field that specifies the maximum viewing distance for each observer. You can use any numerical field from the input observer point features.

The value contained in the field must be in the same unit as the XY unit of the input elevation surface.

Syntax: A string that represents a field name.

Example:

• "maximumViewingDistanceField": "radius2"

minimumViewingDistance

This is a distance where the computation of visible areas begins. The value must be supplied through either the minimumViewingDistance parameter or the minimumViewingDistanceField parameter.

Syntax: A linear unit specifying the distance and units.

Supported units: Meters, Kilometers, Feet, Yards, Miles

Example:

• "minimumViewingDistance": {"distance": <value>, "units": <unit>}

minimumViewingDistanceField

Provide a field that specifies the minimum viewing distance for each observer.

You can use any numerical field from the input observer point features. The value contained in the field must be in the same unit as the XY unit of the input elevation surface.

Syntax: A string that represents a field name.

Example:

• "minimumViewingDistanceField": "radius1"

viewingDistanceIs3D

Specify whether the minimumViewingDistance and maximumViewingDistanceinput parameters are measured in a three-dimensional or two-dimensional way.

Syntax: A boolean value as either true or false. If it is true, the viewing distances are measured in 3D. If it is false, the viewing distances are measured in 2D.

Default: false

observersElevation

Specify the elevation of your observer locations.

The value must be supplied through either the observersElevation parameter or the observersElevationField parameter.

Syntax: A linear unit specifying the elevation and units.

Supported units: Meters, Kilometers, Feet, Yards, Miles

Example:

• "observersElevation": {"distance": <value>, "units": <unit>}

observersElevationField

Provide a field that specifies the elevation for the observers.

You can use any numerical field from the input observer point features. The value contained in the field must be in the same unit as the Z unit of the input elevation surface.

Syntax: A string that represents a field name.

Example:

• "observersElevationField": "spot"

observersHeight

The height above ground of your observer locations.

The value must be supplied through either the observersHeight parameter or the observersHeightField parameter. During the viewshed calculation, this value is added to the observer elevation if it is specified; otherwise, it is added to the interpolated surface z-value.

Syntax: A linear unit specifying the height and units.

Supported units: Meters, Kilometers, Feet, Yards, Miles

Example:

• "observersHeight": {"distance": <value>, "units": <unit>}

observersHeightField

Provide a field that specifies the height for the observers. You can use any numerical field from the input observer point features.

The value contained in the field must be in the same unit as the Z unit of the input elevation surface.

Syntax: A string that represents a field name.

Example:

• "observersHeightField": "offseta"

targetHeight

Enter the height of structures, or people on the ground, used to establish visibility.

The value must be supplied through either the targetHeight parameter or the targetHeightField parameter.

Syntax: A linear unit specifying the height and units.

Supported units: Meters, Kilometers, Feet, Yards, Miles

Example:

• "targetHeight": {"distance": <value>, "units": <unit>}

targetHeightField

Provide a field that specifies the height for the targets. You can use any numerical field from the input observer point features.

The value contained in the field must be in the same unit as the Z unit of the input elevation surface

Syntax: A string that represents a field name.

Example:

• "targetHeightField": "offsetb"

aboveGroundLevelOutputName

The optional above ground level output image service name.

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:

"aboveGroundLevelOutputName":{"serviceProperties":{"name":"testagl"}}

Output raster examples:

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

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 output viewshed raster item ID and URL.

Examples:

{"url": 
"http://<raster analysis url>/CreateViewshed/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"
    }
}

outputAboveGroundLevelRaster

The output above ground level raster item ID and URL.

Example:

{"url": 
"http://<raster analysis url>/CreateViewshed/jobs/<jobId>/results/outputAboveGroundLevelRaster"}

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