CARIS Process Designer : CARIS Batch : S-57 Composer Processes : Assign Sounding Scamin Values
 

Assign Sounding Scamin Values

The AssignSoundingScaminValues process calculates the minimum display scale values for S-57 or S-101 soundings based on specified options.

The scale minimum is represented by SCAMIN attributes in S-57 data sets and by scaleMinimum attributes in S-101 data sets.

The scale minimum value of a feature determines the display scale below which the feature is no longer visible on an Electronic Chart Display and Information System (ECDIS). The purpose of scale minimum values is to reduce the amount of clutter displayed to the ECDIS user.

This process uses minimum depth, maximum depth and radius values from an option file to iteratively suppress soundings. For each group of soundings that are not suppressed, a scale minimum value is calculated based on a corresponding scale factor and other information in the file.

Two option files, sdgparm.txt and sdgparm_S-65.txt, are included with HPD. For more information on option files, see the HPD User Guide.

Input

HOB file, H2O file, S-57 file, S-101 file

Output

HOB or H2O file with assigned scale minimum value

Syntax

carisbatch --run AssignSoundingScaminValues --feature-catalogue <value> --scaling-options-file <value> [options] <input> <output>

Options

Long

Short

Description

Can Repeat

Notes

--feature-catalogue

-F

Catalogue that defines features and attributes in an output HOB file. Catalogue information is read from the Catalogue Control File.

See Catalogues for a list of available catalogues.

The catalogue will be ignored if the output is not a HOB file.

FALSE

Required

--map-scale

-M

Value for input map scale. This option is required for all file formats except S-57 files.

FALSE

Required

--scaling-parameters-file

-P

File containing parameters used for the calculation of scale minimum values.

See the Support Files guide for details.

FALSE

Required

Example

S-57

Objective

Assign scale minimum values to soundings in OUTx0000.hob. Soundings are read from INx000.000.hob. The S-57 ENC 3.1 feature catalogue is applied to OUTx0000.hob. The soundings option file is sdgparm.txt and map scale for INx000.000.hob is 1:10000

Description

Command Line Syntax

Feature catalogue for output file.

--feature-catalogue "S-57 ENC 3.1"

Sounding option file

--scaling-parameters-file sdgparm_S-65.txt

Path and name of input file.

D:\input\INx0000.000

Path and name of output file.

D:\output\OUTx0000.hob

Command Line

carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-57 ENC 3.1" --scaling-parameters-file sdgparm_S-65.txt D:\inputs\INx0000.000 D:\outputs\OUTx0000.hob

Result

Scale minimum values are assigned to OUTx0000.hob according to the sdgparm.txt file

Example

S-101

Objective

Assign scale minimum values to soundings in S100_input.000. Soundings are read from S100_input.000. The S-101 feature catalogue is applied to s100_output.h2o. The soundings option file is ssdgparm_IHO.txt and map scale for S100_input.000 is 1:20000

Description

Command Line Syntax

Feature catalogue for output file.

--feature-catalogue "S-101 1.0"

Sounding option file

--scaling-parameters-file sdgparm_IHO.txt

Scale of input map

--map-scale 20000

Path and name of input file.

D:\input\S100_input.000

Path and name of output file.

D:\output\s100_output.h2o

Command Line

carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-101 1.0"  --map-scale 20000 --scaling-parameters-file sdgparm_IHO.txt D:\input\S100_input.000 D:\output\s100_output.h2o

Result

Scale minimum values are assigned to s100_output.h2o according to the sdgparm_IHO.txt