Description
The FilterFeatures process copies features that pass the criteria in a rule file from the input to the output.
Inputs
Features in a supported format. HPD Database URI, HOB, and 000 (S-57 specification) are supported.
Outputs
Features in HOB format.
If the output directory already contains a file with the specified file name, the existing file will be overwritten by the new output file. |
Command Line Syntax
carisbatch --run FilterFeatures --feature-catalogue <value> --rule-file <value> [options] <input> <output>
User Interface Command
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--extent | E | The extents that defines an edit boundary. This boundary is used to restrict the features to be filtered to a specified area. <LowerX> - A number specifying the lower left X origin in the coordinate reference system of the output. <LowerY> - A number specifying the lower left Y origin in the coordinate reference system of the output. <UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output. <UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output. The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for unprojected data, an angle type unit is required. The order for unprojected coordinates is longitude followed by latitude. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. When this option is not used, all features in the dataset are processed. | 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". | FALSE | This must be specified for HOB input. |
--filter-file | L | The path to a FILTER file containing rules for selecting features. The filter file (*.filter) is created by CARIS software in CQL (common query language) format. Rules that are not valid for the input are skipped without error.
| FALSE | |
--rule-file | U | The path to the CRFX file containing rules for the selection filter. The CRFX file must be one created for selection. Other CRFX files, such as ones to perform deconfliction in CombineToRaster process, cannot be used for this purpose. Rules that are not valid for the input are skipped without error. This option is not supported for an input HPD database URI.
| FALSE | |
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to create a filtered selection of features using a rule file. | |
Description | Command Line Syntax | |
The input has features and attributes defined in the S-57 ENC 3.1 feature catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The rule file is named Filter.crfx and located at D:\BatchSample. | --rule-file D:\BatchSample\Filter.crfx | |
The input file is named Surface10.hob and located at D:\BatchSample. | D:\BatchSample\Surface10.hob | |
The output file will be named FilterFeatures.hob and located at D:\BatchSample. | D:\BatchSample\FilterFeatures.hob | |
Command Line |
| |
Outcome | A new HOB file is created from a filtered subset of the input HOB. | |
Extra Notes | N/A | |