CARIS Batch Utility : Feature Editing Processes : Erase Features
 

Erase Features

Description

The EraseFeatures process removes the portions of the input features that are inside the boundaries of a specified eraser. An eraser is defined by one or more polygons. This process is similar to the ClipFeatures process, except that it removes features within the polygon boundaries and ClipFeatures removes features outside the boundaries. See Clip Features for more information.

Inputs

Features in a supported format. HOB and 000 (S-57 specification) are supported.

Outputs

Features in HOB format.

Command Line Syntax

carisbatch --run EraseFeatures --feature-catalogue <value> --eraser <value> [options] <input> <output>

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

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

FALSE

This must be specified for HOB input.

--eraser

e

The path to the file containing the polygons to use for erasing.

The eraser may be represented by one or more area features in a specified HOB or 000 (S-57 specification) file.

Polygons may include interior boundaries. If this is the case, the parts of features inside the exterior boundaries will be removed, but the parts of features inside interior boundaries will be left unchanged.

If an empty file is specified, no erasing will be performed and the output will contain all features in the input.

Lines and points in the given file will be ignored.

FALSE

This must be specified explicitly.

--mark-closing-edges

c

If set, marks closing edges, as required by S-57, to indicate that area features have been truncated by the data limit.

Edges are added to areas that are trimmed by the process to create closed areas. Flagging an added edge as closing indicates that the edge represents a dataset limit, such as an S-57 cell border. If the removal of the data is part of a multi-stage replacement operation, the closing flag should not be set as these edges will not be closing edges after the new data is added.

FALSE

Example

To use this command refer to the following example.

Example

Objective

Description

Command Line Syntax

Command Line

Outcome

Extra Notes