Export Training Data For Deep Learning
- URL:https://<rasteranalysistools-url>/ExportTrainingDataforDeepLearning
- Related Resources:Add Image, Calculate Density, Calculate Distance, Calculate Travel Cost,Classify, Classify Pixels Using Deep Learning, Convert Feature to Raster, Convert Raster Function Template, Convert Raster to Feature, Copy Raster, Create Image Collection, Create Viewshed, Delete Image, Delete Image Collection, Detect Objects Using Deep Learning, Determine Optimum Travel Cost Network, Determine Travel Cost Paths to Destinations, Determine Travel Cost Path as Polyline, Fill, Flow Accumulation, Flow Direction, Flow Distance, Generate Raster, Install Deep Learning Model, Interpolate Points, List Deep Learning Model Info, Nibble, Query Deep Learning Model Info, Segment, Stream Link, Summarize Raster Within, Train Classifier, Uninstall Deep Learning Model, Watershed
- Version Introduced:10.7
Description

The ExportTrainingDataforDeepLearning operation is designed to generate training sample image chips from the input imagery data with labeled vector data or classified images. The output of this service tool is the data store string where the output image chips, labels, and metadata files are going to be stored.
Request parameters
Parameter | Details |
|---|---|
| inputRaster (Required) | The portal item Id, image service URL, cloud raster dataset, or shared raster dataset that will be classified. At least one type of input needs to be provided in the JSON object. If multiple inputs are given, the itemId takes priority. Syntax: JSON object describes the input raster. Example: |
| outputLocation (Required) | This is the output location for training sample data. It can be just the output folder name, or the path of the output location on the file share raster data store, or a shared file system path. Output folder name example: File share raster store path example: File share path example: |
| inputClassData (Required) | Labeled data, either a feature service or image service. Vector inputs should follow a training sample format as generated by the ArcGIS Pro Training Sample Manager, whereas raster inputs should follow a classified raster format as generated by the Classify Raster tool. Example: |
| chipFormat | The raster format for the image chip outputs. Values: TIFF | PNG | JPEG | MRF (Meta Raster Format) Example: |
| tileSize | The size of the image chips. Example: |
| strideSize | The distance to move in the x and y when creating the next image chip. When stride is equal to the tile size, there will be no overlap. When stride is equal to half of the tile size, there will be 50 percent overlap. Example: |
| metadataFormat | The format of the output metadata labels. The four options for output metadata labels for the training data are KITTI rectangles, PASCAL VOC rectangles, Classified Tiles (a class map), and RCNN Masks. If your input training sample data is a feature class layer, such as a building layer or standard classification training sample file, use the KITTI or PASCAL VOC rectangles option. The output metadata is a .txt file or .xml file containing the training sample data contained in the minimum bounding rectangle. The name of the metadata file matches the input source image name. If your input training sample data is a class map, use the Classified Tiles option as your output metadata format. Values:
PASCAL_VOC_rectangles example: |
| classValueField | The field that contains the class values. If no field is specified, the system searches for a value or classvalue field. If the feature does not contain a class field, the system determines that all records belong to one class. Example: |
| bufferRadius | The radius for a buffer around each training sample to delineate a training sample area. This allows you to create circular polygon training samples from points. Example: |
| inputMaskPolygons | A polygon feature class that delineates the area where image chips will be created. Only image chips that fall completely within the polygons will be created. Example: |
| rotationAngle | The rotation angle that will be used to generate additional image chips. An image chip will be generated with a rotation angle of 0, which means no rotation. It will then be rotated at the specified angle to create an additional image chip. The same training samples will be captured at multiple angles in multiple image chips for data augmentation. The default rotation angle is 0. Example: |
| context | Contains settings that affect task execution. This task has the following settings:
|
| f | The response format. The default response format is html. Values: html | json |
Additional KITTI metadata format information
The table below describes the 15 values in the KITTI metadata format. Only 5 of the possible 15 values are used in the tool: the class name (in column 1) and the minimum bounding rectangle composed of four image coordinate locations (columns 5–8). The minimum bounding rectangle encompasses the training chip used in the deep learning classifier.
Columns | Name | Description |
|---|---|---|
1 |
Class value |
The class value of the object listed in the stats.txt file. |
2–4 |
Unused |
|
Columns | Name | Description |
5–8 |
Bbox |
The two-dimensional bounding box of objects in the image, based on a 0-based image space coordinate index. The bounding box contains the four coordinates for the left, top, right, and bottom pixels. |
9–15 |
Unused |
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://<raster analysis tools url>/ExportTrainingDataforDeepLearning/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://<raster analysis tools url>/ExportTrainingDataforDeepLearning/jobs/<jobId>/results/outLocation
Example usage
Below is a sample request URL for ExportTrainingDataforDeepLearning.
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/ExportTrainingDataforDeepLearning
JSON Response example
The response returns the outLocation parameter, which has properties for parameter name, data type, and value. The content of the value is always the output data store item's itemId or URL. The parameter provides the output location of the training data.
{
"paramName": "outLocation",
"dataType": "GPString",
"value": {
"uri": "/rasterStores/myrasterstore/rooftops"
}
}