CARIS HPD : CARISĀ® Batch : S-100 Processes : Export CARIS Symbols to S-100 SVG
 

Export CARIS Symbols to S-100 SVG

The ExportCARISSymbolsToS100SVG process converts CARIS symbols to the S-100 SVG format.

Each symbol in the master file is converted to a separate .SVG file.

If a symbol is a composite symbol, a separate .SVG file is generated for each sub-symbol using the following file name format:

mainSymbolName_S#_subSymbolName.svg

where # is the sub-index as used in the master file.

This process is available with the S-100 module in HPD Product Editor and S-57 Composer. It uses the HPD ProductBuilder license with CARIS Batch.

Input

Name of a paper type portrayal, such as INT1.

This input is the name for a presentation options entry in the portrayal control file that defines the master file, symbol file and colour file for a paper type presentation.

Portrayal names are listed in CARIS applications under Tools > Options > Display > Portrayal > General > Portrayal.

Output

Name of the folder where the converted symbols will be saved.

Command Line Syntax

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

Options

Long

Short

Description

Can Repeat

Notes

--symbol- name

-n

Name of a symbol to be converted.Symbol names are defined in the FCODE column in the master file.

Default is to convert all symbols.

TRUE

Optional

--symbol-size

-s

Height of symbols in the specified units, normally millimetres.

This option overrides the size obtained from the master file (e.g., /SIZ=2.09).

FALSE

Optional

--fill-colour

-f

S-52 colour token that defines the colour to use to fill symbols. S-52 colour tokens are used in SVG files.

Default is CHBLK.

FALSE

Optional

--outline-colour

-o

S-52 colour token that defines the colour to use for symbol outlines. S-52 colour tokens are used in SVG files.

In SVG files, an outline is a stroke.

Default is CHBLK.

FALSE

Optional

--publisher

-P

Publisher of the symbols for SVG metadata.

The value of this option will populate the SVG publisher metadata field as shown in this example: iho:publisher="IHB"

Default is "unknown".

FALSE

Optional

--source

-c

Source of the symbols for SVG metadata.

The value of this option will populate the SVG source metadata field, as shown in this example: iho:source="S52Preslib4.0"

Default is "unknown".

FALSE

Optional

Examples

Single Symbol with Options

Objective

Export a CARIS symbol as an SVG file with the specified attributes.

Description

Command Line Syntax

Export the ALPTLH symbol only.

--symbol-name ALPTLH

Height of the symbol will be 1.5 mm.

--symbol-size 1.5mm

Fill colour will be CHRED.

--fill-colour CHRED

Outline colour will be CHBRN.

--outline-colour CHBRN

Paper type portrayal will be INT1.

INT1

Path of the folder for the SVG file.

c:\svgsym

Command Line

carisbatch --run ExportCARISSymbolsToS100SVG --symbol-name ALPTLH --symbol-size 1.5mm --fill-colour CHRED --outline-colour CHBRN INT1 c:\svgsym

All Symbols with Metadata

Objective

Export all CARIS symbols as SVG files with the specified attributes.

Description

Command Line Syntax

Publisher shown in the SVG metadata will be the IHB.

--publisher IHB

Source of the symbols shown in the SVG metadata will be S52Preslib4.0.

--source S52Preslib4.0

Paper type portrayal will be INT1.

INT1

Path of the folder for SVG files.

c:\svgsym

Command Line

carisbatch --run ExportCARISSymbolsToS100SVG --publisher IHB --source S52Preslib4.0 INT1 c:\svgsym