ArcGIS REST API

Generate Orthomosaic

Description

Generate Orthomosaic diagram

The GenerateOrthomosaic operation is a service tool that's used to generate a single orthorectified, mosaicked image from an image collection after the block adjustment.

License:
As of ArcGIS 10.5, you must license your ArcGIS Server as an ArcGIS Image Server to use this resource.

Request parameters

ParameterDetails
imageCollection

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

Syntax: A JSON object supports three case-sensitive keys: itemId, url, and uri.

Example:

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

outputOrthoImage

(Required)

This is the output mosaicked orthoimage converted from the image collection after the block adjustment.

Syntax: A JSON object describes the output image collection name or URL.

{"serviceProperties": {"name": "<service name>"}}
{"itemId": "<portal item id>"}
{"url": "<image service url>"}
{"uri": "<cloud raster uri or shared data path>"}

regenSeamlines

(Optional)

Specifies whether seamlines are applied before the orthomosaic image generation. The seamlines are regenerated if this flag is turned on. You can set the seamline options through the context parameter. If the seamline generation options are not set, the default is used.

recomputeColorCorrection

(Optional)

Specifies whether color correction settings are applied to the output orthoimage. Color correction is recomputed if this option is turned on. You can configure the compute color correction settings through the context parameter. If there is no color collection setting, the default is used.

context

(Optional)

Contains additional environment settings that affect output image. The following are the supported environment settings for this parameter:

  • Extent (extent)—A bounding box that defines the analysis area. Only those areas in the inputZoneLayer that intersect the bounding box will have the statistics calculated.
  • Output Spatial Reference (outSR)—The output raster will be projected into the output spatial reference.
  • Cell Size (cellSize)—The output raster will have the resolution specified by cell size.
  • Compute Seamlines (seamlinesMethod)—Default.
  • Clipping Geometry (clippingGeometry)—Clips the orthomosaic image to an area of interest defined by the geometry.
  • Orthomosaic As Overview (orthoMosaicAsOvr)—Adds the orthomosaic as an overview of the image collection.
  • Compute Color Correction (colorcorrectionMethod)—Default.

{
 "outSR": {"wkid": 3516}, 
 "extent": {"xmin": 470614.263139, "ymin": 8872849.409968, "xmax": 532307.351827, "ymax": 8920205.372412, "spatialReference": {"wkid": 32628}},
 "clippingGeometry": {},
 "orthoMosaicAsOvr": False,
 "seamlinesMethod": "VORONOI", "minRegionSize": 100, "pixelSize": "", "blendType": "Both", "blendWidth": None, "blendUnit": "Pixels", "requestSize": 1000, "minThinnessRatio": 0.05, "maxSliverSize": 20
 "colorCorrectionMethod": "DODGING", "dodgingSurface": "Single_Color", "referenceImg": {"url": https://..."}, "skipRows": 10, "skipCols": 10, "reCalculateSats": "OVERWRITE"
}

f

Values: html | json

Values: html | json

Response

When you submit a request, the task assigns a unique job ID for the transaction.

Syntax:

{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use the jobId 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 jobId to retrieve the results. To track the status, you can make a request of the following form:

https://<orthomapping tools url>/GenerateOrthomosaic/jobs/<jobId>

When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:

https://<orthomapping tools url>/GenerateOrthomosaic/job/<jobId>/results/result?token=<your token>&f=json

The result will be the image service URL and item ID of the orthomosaicked image.

Example usage

Below is a sample URL for GenerateOrthomosaic.

https://services.myserver.com/arcgis/rest/services/System/OrthomappingTools/GPServer/GenerateOrthomosaic/submitJob

The result will be the image service URL and itemId of the orthomosaicked image.

JSON Request example

imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
outputOrthoImage={"serviceProperties":{"name": "dronedtm"}}&
regenSeamline=true&
recomputeColorCorrection=true&
context={"outSR": {"wkid": 3516}}