Apply Orbit Correction (Image Analyst)

Available with Image Analyst license.

Summary

Updates the orbital information in the Sentinel-1 synthetic aperture radar (SAR) data using a more accurate orbit state vector (OSV) file.

Orbit files can be downloaded from external sources using the Download Orbit File tool.

Usage

  • For some SAR sensors, data is provided with predicted OSVs. More precise OSVs are updated and provided separately from the SAR data. This tool can be used to correct the OSVs for supported SAR data.

  • Use the Folder parameter to designate an alternative folder location to search for the downloaded orbit state vector files. The default folder is the input radar data .SAFE folder.

Parameters

LabelExplanationData Type
Input Radar Data

The input radar data.

Raster Dataset; Raster Layer
Input Orbit File

The input orbit file.

This parameter value will be automatically set if the orbit file is in the .SAFE directory. If the orbit file is not in the .SAFE directory, the path to the correct file must be specified manually.

File
Folder
(Optional)

The alternate folder location that will be searched for the downloaded orbit state vector files. The default folder is the input radar data .SAFE folder.

Folder

Derived Output

LabelExplanationData Type
Output Radar Data

The updated radar metadata file.

Raster Dataset; Raster Layer

ApplyOrbitCorrection(in_radar_data, in_orbit_file, {folder})
NameExplanationData Type
in_radar_data

The input radar data.

Raster Dataset; Raster Layer
in_orbit_file

The input orbit file.

File
folder
(Optional)

The alternate folder location that will be searched for the downloaded orbit state vector files. The default folder is the input radar data .SAFE folder.

Folder

Derived Output

NameExplanationData Type
out_radar_data

The updated radar metadata file.

Raster Dataset; Raster Layer

Code sample

ApplyOrbitCorrection example 1 (Python window)

This example updates the orbit file on a radar dataset with the specified OSV file.

import arcpy
arcpy.env.workspace = r"C:\Data\SAR"
arcpy.ia.ApplyOrbitCorrection("IW_manifest", 
      "S1B_IW_GRDH_1SDV_20181014T014104_20181014T014129_013142_018486_D82E.SAFE\S1A_OPER_AUX_POEORB_OPOD_20181104T120709_V20181014T225942_20181016T005942.EOF")
ApplyOrbitCorrection example 2 (stand-alone script)

This example updates the orbit file on a radar dataset with the specified OSV file.

# Import system modules and check out ArcGIS Image Analyst extension license
import arcpy
arcpy.CheckOutExtension("ImageAnalyst")
from arcpy.ia import *

# Set local variables
in_radar = r"C:\SAR\S1B_IW_GRDH_1SDV_20181014T014104_20181014T014129_013142_018486_D82E.SAFE\manifest.safe"
orbit_file = r"C:\SAR\orbits\S1\POE\S1A_OPER_AUX_POEORB_OPOD_20181104T120709_V20181014T225942_20181016T005942.EOF"

# Execute 
arcpy.ia.ApplyOrbitCorrection(in_radar, orbit_file)
ApplyOrbitCorrection example 3 (Python window)

This example batch updates the radar datasets with the orbit files if the orbit files have been saved to the .SAFE directory.

import arcpy
arcpy.env.workspace = r"C:\Data\SAR\S1"
arcpy.ia.ApplyOrbitCorrection("IW_manifest", "")
ApplyOrbitCorrection example 4 (stand-alone script)

This example downloads the orbit file to an alternate folder and applies the orbit correction in a loop.

# Import system modules and check out ArcGIS Image Analyst extension license
import arcpy
import os
arcpy.CheckOutExtension("ImageAnalyst")

# Set local variables
arcpy.env.workspace = r"C:\Data\SAR\S1"
username = "esaUsername"
password = "esaPassword"

# Execute 
raster_names = arcpy.ListRasters()
for raster_name in raster_names:
    name, ext = os.path.splitext(raster_name)
    in_radar = arcpy.Raster(os.path.join(arcpy.env.workspace, raster_name,'manifest.safe'))
    arcpy.ia.DownloadOrbitFile(in_radar, "SENTINEL_PRECISE", username, password)
    arcpy.ia.ApplyOrbitCorrection(in_radar,"")

Environments

This tool does not use any geoprocessing environments.

Related topics