Description
The CreateSoundingsFromCoverage process creates sounding features for a subset of the nodes in a coverage.
Inputs
A raster surface or point cloud in a supported format.
Outputs
Sounding features in HOB format.
Command Line Syntax
carisbatch --run CreateSoundingsFromCoverage --minimum-distance <value> --input-band <value> --feature-catalogue <value> [options] <input> <output>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--input-band | i | A string specifying the name of the input band. The input band can be any elevation band. | FALSE | This must be specified explicitly. |
--minimum-distance | d | The minimum distance between sounding features in the output, in areas of the input with values in the specified band. <Radius> - A number and unit specifying the minimum distance between sounding features. <MinValue> - A number and unit specifying the minimum value of the input band to apply this distance. <MaxValue> - A number and unit specifying the maximum value of the input band to apply this distance. At least one radius must be specified. If CARIS:NONE is used as the <MinValue>, the minimum value of the data is used. Similarly, if CARIS:NONE is used as the <MaxValue>, the maximum value of the data is used. All values representing elevations are entered using the convention that up is positive. The unit must be specified, unless the input band is a unitless band. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | TRUE | |
--scale | s | A number specifying the scaling to apply to the radius (1:scale). The default scale value is 1, such that the radius represents the minimum distance between features on the ground; the radius would then be a value like 5m. A scale of 1000 would mean that the radius represents the minimum distance between features on a map at 1:1000 scale; the radius would then be a value like 10mm. | FALSE | |
--selection-bias | B | A string specifying how to select which node values are chosen for the sounding features. • MIN: Use the minimum node value. • MAX: Use the maximum node value. All values representing elevations are considered using the convention that up is positive. | FALSE | This must be specified explicity. |
--apply-designated | a | If set, designated soundings from the source of the input are applied to the output. | FALSE | |
--feature-catalogue | F | A string specifying the name of the catalogue that defines the SOUNDG feature and attributes in the output dataset. One of { list dynamically populated from the catalogue control file }. The catalogue must be in the catalogue control file specified in Tools > Options > Files and Folders > Files > Catalogue Control, for example S-57 ENC 3.1. The default location of the CatalogueControl.xml file is C:\Program Files\CARIS\<application>\<version>\system\. | FALSE | This must be specified explicitly. |
--mapping-file | M | The path to a file containing rules used to map band values to sounding feature attributes. A mapping file, with BSST extension, can be created in the application by running the Sounding Selection command. | FALSE | |
Example
To use this command refer to the following example.
Example | ||
Objective | Create a subset of soundings on a feature layer using data from an existing coverage. | |
Description | Command Line Syntax | |
The Depth band of the input coverage contains the source elevation values. | --input-band Depth | |
A radius of 10mm at map scale is to be used to avoid overlapping soundings in the output. | --minimum-distance 10mm CARIS:NONE CARIS:NONE | |
The selection radius is using a map scale of 1:1000. | --scale 1000 | |
The minimum depth values are to be used in areas of conflict. | --selection-bias MIN | |
Designated soundings should be maintained in the output. | --apply-designated | |
The output layer is using the S-57 ENC 3.1 catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The source point cloud, Cloud1.csar, is located at D:\BatchSample. | D:\BatchSample\Cloud1.csar | |
The soundings will be stored in SoundingSelection.hob and will be saved to the same location as the input source file. | D:\BatchSample\SoundingSelection.hob | |
Command Line | carisbatch --run CreateSoundingsFromCoverage --minimum-distance 10mm | |
Outcome | New sounding features are created using the elevation values of the source data and saved to a HOB file in the specified location. | |
Extra Notes | N/A | |