Export Geodatabase To S-57 (Maritime)

Available with Maritime Charting license.

Summary

Exports hydrographic data from a maritime charting geodatabase to an S-57 file.

The following processes will execute automatically:

  • Extract data
  • Clip data at boundary of the product coverage polygon
  • Group soundings
  • Generate FE Name
  • Generate or update primitives
  • Calculate SCAMIN

Usage

  • The exported cell is compressed (ZIP format) and stored as a BLOB in the ProductExports table in the NIS if the Sample Export parameter is unchecked.

Parameters

LabelExplanationData Type
Source Geodatabase

The database from which the product will be exported.

Workspace
S-57 Product

The name of the product to export. This product metadata entry must exist in the ProductDefinition table, and the related extents must be present in the ProductCoverage feature class in the workspace.

String
Export Type

Specifies the type of file that will be created during the export.

  • New Dataset A new dataset including information that has not been previously distributed by updates will be created.
  • New Edition A new edition of a dataset including information that has not been previously distributed by updates will be created.
  • Update Changes in a dataset since the last export will be reflected in the file.
  • Reissue A reissue of a dataset including all the updates applied to the original dataset up to the date of reissue will be created. A reissue does not contain information that has not been previously issued by updates.
  • Cancel When a dataset is deleted, an updated cell file is created containing only the Dataset General Information record with the Dataset Identifier (DSID) field. In this case, the Edition Number (EDTN) subfield must be set to 0.
String
Output Location

The location containing the output export package.

Folder
Product Configuration File
(Optional)

The configuration file that will be used to export the product.

File
Clip Features at M_CSCL
(Optional)

Specifies whether the export process will clip data that crosses an M_CSCL feature.

  • Checked—Features in the source database that cross the boundary of an M_CSCL feature will be clipped to the boundary in the exported file.
  • Unchecked—Features in the source database that cross the boundary of an M_CSCL feature will not be clipped to the boundary in the exported file. This will result in the features remaining intact in the output. This is the default.
Boolean
Sample Export
(Optional)

Specifies whether the product will be exported as a sample.

  • Checked—The exported cell is not stored in the ProductExports table and the metadata information will not be updated in the ProductDefinition table.
  • Unchecked—The exported cell is stored in the ProductExports table as a BLOB, and the edition, update, and other metadata in the ProductDefinition table will be updated. This is the default.
Boolean
SCAMIN Configuration File
(Optional)

A custom configuration file that contains the rules for calculating a feature's SCAMIN value that overrides the default Radar Range SCAMIN method.

File

Derived Output

LabelExplanationData Type
Output File

The exported S-57 cell.

File

arcpy.maritime.ExportGeodatabaseToS57(in_source_gdb, product, export_type, out_location, {in_product_config}, {clip_data_option}, {sample_export}, {in_scamin_file})
NameExplanationData Type
in_source_gdb

The database from which the product will be exported.

Workspace
product

The name of the product to export. This product metadata entry must exist in the ProductDefinition table, and the related extents must be present in the ProductCoverage feature class in the workspace.

String
export_type

Specifies the type of file that will be created during the export.

  • NEW_DATASET A new dataset including information that has not been previously distributed by updates will be created.
  • NEW_EDITION A new edition of a dataset including information that has not been previously distributed by updates will be created.
  • UPDATE Changes in a dataset since the last export will be reflected in the file.
  • REISSUE A reissue of a dataset including all the updates applied to the original dataset up to the date of reissue will be created. A reissue does not contain information that has not been previously issued by updates.
  • CANCEL When a dataset is deleted, an updated cell file is created containing only the Dataset General Information record with the Dataset Identifier (DSID) field. In this case, the Edition Number (EDTN) subfield must be set to 0.
String
out_location

The location containing the output export package.

Folder
in_product_config
(Optional)

The configuration file that will be used to export the product.

File
clip_data_option
(Optional)

Specifies whether the export process will clip data that crosses an M_CSCL feature.

  • CLIPFeatures in the source database that cross the boundary of an M_CSCL feature will be clipped to the boundary in the exported file.
  • DO_NOT_CLIP Features in the source database that cross the boundary of an M_CSCL feature will not be clipped to the boundary in the exported file. This will result in the features remaining intact in the output. This is the default.
Boolean
sample_export
(Optional)

Specifies whether the product will be exported as a sample.

  • SAMPLE_EXPORTThe exported cell is not stored in the ProductExports table and the metadata information will not be updated in the ProductDefinition table.
  • OFFICIAL_EXPORT The exported cell is stored in the ProductExports table as a BLOB, and the edition, update, and other metadata in the ProductDefinition table will be updated. This is the default.
Boolean
in_scamin_file
(Optional)

A custom configuration file that contains the rules for calculating a feature's SCAMIN value that overrides the default Radar Range SCAMIN method.

File

Derived Output

NameExplanationData Type
out_file

The exported S-57 cell.

File

Code sample

ExportGeodatabaseToS57 example (stand-alone script)

The following code sample demonstrates how to use the ExportGeodatabaseToS57 function to export to an S-57 file.

# Import arcpy module
import arcpy

# Tool variables
src_gdb = r'C:\Data\Connection Files\nsbisdb4_pacific_pl@editor.sde'
product = 'US5M3978'
output_path = r'C:\Data'
export_type = 'NEW_EDITION'
product_config = r'C:\Data\NIS_Product_custom.xml'
clip_option = 'DO_NOT_CLIP'
sample = 'SAMPLE_EXPORT'
in_scamin_file = r'C:\Data\customSCAMIN RadarRange Method.xml'

# Execute the tool
arcpy.maritime.ExportGeodatabaseToS57(src_gdb, product, export_type, output_path, product_config, clip_option, sample, in_scamin_file)

Environments

Licensing information

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

Related topics