--minimum-area

The values used to calculate the minimum area of a closed line.

<Coefficient 1> - A number and unit. This must be a positive area.

<Coefficient 2> - A scale factor applied to depth values. Use CARIS:NONE or 0 to use a fixed radius. Coefficient 2 * depth is interpreted as an area with the same unit as Coefficient 1.

<Coefficient 3> - A scale factor applied to the square of depth values. Use CARIS:NONE or 0 to use a fixed or linear radius. Coefficient 2 * depth * depth is interpreted as an area with the same unit as Coefficient 1.

<Depth unit> - Depth values are converted to this unit for this calculation. Defaults to m, i.e. metres.

The following types of minimum areas can be used:

• Fixed area =<Coefficient 1>

• Area changing linearly with depth = <Coefficient 1> + <Coefficient 2> * depth

• Area changing quadratically with depth = <Coefficient 1> + <Coefficient 2> * depth + <Coefficient 3> * depth^2

Supported area units: ac, cm2, fm2, ft2, ha, km2, m2, mi2, mm2, nm2, usac, usfm2, usft2, usmi2, usyd2, yd2.

Supported depth units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

--scale

s

A number specifying the scaling to apply to Minimum Area coefficients (1:scale).

The default scale value is 1, such that the Minimum Area value represents the area on the ground; Coefficient 1 would then be a value like 5m2.

A scale of 1000 would mean that the Minimum Area value represents the area on a map at 1:1000 scale; Coefficient 1 would then be a value like 10mm2.

FALSE

--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".

The default value is Bathy DataBASE.

FALSE

--elevation-lookup

A string specifying the path to a file with mappings between feature attributes and Z values.

This value supersedes the Tools > Options setting for Selection Classification Lookup.

FALSE

Objective

You wan to remove deep isolations that are smaller than 20m2.

Description

Command Line Syntax

The contour features are found in the Contours.hob file in the D:\SampleData\Features directory.

D:\SampleData\Features\Contours.hob

Isolations smaller than 20m2 will be removed with no scaling factors applied. Depth values are in metres.

--minimum-area 20m2 CARIS:NONE CARIS:NONE m

Command Line

carisbatch --run RemoveDeepIsolations --minimum-area 20m2 CARIS:NONE CARIS:NONE m D:\SampleData\Features\Contours.hob

Outcome

All deep isolations in the contour file smaller than 20m2 have been removed.