Parameter

Long

Short

Description

Can Repeat

Notes

Common Options

--output-format

O

A string specifying the format in which the output is generated. One of:

• HOB: The CARIS HOB format.

• DXF: The AutoCAD DXF format.

Options specific to each format are specified below.

FALSE

This must be specified explicitly.

--input-band

i

A string specifying the name of the input band.

The input band can be any numeric band.

String table bands like Contributor and Source_Name are supported, but should only be used with integer intervals.

FALSE

This must be specified explicitly.

--range

g

The interval and minimum and maximum range of values to be considered.

<MinValue> - A number specifying the lower bound of the range.

<MaxValue> - A number specifying the upper bound of the range.

<Interval> - The spacing between contour values.

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 like Density. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

TRUE

--level

L

A number specifying a contour level.

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 like Density.

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

TRUE

--remove-collinear-points

R

If set, exactly collinear points are removed from all created features.

In a future version, collinear points will never be created in these features.

FALSE

--generation-method

G

The generation method, controlling the location of nodes and the extents of the boundary.

• GRID: Generate contours based on nodes in the centre of each cell, with the contour boundary around all populated cells.

• TRUE_POSITION: Generate contours based on nodes in the true positions, with the contour boundary connecting the true position locations.

The default is TRUE_POSITION. However, setting the TRUE_POSITION generation method on a raster with no true position locations will result in GRID-based contours.

FALSE

--template

T

The URI for a reference model template containing horizontal reference model surfaces to be considered for contour levels.

The format of the URI is
file:///path_to_file?template=template_name, for example, you would enter the following for Template 0001 in D:\RefModel.xml:
"file:///D:\RefModel.xml?template=Template%200001"

More than one template can be specified as a source for contour levels.

TRUE

--add-model-elevations

V

If set, contours are created at the elevation of each horizontal reference model surface in each specified template.

FALSE

--add-allowances-above

A

If set, contours are created at the allowance above the elevation of each horizontal reference model surface in each specified template.

FALSE

--add-allowances-below

W

If set, contours are created at the allowance below the elevation of each horizontal reference model surface in each specified template.

FALSE

OutputFormat = HOB

--feature-catalogue

F

A string specifying the name of the catalogue that defines the features and attributes in the input 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.

FALSE

This must be specified explicitly.

The default location of CatalogueControl.xml file is C:\Program Files\CARIS\BASE Editor\4.2\system\.

--contour-feature

C

A string specifying the feature acronym of the line object to be used for contour line features.

The specified acronym must be present in the specified catalogue.

FALSE

This must be specified explicitly.

--level-attribute

a

A string specifying the attribute acronym for the level of contour line features.

FALSE

This must be specified explicitly.

--boundary-feature

B

A string specifying the feature acronym of the area object to be used for the data boundary.

The specified acronym must be present in the specified catalogue.

FALSE

This is optional. If it is not specified, no boundary features will be created in the output HOB file.

--polygon-feature

P

The mapping for polygons created between successive contour line features.

<AreaObject> - A string specifying the feature acronym of the area object to be used for the polygons.

<MinAttribute> - A string specifying the attribute acronym for the minimum value of bounding contours.

<MaxAttribute> - A string specifying the attribute acronym for the maximum value of bounding contours.

CARIS:NONE can be used for the MinAttribute and/or MaxAttribute.

FALSE

OutputFormat = DXF

--boundary-name

B

A string specifying the name of the area object to be used for the data boundary.

FALSE

This is optional. If it is not specified, no boundary features will be created in the output DXF file.

--contour-name

C

A string specifying the name of the line object to be used for contour line features.

The default value is Contour.

FALSE

This is optional.

Example

Objective

You want to create contours for a raster surface at specific levels, and also for the areas of the raster surface that are crossed by the reference model surfaces in a template.

Description

Command Line Syntax

The data will be contoured between a lower boundary of -100 metres, an upper boundary of 0 metres, with a contour interval of 10 metres.

--range -100m 0m 10m

An extra contour level is needed at a depth of 5m.

--level -5m

The path for the template containing the reference model surfaces is "file:///D:\ReferenceModel.xml?template=Template0001"

--template file:///D:\ReferenceModel.xml?template=Template0001

Contours are to be created for the elevation value of each reference model surface.

--add-model-elevations

The output format is HOB.

--output-format HOB

The feature catalogue name is Bathy DataBASE

--feature-catalogue "Bathy DataBASE"

The contour feature is DEPCNT.

--contour-feature DEPCNT

The level attribute is VALDCO.

--level-attribute VALDCO

The polygon feature for the depth areas is DEPARE. The attributes for the minimum and maximum values of the polygons are DRVAL1 and DRVAL2, respectively.

--polygon-feature DEPARE DRVAL1 DRVAL2

A data boundary.is to be generated using the cvrage object acronym.

--boundary-feature cvrage

The input band is named Depth.

--input-band Depth

The input surface is named RasterSurface.csar and is in the BatchSample directory on the D: drive.

D:\BatchSample\RasterSurface.csar

The output file will be named RefModelContours.hob and will be saved in the source directory.

D:\BatchSample\RefModelContours.hob

Command Line

carisbatch --run ContourRasterByModel --range -100m 0m 10m --level -5m --template file:///D:\ReferenceModel.xml?template=Template0001 --add-model-elevations --output-format HOB --feature-catalogue "Bathy DataBASE" --contour-feature DEPCNT --level-attribute VALDCO --polygon-feature DEPARE DRVAL1 DRVAL2 --boundary-feature cvrage --input-band Depth D:\BatchSample\RasterSurface.csar D:\BatchSample\RefModelContours.hob

Outcome

Contours are generated at the specified levels throughout the input, and also for the areas of the raster surface that are crossed by the reference model surfaces in the specified template. The contours are saved to a HOB file in the specified location.

Extra Notes