--maximum-length

A number and unit specifying a maximum bridge edge length.

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

This must be a positive number.

FALSE

--distance-coefficients

The depth-dependent values added to the maximum bridge length values.

<LinearFactor> - A scale factor applied to depth values. Use 0 to use a fixed distance. LinearFactor * depth is interpreted as a distance with the same unit as MaximumLength.

<QuadraticFactor> - A scale factor applied to the square of depth values. Use 0 to use a fixed or linear distance. QuadraticFactor * depth * depth is interpreted as a distance with the same unit as MaximumLength.

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

The following types of distances can be used:

• Fixed distance = <MaximumLength>

• Linear distance = <MaximumLength> + <LinearFactor> * depth

• Quadratic distance = <MaximumLength> + <LinearFactor> * depth + <QuadraticFactor> * depth^2

If a depth value is negative, only <MaximumLength> is used.

Supported 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 applied to distance values (1:scale).

This is applied to "Maximum Length" and "Distance Coefficients" values. The default scale of 1 requires those values to be entered as distances on the ground. A scale of 1000 means these values are distances on a 1:1000 scale map.

FALSE

--working-crs

A string specifying the key to a horizontal coordinate reference system in which geometric calculations are done.

For time-dependent coordinate reference systems, the epoch can be specified, typically using the year as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used.

The working CRS must be a projected CRS. The default is to use the CRS of the input features if they have a projected CRS. Otherwise, a default best fit projected CRS is calculated for the input data. A UTM zone is used if possible, and if not, a Lambert Conformal Equal Area projection, and if not, a polar stereographic, and if not, World Mercator.

FALSE

--limiting-features

A path to a set of features that limit how bridge edges are added.

If a bridge edge would be created to touch or intersect any of the limiting features, the bridge edge is not created and the features are reported for manual inspection.

FALSE

--direction-bias

The rules applied when determining whether bridge edges are added.

<SlopeDirection> A string describing the rule to use for lines with contour slope attribution.

• DOWN: Bridge edges are added if the area in between has lower elevation.

• UP: Bridge edges are added if the area in between has higher elevation.

<Unknown> A string describing the rule to use for lines without contour slope attribution.

• LEFT: Bridge edges are added if the matching features are on their respective left sides.

• RIGHT: Bridge edges are added if the matching features are on their respective right sides.

• IGNORE: Unattributed lines are ignored.

The default values are DOWN and RIGHT.

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 Elevation Lookup.

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

A catalogue is only used when the input is a HOB file. The default value is Bathy DataBASE.

FALSE

Objective

You want to add lines to connect contour features that are closer than 20 metres and have the same depth value.

Description

Command Line Syntax

Bridge edges are to be no longer than 20 metres.

--maximum-length 20m

The creation of the bridge features will be limited by the features in the LimitingFeatures.hob file found in the input directory.

D:\SampleData\LimitingFeatures.hob

The input contours are in the Contours.hob file in the D:\SampleData directory.

D:\SampleData\Contours.hob

The resulting features will be added to the original input file.

D:\SampleData\Contours.hob

Command Line

carisbatch --run AddBridgesBetweenMatchingLines --maxmimum-length 20m D:\SampleData\LimitingFeatures.hob D:\SampleData\Contours.hob D:\SampleData\Contours.hob