CARIS HPD : CARIS® Batch : S-57 Composer Processes : Modify S-57 Header
 

Modify S-57 Header

The ModifyS57Header process changes header information in an S-57 file.

Input

Name and path of the file containing original header.

Output

Name and path of the file with the modified header. Note this can also be the input file.

Command Line Syntax

carisbatch --run ModifyS57Header [options] <input> <output>

Options

Long

Short

Description

Can Repeat

Notes

--dataset-name

-n

New name for the S-57 file.

FALSE

Optional

--edition-number

-e

Edition number for the S-57 file. The edition number must be a value between 1 and 999.

FALSE

Optional

--update-number

-u

Update number for the S-57 file. The update number must be between 0 and 999.

FALSE

Optional

--intended-usage

-i

The number of the Intended usage for the S-57 file.

FALSE

Optional

--issue-date

-d

Issue date for the S-57 file YYYYMMDD format.

FALSE

Optional

--iho-agency-code

-a

The producing agency for the S-57 file. This should match one of the agency codes in the file specified by the --iho-agency-code-file option.

FALSE

Required

--iho-agency-code-file

-A

The path and file name of the IHO agency code file.

The agency code file may be used to get a list of agency codes or to validate the agency code given by the --iho-agency-code option.

FALSE

Required

--product-specification

-p

Product specification for the S-57 file. This must be an integer value.

FALSE

Optional

--dspm-comment

-m

Dataset parameter (DSPM) comment for the S-57 file.

FALSE

Optional

--dsid-comment

-c

Dataset identification (DSID) comment for the S-57 file.

FALSE

Optional

--compilation-scale

-s

Compilation scale for the S-57 file. This must be an integer.

FALSE

Optional

Example

Example

Objective

A new S-57 file with modified header information (output.000) is created from an existing file (input.000).

Description

Command Line Syntax

Name for output.000 is New Dataset Name

--dataset-name “New Dataset Name”

The edition number is 22

--edition-number 22

The update number is 0

--update-number 0

The number of the usage is 9

--intended-usage 9

The issue date for output.000 is Jan 31, 2015

--issue-date 20150131

The numeric code for the producing agency is 50.

--producing-agency 50

The product specification number is 99.

--product-specification 99

The Data Set Identification (DSID) comment is set to New DSID Comment

--dsid-comment “New DSID Comment”

The Data Set Option (DSPM) comment is set to New DSPM Comment.

--dspm-comment “New DSPM Comment”

The compilation scale is set to 75000

--compilation-scale 75000

The input file is named input.000 and is stored in the ModifyS57Header_test folder

C:\Temp\ModifyS57Header_Test\input.000

The output file (output.000) is created and stored in the ModifyS57Header_test folder

C:\Temp\ModifyS57Header_Test\output.000

Command Line

carisbatch -r ModifyS57Header --dataset-name “New Dataset Name” --edition-number 22 --update-number 0 --intended-usage 9

--issue-date 20150131 --producing-agency 50 --product-specification 99 --dsid-comment “New DSID Comment” --compilation-scale 75000 --dspm-comment “New DSPM Comment” C:\Temp\ModifyS57Header_Test\input.000 C:\Temp\ModifyS57Header_Test\output.000