Validate S-57 File (Maritime)

Available with ArcGIS Maritime license.

Summary

Validates an ENC, IENC, or bIENC file and generates an .S58 file and a shapefile as a result.

Note:

This tool supports S-58 Edition 7.0.0 at ArcGIS Pro 3.3.

Usage

• Multiple revision (ER) files, also known as updates, must be validated at the same time as the base file. Individual ER files cannot be validated at a later time.

• A new edition (EN) base file can be validated.

• A catalog file (.031) can be validated. When a catalog file is chosen for validation, only the S-58 checks pertaining to the Exchange Set value or data structure will be run.

• By default, the tool will output a shapefile and an .s58 file in XML format that contain S-58 errors discovered during the validation process. If you do not need the shapefile, you can exclude it.

• An ignore list text file can be used to disable specific S-58 checks.

• A sample ignore list text file is available at <install location>\Resources\Maritime\S-58IgnoreList.txt.

  Note:

  Remove the number sign (#) from the beginning of the line for each check you want to ignore.

Parameters

Dialog

Label	Explanation	Data Type
Input S-57 File	The base cell file (*.000).	File
Output Directory	The location where the validated S-57 log will be created.	Folder
Update Cells (Optional)	The update cell files (*.001 - *.999).	File
Regional Rules (Optional)	Specifies the region that will be used to set the Recommended Inland ENC Validation Checks for that region. For IENC and bIENC cells, some validation rules don't apply in certain regions, or they check for different objects and attribution. Brazil—Brazilian validation rules will be applied. Europe—European validation rules will be applied. Russian Federation—Russian Federation validation rules will be applied. United States—United States validation rules will be applied.	String
Ignore List (Optional)	A text file containing a list of checks to ignore in the output log file.	File
Exclude Shapefile (Optional)	Specifies whether a shapefile will be generated. Checked—A shapefile will not be generated. Only the .s58 file will be created. Unchecked—A shapefile will be generated, along with the .s58 file. This is the default.	Boolean

Derived Output

Label	Explanation	Data Type
Output S-58 Log File	The .S58 file in XML format that contains the errors and warnings from the validation.	File

Python

arcpy.maritime.ValidateS57File(in_s57_file, out_directory, {in_update_cells}, {regional_rules}, {in_ignore_list}, {exclude_shapefile})

Name	Explanation	Data Type
in_s57_file	The base cell file (*.000).	File
out_directory	The location where the validated S-57 log will be created.	Folder
in_update_cells [in_update_cells,...] (Optional)	The update cell files (*.001 - *.999).	File
regional_rules (Optional)	Specifies the region that will be used to set the Recommended Inland ENC Validation Checks for that region. For IENC and bIENC cells, some validation rules don't apply in certain regions, or they check for different objects and attribution. BR—Brazilian validation rules will be applied. EU—European validation rules will be applied. RU—Russian Federation validation rules will be applied. US—United States validation rules will be applied.	String
in_ignore_list (Optional)	A text file containing a list of checks to ignore in the output log file.	File
exclude_shapefile (Optional)	Specifies whether a shapefile will be generated. EXCLUDE_SHAPEFILE—A shapefile will not be generated. Only the .s58 file will be created. DO_NOT_EXCLUDE_SHAPEFILE—A shapefile will be generated, along with the .s58 file. This is the default.	Boolean

Derived Output

Name	Explanation	Data Type
out_log_file	The .S58 file in XML format that contains the errors and warnings from the validation.	File

Code sample

ValidateS57File example (Python window)

The following Python window script demonstrates how to use the ValidateS57File function.

# Import arcpy module
import arcpy
    
# Tool variables
base_cell = r"C:\ValidateS57file\US3CA52M.000"
output_path = r"C:\ValidateS57file"
update_cells = [r"C:\ValidateS57file\US3CA52M.001", r"C:\ValidateS57file\US3CA52M.002"]
regional_rule = "" 
ignore_list = r"C:\Program Files\ArcGIS\Pro\Resources\Maritime\S-58IgnoreList.txt"
shapefile = "EXCLUDE_SHAPEFILE" 

# Run the tool
arcpy.maritime.ValidateS57File(base_cell, output_path, update_cells, regional_rule, ignore_list, shapefile)

Environments

Current Workspace

Licensing information

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