ArcMap

Create S-57 Exchange Set

Summary

Allows a mariner to view the Electronic Navigational Chart (ENC) datasets in an Electronic Chart Display and Information System (ECDIS) for shipboard navigation. An exchange set is a package of files that contains one catalog file and at least one S-57 dataset file (New Edition [EN] and Revised Edition [ER]). Once you have exported and published your S-57 data, you need to package the S-57 dataset files into a valid S-57 exchange set.

Usage

  • Validate the S-57 dataset and clear it for publishing before creating the exchange set.

  • This tool packages referenced external files into a default ENC_ROOT directory as follows:

    • ENC: (*.txt, *.jpg, and *.tif)
    • IENC: (*.txt, *.jpg, *.tif, and *.xml)
    • AML: (*.txt, *.tif, *.pdf, *.html, *.htm, *.jpg, *.avi, and *.mpg)

  • This tool will automatically read all external files that are in the same folder as the S-57 product.

  • The S-57 base dataset is required when creating an exchange set for updates.

  • When using the Updates Only parameter, update datasets must be consecutive and can start with any number, for example, updates *.002 and *.004 must include *.003.

Syntax

arcpy.nautical.CreateS57ExchangeSet(input_directory, output_directory, layout_format, {updates_only})
ParameterExplanationData Type
input_directory
[input_directory,...]

Folders that contain at least one S-57 base cell (*.000) and, optionally, any of the following:

  • S-57 update datasets
  • README.txt file
  • Any referenced files in the S-57 cells (*.txt, *.tif, and *.jpg)

Folder
output_directory

The location of an empty folder where the ENC_ROOT folder will be written. The folder must be empty for the tool to execute successfully.

Folder
layout_format

Specifies the directory and folder structure of the exchange set.

  • VERSION_LAYOUT — The exchange set will be written in the format ENC_ROOT\ CATALOG.031, ENC_ROOT\<Agency>\<ProductName>\<MajorEdition>\<MinorEdition>\<S57Product and referenced files>.
  • PRODUCT_LAYOUT — The exchange set will be written in the format ENC_ROOT\CATALOG.031, ENC_ROOT\<ProductName> \<S57Product and referenced files>.
  • FLAT_LAYOUT —The exchange set will be written with the CATALOG.031 and all files located in the ENC_ROOT directory.
String
updates_only
(Optional)

Specifies how S-57 update datasets in the input folder will be processed.

  • INCLUDE_ALL —The output exchange set will include the S-57 base dataset and any updates. This is the default.
  • INCLUDE_ONLY_UPDATES — The output exchange set will include all the updates but not the S-57 base dataset. If there are no updates, the output will include the S-57 base dataset.
Boolean

Derived Output

NameExplanationData Type
out_directory

The location of an empty folder where the ENC_ROOT folder will be written.

Folder

Code sample

CreateS57ExchangeSet example (stand-alone script)

The following code example demonstrates how to use the CreateS57ExchangeSet tool.

# Import arcpy module
import arcpy

# Check for Nautical extension
if arcpy.CheckExtension("Nautical") == "Available":
    arcpy.CheckOutExtension("Nautical")
else:
    raise Exception("Maritime: Charting license is unavailable.")

input_directory="C:/input"
output_directory="C:/output"
layout_format="PRODUCT_LAYOUT"
updates_only="INCLUDE_ONLY_UPDATES"

# Process: Create S-57 Exchange Set
print "Creating exchange set"
arcpy.CreateS57ExchangeSet_nautical(input_directory, output_directory, layout_format, updates_only)
print "complete"

Environments

Licensing information

  • Basic: Requires ArcGIS Maritime
  • Standard: Requires ArcGIS Maritime
  • Advanced: Requires ArcGIS Maritime

Related topics