- URL:
- https://<root>/<serviceName>/RasterAnalysisTools/GPServer/GeodesicViewshed
- Methods:
GET
- Version Introduced:
- 11.3
Description
The Geodesic
task determines the raster surface locations visible to a set of observer features using geodesic methods.
Request parameters
Parameter | Details |
---|---|
(Required) | The elevation surface to use for calculating the viewshed. Examples:
|
(Required) | The point features that represent the observer locations when calculating the viewsheds. Examples:
|
(Required) | The name of the output viewshed 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:
Output raster examples:
|
(Optional) | The optimization method to use for calculating the viewshed. The options are as follows:
Syntax: A string describing the optimization method. Example:
|
(Optional) | The type of visibility analysis you wish to perform, either determining how visible each cell is to the observers, or identifying for each surface location which observers are visible. The options are as follows:
Syntax: A string describing the optimization method. Example:
|
(Optional) | The amount of uncertainty (the root mean square error, or RMS error) in the surface elevation values. It is a linear unit value representing the expected error of the input elevation values. Syntax: A linear unit specifying the vertical error. Example:
|
(Optional) | The coefficient of the refraction of visible light in air. Syntax: A numerical value specifying the refractivity coefficient. Example:
|
(Optional) | The 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. Syntax: A linear unit specifying the distance and units, or a numerical or string field in the inputObserverFeatures data. Linear unit example:
Field example:
|
(Optional) | The distance where the computation of visible areas begins. Syntax: A linear unit specifying the distance and units, or a numerical or string field in the inputObserverFeatures data. Linear unit example:
Field example:
|
(Optional) | Specifies whether the minimumViewingDistance and maximumViewingDistance input parameters will be measured in a three-dimensional or two-dimensional way. Syntax: A Boolean value as either true or false.
Example:
|
(Optional) | The elevation of the observer locations. Syntax: A linear unit specifying the elevation and units, or a numerical or string field in the inputObserverFeatures data. Linear unit example:
Field example:
|
(Optional) | The height above ground of the observer locations. 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, or a numerical or string field in the inputObserverFeatures data. Linear unit example:
Field example:
|
(Optional) | The height of structures, or people on the ground, that will be used to establish visibility. Syntax: A linear unit specifying the height and units, or a numerical or string field in the inputObserverFeatures data. Linear unit example:
Field example:
|
(Optional) | The start angle of the horizontal scan range. The value is specified in degrees from 0 to 360, either as integer or floating point, with 0 oriented to north. Syntax: A numerical value, or a numerical field in the inputObserverFeatures data. Value example:
Field example:
|
(Optional) | The end angle of the horizontal scan range. The value is specified in degrees from 0 to 360, either as integer or floating point, with 0 oriented to north. Syntax: A numerical value, or a numerical field in the inputObserverFeatures data. Value example:
Field example:
|
(Optional) | The upper vertical angle limit of the scan relative to the horizontal plane. The value is specified in degrees and can be integer or floating point. The allowed range is from above -90 up to and including 90. Syntax: A numerical value, or a numerical field in the inputObserverFeatures data. Value example:
Field example:
|
(Optional) | The lower vertical angle limit of the scan relative to the horizontal plane. The value is specified in degrees and can be integer or floating point. The allowed range is from above -90 up to and including 90. Syntax: A numerical value, or a numerical field in the inputObserverFeatures data. Value example:
Field example:
|
(Optional) | The optional above ground level output image service name. 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:
Output raster examples:
|
(Optional) | The optional output table for identifying the regions that are visible to each observer. This output is only created when the analysisType parameter value is OBSERVERS. 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 table. Output name example:
Output table examples:
|
(Optional) |
Contains additional settings that affect task processing. This task has the following settings:
|
|
The response format. The default response format is Values: |
Response
When you submit a request, the task assigns a unique job ID for the transaction.
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}
After the initial request is submitted, you can use the job
to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, you use the job
to retrieve the results. To track the status, you can make a request of the following form:
https://<raster analysis tools url>/GeodesicViewshed/jobs/<jobId>
When the status of the job request is esri
, you can access the results of the analysis by making a request of the following form:
https://<raster analysis tools url>/GeodesicViewshed/jobs/<jobId>/results/<output parameters>
Example usage
The following is a sample request URL for Geodesic
:
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/GeodesicViewshed/submitJob
JSON Response syntax
The response returns the output
output parameter, which has properties for parameter name, data type, and value. The content of value
is always the output raster dataset item
and the image service URL.
{
"paramName": <parameter name>,
"dataType": "GPString",
"value": {
"itemId": <item Id>,
"url": <URL>
}
}
JSON Response example
{
"paramName": "outRaster",
"dataType": "GPString",
"value": {
"itemId": "f121390b85ef419790479fc75b493efd",
"url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
}
}