Description
The ClipFeatures process removes the portions of the input features that are outside the boundaries of a specified clipper. A clipper is defined by one or more polygons. This process is similar to the EraseFeatures process, except that it removes features outside the polygon boundaries and EraseFeatures removes features within the boundaries. See Erase 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 ClipFeatures --feature-catalogue <value> --clipper <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. |
--clipper | C | The path to the file containing the polygons to use for clipping. The clipper may be represented by one or more area features in a specified HOB or 000 (S-57 specification) file. | 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 | |
--feature-catalogue S-57 ENC 3.1 | ||
--clipper D:\BatchSample\Clipper.hob | ||
Command Line | carisbatch --run ClipFeatures --feature-catalogue S-57 ENC 3.1 --clipper D:\BatchSample\Clipper.hob | |
Outcome | ||
Extra Notes | ||