Ungroup Sounding Features

The UngroupSoundingFeatures process ungroups soundings in the input and saves the results to the output.

This process ungroups soundings using the same rules that are used by the Ungroup Soundings 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 UngroupSoundingFeatures --feature-catalogue <value> [options] <input> <output>

Source Editor/Product Editor/S-57 Composer: Edit > Soundings > Ungroup All, Edit > Soundings > Ungroup 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 ungrouped. The filter is ignored with a warning message if the input map represents sounding groups using collection features as is done for HPD products. The filter file (*.filter) is created by CARIS software in CQL (common query language) format.	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 ungrouped.

The filter is ignored with a warning message if the input map represents sounding groups using collection features as is done for HPD products.

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

FALSE

Optional

S-57
Objective	Ungroup soundings in an input file, apply the feature catalogue and filter file, and save results to the output file.
Description		Command Line Syntax
Feature catalogue for the output file.		`--feature-catalogue “S-57 ENC 3.1”`
Filter file for selecting the soundings to ungroup.		`--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 UngroupSoundingFeatures --feature-catalogue "S-57 ENC 3.1" --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 ungrouped soundings according to the specified catalogue and filter.

HPD URI
Objective	Ungroup 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 UngroupSoundingFeatures hpd://username:password@database?ProductVersionId=10003;ProjectId=12 hpd://username:password@database?ProductVersionId=10003;ProjectId=12`
Outcome	The HPD product is updated and its grouped sounding clusters are ungrouped.