CARIS HIPS and SIPS Help : CARIS Batch Utility : BASE Editor Processes : Create Depth Areas
 

Create Depth Areas

Description

The CreateDepthAreas process creates attributed area objects from existing lines, with the option of also using a reference coverage.

Input

Vector line features in a supported format. Only line features with elevation attribution are considered.

Output

Vector features in a supported format.

Syntax

carisbatch --run CreateDepthAreas --area-features <value> [options] <input> <output>

User Interface Command

Depth Areas from Contours

Options

The following table describes the parameters available for this process.

Long

Short

Description

Can Repeat

Notes

--area-features

The area features that define the boundaries of the contoured data.

Only area features are considered.

FALSE

This must be specified explicitly

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

--depth-areas

Information about how to create the new features.

• <Feature> - A string specifying the type of feature to be created. The default value is DEPARE

• <MinimumAttribute> - A string with the name of the attribute to be assigned the minimum value of the depth area. This must be a numeric attribute or a string attribute. The default value is DRVAL1

• <MaximumAttribute> - A string with the name of the attribute to be assigned the maximum value of the depth area. This must be a numeric attribute or a string attribute. The default value is DRVAL2

FALSE

--resolve-isolations

Information about how to use the reference to determine attribution for isolations.

• <Reference> - A string specifying the URI to a coverage to be used to resolve isolations. This must be specified.

• <InputBand> - A string specifying the name of the input band. This must be specified.

• <DepthMinimumBound> - A number and unit used as the minimum bound for depth areas that would otherwise have no minimum bound due to insufficient information about smaller values. This is optional. Use CARIS:NONE in a command line to not apply a minimum depth.

• <DepthMaximumBound> - A number and unit used as the maximum bound for depth areas that would otherwise have no maximum bound due to insufficient information about larger values. This is optional. Use CARIS:NONE in a command line to not apply a maximum depth.

• <UseTruePositions> - If set to true, true positions in a reference raster surface are used to assign locations to depth values. Otherwise, cell-centred locations are used. The default is false.

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

Examples

Below is an example of the process.

Example

Objective

You want to create depth areas for a set of existing contour features.

Description

Command Line Syntax

The contour features to define the depth areas are in the Contours.hob file in the D:\SampleData\Features directory.

--area-features D:\SampleData\Features\Contours.hob

The following settings will be used when assigning attribution to isolations:

• The Raster.csar coverage will be used as a reference for depth values. This file is located in the D:\SampleData\Coverages directory.

• Depth values will be taken from the Depth band in the reference coverage.

• Depth range values will be assigned between 0m and 100m.

• True positions from the raster surface will be used.

--resolve-isolations D:\SampleData\Coverages\Raster.csar Depth 0m 100m TRUE

The input features is the Contours.hob file in the D:\SampleData\Features directory.

D:\SampleData\Features\Contours.hob

The new depth area features will be saved to the DepthAreas.hob in the input directory.

D:\SampleData\Features\DepthAreas.hob

Command Line

carisbatch --run CreateDepthAreas --area-features D:\SampleData\Features\Contours.hob --resolve-isolations D:\SampleData\Coverages\Raster.csar Depth 0m 100m TRUE D:\SampleData\Features\Contours.hob D:\SampleData\Features\DepthAreas.hob

Result

Depth area features are created with proper attribution and saved to the new output file.