convert to sicd utility (sarpy.utils.convert_to_sicd)

Convert from complex SAR image format to SICD format.

For a basic help on the command-line, check

>>> python -m sarpy.utils.convert_to_sicd --help
sarpy.utils.convert_to_sicd.convert(input_file, output_dir, preserve_nitf_information=False, dem_filename_pattern=None, dem_type=None, geoid_file=None)
Parameters:

  • input_file (str) – Path to the input file.

  • output_dir (str) – Output directory path.

  • preserve_nitf_information (bool) – Try to preserve NITF information? This only applies in the case that the file being read is actually a NITF file.

  • dem_filename_pattern (str | None) – Optional string specifying a Digital Elevation Model (DEM) filename pattern. This is a format string that specifies a glob pattern that will uniquely specify a DEM file from the Lat/Lon of the SW corner of the DEM tile. See the convert_to_sicd help text for more details.

  • dem_type (str | None) – Optional DEM type (‘GeoTIFF’, ‘GeoTIFF:WGS84’, ‘GeoTIFF:EGM2008’, etc.). This parameter is required when dem_filename_pattern is specified. For ‘GeoTIFF’ DEM files, the reference surface can be either WGS84 or any of the geoid models. The reference surface is appended to the DEM type with a ‘:’ separator. If the reference surface is not specified, then EGM2008 is assumed.

  • geoid_file (str | None) – Optional Geoid file which might be needed when dem_filename_pattern is specified.