Build Footprints

imageCollection

(Required)

The output image collection (mosaic dataset) name or URL. The image service must exist before calling this service.

Syntax: JSON object supports three keys: itemId, url and uri. They keys are case sensitive.

Example:

1
2
3
4
5
{"itemId": "<portal item id>"}

{"url": "<image service url>"}

{"uri": "<cloud raster uri or shared data path>"}

computationMethod

(Required)

Specifies the method used to refine the footprints. The RADIOMETRY method excludes pixels with a value outside of a defined range. The RADIOMETRY method is generally used to exclude border areas, which do not contain valid data. The GEOMETRY method restores the footprint to its original geometry. The default method is RADIOMETRY.

Values: RADIOMETRY | GEOMETRY

valueRange

(Optional)

Exclude pixels with values outside this range.

context

(Optional)

Defines additional optional settings that affect task execution. These settings are defined in the Context Settings section below.

f

The response format. The default format is html.

Values: html | json | pjson

parallelProcessingFactor

The number of processes across which a tool will spread its operation.

minValue

Exclude pixels with a value less than this number.

maxValue

Exclude pixels with a value greater than this number.

numVertices

Choose between 4 and 10,000. More vertices will improve accuracy but can extend processing time. A value of -1 will calculate all vertices. More vertices will increase accuracy but also the processing time.

shrinkDistance

Clip the footprint by this distance. This can eliminate artifacts from using lossy compression, which causes the edges of the image to overlap into NoData areas. Shrinking of the polygon is used to counteract effects of lossy compression, which causes edges of the image to overlap into NoData areas.

maintainEdge

Use this parameter when using raster datasets that have been tiled and are adjacent (line up along the seams with little to no overlap). Default is False.

skipDerivedImages

Adjust the footprints of overviews. Default is True.

updateBoundary

Update the boundary of the mosaic dataset if you have added or removed imagery that changes the extent. Default is True.

requestSize

Set the resampled extent (in columns and rows) for the raster when building footprints. Greater image resolution provides more detail in the raster dataset but increases the processing time. A value of -1 will compute the footprint at the original resolution.

minRegionSize

Avoid small holes in your imagery when using pixel values to create a mask. For example, your imagery may have a range of values from 0 to 255, and to mask clouds, you`ve excluded values from 245 to 255, which may cause other, noncloud pixels to be masked as well. If those areas are smaller than the number of pixels specified here, they will not be masked out.

simplification

Reduce the number of vertices in the footprint to improve performance.

• NONE: Do not limit the number of vertices. This is the default.

• CONVEX_HULL: Use the minimum bounding box to simplify the footprint.

• ENVELOPE—Use: Use the envelope of each mosaic dataset item to simplify the footprint.

edgeTolerance

Snap the footprint to the sheet edge if it is within this tolerance. Units are the same as those in the mosaic dataset coordinate system. This is used when maintain_edges is set to MAINTAIN_EDGES. By default, the value is empty for which the tolerance is computed based on the pixel size corresponding to the requested resampled raster. A value of -1 will compute the tolerance using the average pixel size of the mosaic dataset.

maxSliverSize

Define the thinness of slivers on a scale from 0 to 1.0, where 1.0 represents a circle and 0.0 represents a polygon that approaches a straight line. Polygons that are below both the max_sliver_size and min_thinness_ratio will be removed from the footprint.

minThinnessRatio

Define the thinness of slivers on a scale from 0 to 1.0, where 1.0 represents a circle and 0.0 represents a polygon that approaches a straight line. Polygons that are below both the max_sliver_size and min_thinness_ratio will be removed from the footprint.