Description
The AssignSoundingSCAMINValues process calculates minimum display scale (SCAMIN) values for S‑57 sounding features using specified parameters.
Inputs
Features in a supported format. HOB, 000 (S‑57 specification) are supported.
Outputs
Features in HOB format with assigned SCAMIN values.
Command Line Syntax
carisbatch --run AssignSoundingSCAMINValues --feature-catalogue <value> --scaling-parameters-file <value> [options] <input> <output>
User Interface Command
Assign Scale Minimum Values
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
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 names of the available catalogues can be accessed through 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 | This must be explicitly specified. |
--map-scale | M | A number specifying the scale of the input map (1:scale). This is only needed for HOB format. This parameter is required when the input is in HOB format since HOB files do not have a scale. This parameter is ignored when the input is in S‑57 format since S‑57 format has a scale. | FALSE | |
--scaling-parameters-file | P | The path to the file specifying parameters for the calculation of SCAMIN values. Parameters are: • minimum depth, maximum depth and radius values for sounding suppression • scale factors for calculation of SCAMIN values • optional compilation scale multiplier for calculation of SCAMIN values For details, see the Compose support files section in the Compose module documentation or the sample files (sdgparm.txt and sdgparm_S-65.txt) included with the Compose module. | FALSE | This must be explicitly specified. |
Example 1
To use this command refer to the following examples.
Example | ||
|---|---|---|
Objective | You want to apply SCAMIN values to soundings in a HOB file. | |
Description | Command Line Syntax | |
The input has features and attributes defined in the S-57 ENC 3.1 feature catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The map scale of the input file is 1:10000 | --map-scale 10000 | |
The scaling parameters file is named sdgparm.txt. | --scaling-parameters-file sdgparm.txt | |
The input HOB file is named | D:\BatchSample\gb4x0000_in.hob | |
The input HOB file is named | D:\BatchSample\gb4x0000_out.hob | |
Command Line | carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-57 ENC 3.1" --map-scale 10000 --scaling-parameters-file sdgparm.txt D:\BatchSample\gb4x0000_in.hob D:\BatchSample\gb4x0000_out.hob | |
Outcome | SCAMIN values are added to soundings in the input HOB file and saved as a new HOB file. | |
Extra Notes | N/A | |
Example 2
Example | ||
|---|---|---|
Objective | You want to apply SCAMIN values to soundings in a .000 file. | |
Description | Command Line Syntax | |
The input has features and attributes defined in the S-57 ENC 3.1 feature catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The scaling parameters file is named | --scaling-parameters-file sdgparm_S‑65.txt | |
The input .000 file is named | D:\BatchSample\gb4x0000.000 | |
The input HOB file is named | D:\BatchSample\gb4x0000.hob | |
Command Line | carisbatch --run AssignSoundingScaminValues --feature-catalogue "S-57 ENC 3.1" --scaling-parameters-file sdgparm_S-65.txt D:\BatchSample\gb4x0000.000 D:\BatchSample\gb4x0000.hob | |
Outcome | SCAMIN values are added to soundings in the input .000 file and saved as a new HOB file. | |
Extra Notes | N/A | |