Process Designer : CARIS Batch Utility : Compose Processes : Assign Feature Scamin Values
 

Assign Feature Scamin Values

The AssignFeatureScaminValues process calculates minimum display scale attribute values for S-57 or S-101 non-sounding features using specified parameters.

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 for using scale minimum values is to reduce the amount of clutter displayed to the ECDIS user.

This process uses a mapping rule file to calculate scale minimum values as described in Assign Scale Minimum Values.

Inputs

Features in a supported format. HOB, H2O and 000 (S-57 or S-101 specification) formats are supported.

Outputs

Features in HOB or H2O format with assigned scale minimum values.

Command Line Syntax

carisbatch --run AssignFeatureScaminValues --mapping-rule-file <value> [options] <input> <output>

Options

The following table describes the parameters available for this process.

Long

Short

Description

Can Repeat

Notes

--feature-catalogue

-F

A string specifying the name of the catalogue that defines the features and attributes in a vector dataset. One of { list dynamically populated from the catalogue control file }.

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

FALSE

This must be explicitly specified.

--map-scale

-M

A number specifying the scale of the input map (1:scale).

This parameter is required when the input does not have a scale. S-57 format has a scale. Other formats do not have a scale. This parameter is ignored when the input is in S-57 format.

FALSE

--mapping-rule-file

-m

The path to the mapping rule file for the calculation of scale minimum values.

See Assign Scale Minimum Values for details on assigning scale minimum values.

FALSE

This must be explicitly specified.

Example

To use this command refer to the following example.

Example

Objective

Assign scale minimum values to features in a HOB file.

Description

Command Line Syntax

The S-57 ENC 3.1 feature catalogue will be used.

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

The mapping rule file is called and is located in the D:\RuleFiles directory.

--mapping-rule-file D:\RulesFiles\assignIHOscamin.xml

The input files is called Features.hob and is located in the D:\Inputs directory.

D:\Inputs\Features.hob

The resulting features will be saved as ScaminFeatures.hob in the D:\Outputs directory.

D:\Outputs\ScaminFeatures.hob

Command Line

carisbatch --run AssignFeatureScaminValues --feature-catalogue "S-57 ENC 3.1" --mapping-rule-file D:\RulesFiles\assignIHOscamin.xml D:\Inputs\Features.hob D:\outputs\ScaminFeatures.hob

Result

Scale minimum values are assigned to the features in ScaminFeatures.hob according to the assignIHOscamin.xml file.