CARIS HPD : CARIS® Batch : S-57 Composer Processes : Assign Feature Scamin Values
 

Assign Feature Scamin Values

The AssignFeatureScaminValues process calculates minimum display scale (scale minimum) 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 datasets and by scaleMinimum attributes in S-101 datasets.

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 the Command Reference for Assign Scale Minimum Values.

When HPD products are updated, features that are assigned scale minimum values keep their existing certification status.

Inputs

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

Outputs

Features with assigned scale minimum values in HOB or H2O format. An HPD URI may be specified along with an identical input HPD URI to update an HPD product.

Different URIs are not supported. An error will occur if HPD URIs are specified for input and output and the URIs do not match.

Command Line Syntax

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

Options

Long

Short

Description

Can Repeat

Notes

--feature-catalogue

-F

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

The names of the available catalogues can be accessed through the application via the Object Catalogue environment variable in Tools > Options. The available catalogues are controlled by the Catalogue Control file.An example of a catalogue name is "S-57 ENC 3.1".

FALSE

Required if the input is a HOB file.

--ignore-meta-feature-scale

If set, the scale of meta features is not used in the calculation of minimum display scale attribute values.

The following attributes are ignored when this option is set:

S-57 datasets: CSCALE attribute of M_CSCL features.

S-101 datasets: maximumDisplayScale attribute of DataCoverage features.

FALSE

Optional

--map-scale

-M

Number specifying the scale of the input map (1:scale).

This option is required for all file formats except those that have a scale, such as S-57 and later versions of HOB files that support text.

If the input is in S-57 format or the input has a scale, the option will be ignored.

FALSE

Required when the input does not have a scale.

--mapping-rule-file

-m

Path to the file specifying the mapping rule for the calculation of scale minimum values.

See the Command Reference for Assign Scale Minimum Values for details.

FALSE

Required.

Examples

S-57

Objective

Assign scale minimum values to features in D:\outputs\gb4x0000.hob. Features are read from D:\inputs\gb4x0000.000. The S-57 ENC 3.1 feature catalogue is applied to D:\outputs\gb4x0000.hob. The mapping rule file is assignIHOscamin.xml.

Description

Command Line Syntax

Feature catalogue for output file.

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

Mapping rule file.

--mapping-rule-file assignIHOscamin.xml

Path and name of input file.

D:\inputs\gb4x0000.000

Path and name of output file.

D:\outputs\gb4x0000.hob

Command Line

carisbatch --run AssignFeatureScaminValues --feature-catalogue "S-57 ENC 3.1" --mapping-rule-file assignIHOscamin.xml D:\inputs\gb4x0000.000 D:\outputs\gb4x0000.hob

Outcome

Scale minimum values are assigned to gb4x0000.hob according to the assignIHOscamin.xml file.

S-101

Objective

Assign scale minimum values to non-sounding features in s100_output.h2o. Features are read from S100_input.000. The S-101 feature catalogue is applied to s100_output.h2o. The mapping rule file is assignIHOS101scamin.xml and the map scale for S100_input.000 is 1:20000.

Description

Command Line Syntax

Feature catalogue for output file.

--feature-catalogue "S-101 1.1.0"

Scale of input map.

--map-scale 20000

Mapping rule file.

--mapping-rule-file assignIHOS101scamin.xml

Path and name of input file.

D:\inputs\S100_input.000

Path and name of output file.

D:\outputs\s100_output.h2o

Command Line

carisbatch --run AssignFeatureScaminValues --feature-catalogue "S-101 1.1.0" --map-scale 20000 --mapping-rule-file assignIHOS101scamin.xml D:\inputs\S100_input.000 D:\outputs\s100_output.h2o

Outcome

Scale minimum values are assigned to s100_output.h2o according to the assignIHOS101scamin.xml file.

HPD URI

Objective

Assign scale minimum values to features in the HPD product hpd://username:password@database?ProductVersionId=10003;ProjectId=12. The mapping rule file is assignIHOscamin.xml and the map scale is 1:10000.

Description

Command Line Syntax

Scale of input map.

--map-scale 10000

Mapping rule file.

--mapping-rule-file assignIHOscamin.xml

HPD Product URI.

hpd://username:password@database?ProductVersionId=10003;ProjectId=12

Command Line

carisbatch --run AssignFeatureScaminValues --map-scale 10000 --mapping-rule-file assignIHOscamin.xml hpd://username:password@database?ProductVersionId=10003;ProjectId=12 hpd://username:password@database?ProductVersionId=10003;ProjectId=12

Outcome

Scale minimum values are updated in the HPD product according to the assignIHOscamin.xml file.

S-101

Objective

Assign scale minimum values to features in input.h2o. Features are read from input.h2o. The S-101 feature catalogue is applied to output.h2o. The mapping rule file is assignIHOS101scamin.xml, and the mapping scale for input.h2o is 1:10000. The scale of meta features is ignored.

Description

Command Line Syntax

Feature catalogue for output file.

--feature-catalogue "S-101 1.0"

Scale of input map.

--map-scale 10000

Ignore scale of meta features.

-ignore-meta-feature-scale

Mapping rule file.

--mapping-rule-file assignIHOS101scamin.xml

Path and name of input file.

D:\input\input.h2o

Path and name of output file.

D:\outputs\output.h2o

Command Line

carisbatch --run AssignFeatureScaminValues --feature-catalogue "S-101 1.0" --map-scale 10000 --ignore-meta-feature-scale --mapping-rule-file assignIHOS101scamin.xml D:\input\input.h2o D:\outputs\output.h2o

Outcome

Scale minimum values are assigned to output.h2o according to the assignIHOS101scamin.xml file. The scale of meta features is ignored.