Download Orbit File (Image Analyst)

Available with Image Analyst license.

Summary

Downloads the updated orbit files for Sentinel-1 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 orbit state vector (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 Data Space Ecosystem.

Usage

• Use the Username, Password, and Cloud Storage Connection parameters to download orbit state vectors from the Copernicus Data Space Ecosystem. For instructions on how to register for a Copernicus Data Space Ecosystem account and how to generate the S3 credentials, see Access to EO data via S3 on the Copernicus Data Space Ecosystem Documentation Portal.

  Use the generated S3 credentials in the Create Cloud Storage Connection File tool to generate an .acs file for the Cloud Storage Connection parameter. The following parameters must be set in the Create Cloud Storage Connection tool to create an .acs file:

  • Connection File Location
  • Connection File Name
  • Service Provider—AMAZON
  • Access Key ID (Account Name)
  • Secret Access Key (Account Key)
  • Bucket (Container) Name—eodata
  • Service End Point—eodata.dataspace.copernicus.eu
  • Provider Options—Using the AWS_VIRTUAL_HOSTING option equal to FALSE.

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

• 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 OSV type that will be downloaded. Sentinel Restituted—Approximate OSV data will be downloaded. This is available several hours after data acquisition. Sentinel Precise—Refined OSV data will be downloaded. This is available 20 days after data acquisition. This is the default.	String
Username (Optional)	The Copernicus Data Space Ecosystem login credential username. This parameter is only valid when the input data has Sentinel restituted or Sentinel precise orbit types.	String
Password (Optional)	The Copernicus Data Space Ecosystem login credential password. This parameter is only valid when the input data has Sentinel restituted or Sentinel precise orbit types.	Encrypted String
Cloud Storage Connection (Optional)	The Copernicus Data Space Ecosystem cloud storage connection file.	File
Folder (Optional)	An alternate folder location where the downloaded orbit state vector file will be stored. The default folder is the input radar data .SAFE folder.	Folder

Derived Output

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

Python

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

Name	Explanation	Data Type
in_radar_data	The input radar data.	Raster Dataset; Raster Layer
orbit_type (Optional)	Specifies the OSV type that will be downloaded. SENTINEL_RESTITUTED—Approximate OSV data will be downloaded. This is available several hours after data acquisition. SENTINEL_PRECISE—Refined OSV data will be downloaded. This is available 20 days after data acquisition. This is the default.	String
username (Optional)	The Copernicus Data Space Ecosystem login credential username. This parameter is only valid when the input data has Sentinel restituted or Sentinel precise orbit types.	String
password (Optional)	The Copernicus Data Space Ecosystem login credential password. This parameter is only valid when the input data has Sentinel restituted or Sentinel precise orbit types.	Encrypted String
cloud_storage (Optional)	The Copernicus Data Space Ecosystem cloud storage connection file.	File
folder (Optional)	An alternate folder location where the downloaded orbit state vector file will be stored. The default folder is the input radar data .SAFE folder.	Folder

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 precise orbit file to an alternative folder location.

import arcpy
arcpy.env.workspace =r"C:\Data\SAR"

arcpy.ia.DownloadOrbitFile("IW_manifest", "SENTINEL_PRECISE", 
     "esaUsername", "esaPassword", r"C:\connection_files\eodata.acs", r"C:\Data\SAR\Orbits")

DownloadOrbitFile example 2 (stand-alone script)

This example downloads the precise orbit file to an alternative folder location.

# 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:\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 precise 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 = r"C:\Data\SAR\S1\S S1B_IW_SLC__1SDV_20181014T014103_20181014T014130_013142_018486_1753.SAFE\manifest.safe\IW1"
orbit_type = "SENTINEL_PRECISE" 
username = "esaUsername"
password = "esaPassword"
cloud_storage = r"C:\connection_files\eodata.acs" 

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

Environments

This tool does not use any geoprocessing environments.