Download Orbit File (Image Analyst)

Available with Image Analyst license.

Summary

Downloads the updated orbit files for the input synthetic aperture radar (SAR) data.

This tool uses the orbit type to make a call to the orbit website. Using the SAR metadata, it identifies the appropriate OSV file and downloads it to the input SAR data directory.

Three types of OSVs are available for a Sentinel-1 product: predicted, restituted, and precise. Predicted OSVs are provided with the Sentinel-1 Level 1 ground range detected (GRD) and single look complex (SLC) auxiliary products. Restituted OSVs are available through the European Space Agency (ESA) within 3 hours of image acquisition. Precise OSVs are available through ESA within 3 weeks of image acquisition. Sentinel-1 OSV files are downloaded from the Copernicus Sentinels POD Data Hub.

Usage

• Login credentials are needed to download orbit state vectors. Get a guest username and password from the Copernicus Sentinels POD Data Hub.

• If the SAR data was acquired within the last 3 weeks, set the Orbit Type parameter to Sentinel Restituted. This is available 3 hours after data acquisition.

• To update the SAR data with the OSVs downloaded using this tool, use the Apply Orbit Correction tool.

Parameters

Dialog

Label	Explanation	Data Type
Input Radar Data	The input radar data.	Raster Dataset; Raster Layer
Orbit Type (Optional)	Specifies the orbit state vector type that will be downloaded. Sentinel Restituted—Approximate orbit state vector data will be downloaded. This is available several hours after data acquisition. Sentinel Precise—Refined orbit state vector data will be downloaded. This is available 20 days after data acquisition. This is the default.	String
Username (Optional)	The username credential.	String
Password (Optional)	The password credential.	Encrypted String

Derived Output

Label	Explanation	Data Type
Orbit File	The output orbit file.	File

Python

DownloadOrbitFile(in_radar_data, {orbit_type}, {username}, {password})

Name	Explanation	Data Type
in_radar_data	The input radar data.	Raster Dataset; Raster Layer
orbit_type (Optional)	Specifies the orbit state vector type that will be downloaded. SENTINEL_RESTITUTED—Approximate orbit state vector data will be downloaded. This is available several hours after data acquisition. SENTINEL_PRECISE—Refined orbit state vector data will be downloaded. This is available 20 days after data acquisition. This is the default.	String
username (Optional)	The username credential.	String
password (Optional)	The password credential.	Encrypted String

Derived Output

Name	Explanation	Data Type
out_orbit_file	The output orbit file.	File

Code sample

DownloadOrbitFile example 1 (Python window)

This example downloads the restituted orbit file.

import arcpy
arcpy.env.workspace = "D:\Data\SAR\S1"
arcpy.ia.DownloadOrbitFile("IW_manifest", "SENTINEL_PRECISE", 
     "esaUsername", "esaPassword")

DownloadOrbitFile example 2 (stand-alone script)

This example downloads the restituted orbit file for a manifest.safe 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 = "D:\Data\SAR\S1\S1B_IW_GRDH_1SDV_20181014T014104_20181014T014129_013142_018486_D82E.SAFE\manifest.safe" 
orbit_type = "SENTINEL_PRECISE"
username = "esaUsername"
password = "esaPassword"

# Execute 
arcpy.ia.DownloadOrbitFile(in_radar, orbit_type, username, password)

DownloadOrbitFile example 3 (stand-alone script)

This example downloads the restituted orbit file for a manifest.safe\IW 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 = "D:\Data\SAR\S1\S1B_IW_GRDH_1SDV_20181014T014104_20181014T014129_013142_018486_D82E.SAFE\manifest.safe\IW" 
orbit_type = "SENTINEL_PRECISE" 
username = "esaUsername"
password = "esaPassword"

# Execute 
arcpy.ia.DownloadOrbitFile(in_radar, orbit_type, username, password)

Environments

This tool does not use any geoprocessing environments.

Licensing information

• Basic: Requires Image Analyst
• Standard: Requires Image Analyst
• Advanced: Requires Image Analyst