URL:
https://<root>/System/RealitymappingTools/GPServer/ReconstructSurface
Methods:
GET
Version Introduced:
12.2

Describe

The ReconstructSurface operation is a service tool to generate True Ortho, DEM and 3D products from an adjusted image collection. Based on the selected products, the tool will either create new imagery layers or scene layers. Additionally, the tool can also support additional waterbody and correction feature layer input to further refine the result.

Request parameters

ParameterDetails

imageCollection

(Required)

The portal item id, image service url or image collection path of the image collection to use for product generation. The input service must be dynamic imagery layer referencing mosaic dataset. And the image collection must already be block adjusted.

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

Use dark colors for code blocksCopy
1
2
3
{"itemId": "<portal item id>"}
{"url": "<image service url>"}
{"uri": "<image collection dataset path>"}

outputProducts

(Required)

The list of products that will be generated by the service tool. Supported output products include DSM, True_Ortho, Mesh, Point_Cloud, Gaussian_Splats.

Among the supported output products, DSM and True_Ortho are imagery layers, Mesh and Point_Cloud are scene layers, while Gaussian_Splats is gaussian splat layer. In the case of DSM and True_Ortho, the hosted imagery layer could be pre-created and with existing itemId or service URL or be created by tool.

Syntax: A JSON object describes the name or url of the output imagery layer, scene layer or gaussian splat layer service.

Use dark colors for code blocksCopy
1
{"true_Ortho": {"itemId": "<portal item id>"}, "dsm": {"url": "<hosted image service url>"}, "mesh": {"name": "<3D mesh item name>"}}

DSM and True_Ortho are hosted imagery layer output. The hosted imagery layer could be pre-created and with existing itemId or service URL.

Imagery layers can also be created by the tool if not pre-created. If the client request service tool to create the output imagery layer, use the syntax as the following:

Use dark colors for code blocksCopy
1
2
{"true_ortho": {"serviceProperties": {"name": "<dtm name>"}}}
{"dsm": {"serviceProperties": {"name":"<dsm name>"}}}

Mesh product can not be pre-created. It can only be created by the service tool, so only the name of the new item is needed:

Use dark colors for code blocksCopy
1
{"mesh": {"itemProperties": {"name":"<mesh name>"}}}

scenario

(Optional)

This option defines the internal production generation settings based on the data scenario defined.

DEFAULT — Optimal for most data scenarios including drone nadir and oblique drone images. This is the default setting.

AERIAL_NADIR — Specifically for nadir images taken by Aerial cameras. Two additional options can be given in the reconstruct option parameter for this scenario. e.g. {"forwardOverlap": 60, "sidewardOverlap": 30}

AERIAL_OBLIQUE — Specifically for oblique images taken by Aerial cameras. In this scenario, only the 3D product generation is supported.

SATELLITE - For satellite images.

quality

(Optional)

This option defines the quality of the output production.

ULTRA - the output product will be generated at the 1:1 source resolution of the image. HIGH - the output product will be generated at 2x source resolution of the image. RAPID – the output product will be generated at an adjusted quality based on solution points to serve workflows where a quick result is needed.

areaOfInterest

(Optional)

Area of interest feature class for the output product. If output extent is also given in the context parameter, the final output product’s extent will be the intersection of both.

Use dark colors for code blocksCopy
1
{"url": "<feature service url>"}

waterBody

(Optional)

Waterbody feature class helps refine the output product generation.

Use dark colors for code blocksCopy
1
{"url": "<feature service url>"}

correctionFeature

(Optional)

Correction feature class helps refine the output product generation.

Use dark colors for code blocksCopy
1
{"url": "<feature service url>"}

reconstructOptions

(Optional)

Additional reconstruct options for the SURE engine.

Currently supported are:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "forwardOverlap": 60,
  "sitewardOverlap": 30,
  "tileSize": "AUTO",
  "cellSize": "AUTO",
  "lidarPointCloud": "/fileShares/pcfolder",
  "lidarTrajectory": "/fileShares/ltfolder"
}

context

(Optional)

Contains additional settings that affect task execution. This task has the following settings: 

• Extent (extent): A bounding box that defines the analysis area.  • Parallel Processing Factor (parallelProcessingFactor)—The specified number or percentage of processes will be used for the analysis. • Processor Type (processorType) - You can process your data using the computer central processing unit (CPU) or the graphics processing unit (GPU).

f

The response format. The default response format is html.

Values: html | json | pjson

Response

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

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

Use dark colors for code blocksCopy
1
https://<realitymapping tools url>/ReconstructSurface/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:

Use dark colors for code blocksCopy
1
https://<realitymapping tools url>/ReconstructSurface/jobs/<jobId>/results/outProducts?token=<your token>&f=json

Example usage

The following is a sample URL for ReconstructSurface :

Use dark colors for code blocksCopy
1
https://services.myserver.com/arcgis/rest/services/System/RealitymappingTools/GPServer/ReconstructSurface/submitJob

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.