The AssignSoundingScaminValues process calculates the minimum display scale (scale minimum) attribute values for S-57 or S-101 soundings based on 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 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 on each iteration, a scale minimum value is calculated based on a corresponding scale factor and other information as described in the parameter file.
Two sample parameter files, sdgparm.txt and sdgparm_IHO.txt, are included with HPD. For more information on option files, see the HPD® User Guide.
When HPD products are updated, soundings that are assigned scale minimum values keep their existing certification status.
Input
Features in a supported format. HOB, H2O, 000 (S-57 or S-101 specification) and HPD URIs are supported.
Output
Features including soundings with assigned scale minimum values in a HOB or H2O file with assigned scale minimum value. 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 AssignSoundingScaminValues --feature-catalogue <value> --scaling-parameters-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 | Value for the input map 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 has a scale, the option will be ignored. | FALSE | Required when the input does not have a scale. |
--scaling-parameters-file | -P | Path to the file specifying the parameters for the calculation of scale minimum values. Parameters are: • Minimum depth, maximum depth and radius values for sounding suppression • Scale factors for calculation of scale minimum values • Optional compilation scale multiplier for calculation of scale minimum values. For details, see the Command Reference for Assign Scale Minimum Values or the sample sdgparm.txt and sdgparm_IHO.txt files included with the S-57 Composer module. | FALSE | Required |
Examples
S-57 | ||
Objective | Assign scale minimum values to soundings in | |
Description | Command Line Syntax | |
Feature catalogue for output file. |
| |
Soundings option file. |
| |
Path and name of input file. |
| |
Path and name of output file. |
| |
Command Line |
| |
Outcome | Scale minimum values are assigned to | |
S-101 | ||
Objective | Assign scale minimum values to soundings in | |
Description | Command Line Syntax | |
Feature catalogue for output file. |
| |
Soundings option file. |
| |
Scale of input map. |
| |
Path and name of input file. |
| |
Path and name of output file. |
| |
Command Line |
| |
Outcome | Scale minimum values are assigned to | |
HPD URI | ||
Objective | Assign scale minimum values to soundings in the HPD product | |
Description | Command Line Syntax | |
Scale of input map. |
| |
Soundings option file. |
| |
HPD Product URI. |
| |
Command Line |
| |
Outcome | Scale minimum values are updated in the HPD product | |
S-101 | ||
Objective | Assign scale minimum values to soundings in | |
Description | Command Line Syntax | |
Feature catalogue for output file. |
| |
Scale of input map. |
| |
Ignore scale of meta features. |
| |
Soundings option file. |
| |
Path and name of input file. |
| |
Path and name of output file. |
| |
Command Line |
| |
Outcome | Scale minimum values are assigned to | |