Description
The EraseFeatures process removes portions of input features that are inside the boundaries of a specified eraser. An eraser is defined by one or more polygons. This process performs the opposite task of the ClipFeatures process. See Clip Features for more information.
Inputs
Features in a supported format. HOB, H2O and 000 (S-57 or S-101 specification) are supported.
Outputs
Features in HOB or H2O format.
Command Line Syntax
carisbatch --run EraseFeatures --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 name and path of the HOB or H2O file containing the polygons to use for erasing. Currently the eraser may be represented by one or more area features in a specified HOB or H2O 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. |
--deleted-features-filter-file | d | The path for an output FILTER file to contain the FOIDs of features that are completely erased. The FOIDs of partially erased features are not included. A FILTER file may be used as input to the FilterFeatures process. The filter file (*.filter) is created by CARIS software in CQL (common query language) format. | FALSE | |
--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. Edges marked as closing are masked and not symbolized when the area boundary is being drawn. | FALSE | |
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to remove unnecessary data from a feature dataset. | |
Description | Command Line Syntax | |
The output layer is using the S-57 ENC 3.1 catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The file containing the eraser polygons is named Eraser.hob and can be found in the BatchSample folder on the D: drive. | --eraser D:\BatchSample\Eraser.hob | |
Closing edges are to be flagged. | --mark-closing-edges | |
The input file is named InputFeatures.hob and is in the BatchSample folder on the D: drive. | D:\BatchSample\InputFeatures.hob | |
The output file will be named ErasedFeatures.hob and will be created in the source directory. | D:\BatchSample\ErasedFeatures.hob | |
Command Line | carisbatch --run EraseFeatures --feature-catalogue "S-57 ENC 3.1" --eraser D:\BatchSample\Eraser.hob --mark-closing-edges D:\BatchSample\InputFeatures.hob D:\BatchSample\ErasedFeatures.hob | |
Outcome | A new HOB file is created in the specified location containing the data from the source file, less the data in the areas indicated by the eraser file. | |
Extra Notes | ||