Match Control Points

URL:
https://<root>/System/OrthomappingTools/GPServer/MatchControlPoints
Methods:
GET
Version Introduced:
10.6.1

Description

Match Control Points diagram

The MatchControlPoints operation is a service tool that computes matching tie points using a collection of ground control points having at least one tie point. The input collection of ground control points must be in JSON.

Request parameters

ParameterDetails

imageCollection

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

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

Example:

Use dark colors for code blocksCopy
1
2
3
{"itemId": “<portal item id>”}
{“url”: “<image service url>”}
{“uri”: “<cloud raster uri or shared data path>”}

inputControlPoints

(Required)

The ground control points (GCP) sets written as a JSON object. The similarity tolerance for finding control points will be low.

Syntax: The schema of the control points' JSON follows the schema of the mosaic dataset's control point table. The control points must contain one geometry and attribute set. There are two types of control points determined by the type attribute: tie points and ground control points .

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[
 {
  "pointId": <id>,
  "x":
  "y":
  "z":
  "xyAccuracy":
  "zAccuracy":
  "spatialReference":{<spatialReference>}, //default WGS84
  "imagePointSpatialReference": {}, // default ICS
  "imagePoints": [
     {"imageId":
      "x":
      "y":
     },
  ]
 }
]

similarity

(Optional)

Sets the similarity tolerance level for your matching control point. Low tolerance will produce the most control points, but some may have a higher level of error. Medium tolerance will produce a medium amount of control points. High tolerance will produce the least number of control points, but each matching pair will have a lower level of error. High tolerance is the default value.

context

Identifies additional settings such as the input control points spatial reference, which can be specified here. The context parameter is used to define both groundControlPointsSpatialReference and imagePointsSpatialReference . If these two parameters are not defined, the tool will use the spatial reference defined in the input point set. If no spatial reference is defined in the input point set, the default ground control point coordinates are in longitude-latitude, and the image points coordinates are in the image coordinate system.

Use dark colors for code blocksCopy
1
2
{"groundControlPointsSpatialRefrence": {"wkid": 3459},
"imagePointSpatialReference": {"wkid": 3459}}

f

The response format. The default response format is html.

Values: html | json

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://<orthomapping tools url>/MatchControlPoints/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://<orthomapping tools url>/MatchControlPoints/jobs/<jobId>/results/result?token=<your token>&f=json

The result will be a JSON file.

Example usage

Below is a sample URL for MatchControlPoints .

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

JSON Request example

Use dark colors for code blocksCopy
1
2
3
4
5
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
inputControlPoints={
{"geometry": {"x":-118.15,"y":33.80,"z":10.0,"spatialReference":{"wkid":4326}},
 "attributes": {"imageID":22, "pointID":2, "type":2, "status":1}
}

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