Geomorphon Landforms

inputSurfaceRaster (Required)

The input surface raster.

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
//Input surface raster as portal item
"inputSurfaceRaster": {"itemId": <portal item id>}

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

outputLandformsRasterName (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 landforms raster name example: Example:

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

Output landforms raster examples: Example:

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

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

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

outputGeomorphonsRasterName

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 geomorphons raster name example: Example:

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

Output geomorphons raster examples: Example:

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

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

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

angleThreshold

Specifies the threshold (in degrees) below which the target cell will be classified as flat.

The default is 1.

Syntax: A numeric value specifying the angle threshold.

Example:

1
"angleThreshold": 2

distanceUnits

Specifies the distance unit that will be used for the searchDistance and skipDistance parameters.

Distance will be measured in the specified unit or number of cells. The default is CELLS.

Syntax: A string specifying the unit of the search and skip distances.

• CELLS—The distance unit will be cells.
• METERS—The distance unit will be meters.
• CENTIMETERS—The distance unit will be centimeters.
• KILOMETERS—The distance unit will be kilometers.
• INCHES—The distance unit will be inches.
• FEET—The distance unit will be feet.
• YARDS—The distance unit will be yards.
• MILES—The distance unit will be miles.

Example:

1
"distanceUnits": "METERS"

searchDistance

Specifies the distance away from the target cell that defines the analysis area used to identify the geomorphon pattern.

The default value is 10.

Syntax: A numeric value specifying the search distance.

Example:

1
"searchDistance": 50

skipDistance

Specifies the distance away from the target cell where the analysis area starts. Neighboring cells that fall within this distance will be skipped and will not contribute to identification of the geomorphon pattern.

The skipDistance value must be smaller than the searchDistance value.

Syntax: A numeric value specifying the skip distance.

Example:

1
"skipDistance": 10

zUnit

Specifies the linear unit of vertical z-values.

It is defined by a vertical coordinate system if it exists. If a vertical coordinate system does not exist, it is recommended that you define the z-unit from the unit list to ensure correct geodesic computation. The default is meter.

Syntax: A string specifying the unit of vertical z-values.

• INCH —The linear unit will be inches.
• FOOT —The linear unit will be feet.
• YARD —The linear unit will be yards.
• MILE_US —The linear unit will be miles.
• NAUTICAL_MILE —The linear unit will be nautical miles.
• MILLIMETER —The linear unit will be millimeters.
• CENTIMETER —The linear unit will be centimeters.
• METER —The linear unit will be meters.
• KILOMETER —The linear unit will be kilometers.
• DECIMETER —The linear unit will be decimeters.

Example:

1
"zUnit": "KILOMETER"

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