Group Sounding Features

The GroupSoundingFeatures process groups soundings in the input and saves the results to the output.

Sounding groups store sounding data more efficiently by combining each group of soundings with identical attribute values into a single sounding group.

This process groups soundings using the same rules that are used by the Group Soundings By Area command in the desktop applications.

Features in a supported format. HOB, H20, 000 (S-57 or S-101 specification), and HPD URIs are supported.

Features in HOB or H20 format. An HPD URI may be specified along with an identical input HPD URI to update an HPD product.

Different URIs are not supported. An error will occur if HPD URIs are specified for input and output and the URIs do not match.

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

Product Editor/S-57 Composer: Edit > Soundings > Group All, Edit > Soundings > Group Selection

Long	Short	Description	Can Repeat	Notes
`--feature-catalogue`	-F	A string specifying the name of the catalogue that defines 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 the 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	Required if the output is a HOB file.
`--filter-file`	-L	Path to a FILTER file that contains rules for selecting the soundings to be grouped. The filter file (*.filter) is created by CARIS software in CQL (common query language) format.	FALSE	Optional
--group-by-area-geometry		Group by area geometries that define the boundaries for grouping soundings. The geometry may be one or more area geometries in any supported vector format, including HOB, H2O, Shapefile and WKT. It may be in the form of a file, in-memory features or geometries created by another process in a process model. Only area geometries are considered – all other geometries are ignored. The exterior and interior boundaries of the given area geometries are used to group soundings. If no area geometry is included in the input, this option has no effect. An error occurs if this option is used but: • Dataset already has grouped soundings • Specified area geometries overlap.	FALSE	Optional

Long

Short

Description

Can Repeat

Notes

--feature-catalogue

-F

A string specifying the name of the catalogue that defines 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 the 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

Required if the output is a HOB file.

--filter-file

-L

Path to a FILTER file that contains rules for selecting the soundings to be grouped.

The filter file (*.filter) is created by CARIS software in CQL (common query language) format.

FALSE

Optional

--group-by-area-geometry

Group by area geometries that define the boundaries for grouping soundings. The geometry may be one or more area geometries in any supported vector format, including HOB, H2O, Shapefile and WKT. It may be in the form of a file, in-memory features or geometries created by another process in a process model.

Only area geometries are considered – all other geometries are ignored.

The exterior and interior boundaries of the given area geometries are used to group soundings.

If no area geometry is included in the input, this option has no effect.

An error occurs if this option is used but:

• Dataset already has grouped soundings

• Specified area geometries overlap.

FALSE

Optional

S-57
Objective	Group soundings from an input that fall within the area geometry defined in `boundaries.hob`, apply the feature catalogue and filter file, and save results to the output.
Description		Command Line Syntax
Feature catalogue for the output file.		`--feature-catalogue “S-57 ENC 3.1”`
File that defines the boundaries for soundings to group.		-`-group-by-area-geometry D:\inputs\boundaries.hob`
Filter file for selecting the soundings to group.		`--filter-file sounding.filter`
Path of the input file in a supported format.		`D:\inputs\gb4x0000_in.hob`
Path of the output file in a supported format.		`D:\outputs\gb4x0000_out.hob`
Command Line	`carisbatch --run GroupSoundingFeatures --feature-catalogue "S-57 ENC 3.1" --group-by-area-geometry D:\inputs\boundaries.hob --filter-file sounding.filter D:\inputs\gb4x0000_in.hob D:\outputs\gb4x0000_out.hob`
Outcome	A new file is created in the specified location containing grouped soundings, within the defined area boundaries, according to the specified catalogue and filter.

HPD URI
Objective	Group soundings in an HPD product and save the results.
Description		Command Line Syntax
HPD Product URI.		`hpd://username:password@database?ProductVersionId=10003;ProjectId=12`
Command Line	`carisbatch --run GroupSoundingFeatures hpd://username:password@database?ProductVersionId=10003;ProjectId=12 hpd://username:password@database?ProductVersionId=10003;ProjectId=12`
Outcome	The HPD product is updated and now has grouped sounding clusters.