CARIS HIPS and SIPS : CARIS Batch Utility : Feature Editing Processes : Update Features
 

Update Features

The UpdateFeatures process updates features in the output using features from the input that have the same primary key.

The coordinate reference systems and the X/Y resolutions of the input and output must match.

Note that the process uses a one-to-one match between feature identifiers or attributes. UpdateFeatures will fail with a many-to-one or a one-to-many match.

Input

A Shapefile, GML file, HOB file, H2O file, S-57 file, HPD database URI, or a simple oracle feature table URI.

Update

An existing HOB file, H2O file or HPD database URI. An HPD URI must specify the project to use and either a usage or a product to update.

Process Models

When an HPD URI is specified for update, UpdateFeatures only queries features from HPD that are specified by the MatchBy option. If the output of UpdateFeatures is passed to another process in a process model, features are not queried from HPD by the next process. Only features that were queried from the database with updates applied are provided by UpdateFeatures.

Command Line Syntax

carisbatch --run UpdateFeatures [options] <input> <update>

Options

The following table describes the parameters available for this process.

Long

Short

Description

Can Repeat

Notes

--match-by

-m

A primary key by which to match features. By default, the unique feature object identifier (FOID) is used as the primary key. An attribute acronym can also be specified.

The process will update output features with input features having the same primary key as the output features.

FALSE

--require-all

-q

Cancel the process if any feature fails to be updated.

FALSE

--feature-catalogue

-F

The catalogue that defines features and attributes in an output HOB or H2O file. Catalogue information is read from the Catalogue Control File. See Catalogues for a list of available catalogues.

This option is required if the output is a HOB or H2O file and will be ignored if the output is not a HOB or H2O file.

FALSE

--update-relations

-d

Determine if relation differences will be applied.

FALSE

--certification-status

-k

The certification status to be assigned to all updated features.

Possible values are:

KEEP_EXISTING (no change to certification status)

UNDER_CONSTRUCTION

NOT_VERIFIED

The default value is UNDER_CONSTRUCTION.

This option is only used with HPD URIs.

If this option is specified, but the output does not support certification status, this setting will be ignored and a warning message will be reported.

Note: The KEEP_EXISTING value replaces the KeepCertificationStatus option used previously.

FALSE

--input-crs

-p

A string specifying the horizontal coordinate reference system key of the input.

This option is only used when the input is a generic Oracle feature table that does not have a registered coordinate reference system.

FALSE

--map-undefined-attribute-value

-n

The attribute value to map to "undefined".

All attributes with the given value will be mapped to undefined in the output.

FALSE

--map-unknown-attribute-value

-w

The attribute value to map to "unknown".

All attributes with the given value will be mapped to unknown in the output.

FALSE

--tolerance

-T

A number and unit specifying the maximum distance between coordinates for geometry difference detection.

This option can be used if there are slight differences in the coordinates of features in the input and output files due to transformation noise. Features whose coordinates fall within the tolerance are considered identical and are not updated.

The unit is an abbreviation for a distance unit (cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, or yd).

If this option is not used, the default will be 0.0.

FALSE

--match-geometry-by

g

The method for comparing the geometry of features that match by key. If the geometry is not equal, it will be updated. Note that features are matched using the MatchBy option.

Possible values are:

COMPONENTS: The geometry of matching area features or matching line features will be updated if their edge components do not match. Connected nodes (start and end point) and 0 - n vertices define each edge component. Other feature types (points, soundings and text) will be updated if their coordinates do not match.

COORDINATES: The geometry of matching features will only be updated when they have different coordinates. Whether or not the coordinates are for connected nodes or for vertices of edges is not relevant.

NON_REDUNDANT_COORDINATES: The geometry of matching features will only be updated when they have different coordinates, excluding redundant vertices, which are ignored. Whether or not the coordinates are for connected nodes or for vertices of edges is not relevant.

In all cases the shape of matching features must also match for geometry to be equal. It is possible for features with the same coordinates to have different shapes. For example a composite area with 2 outer rings could have the same coordinates as a simple area with one outer ring.

It is possible for two area or line features to have the same coordinates or the same non-redundant coordinates but edge components with different connected nodes and/or vertices.

The only difference between the COORDINATES and the NON_REDUNDANT_COORDINATES method is that redundant vertices are considered for the COORDINATES method, but are ignored by the NON_REDUNDANT_COORDINATES method.

The Tolerance option will be ignored when the COORDINATES or NON_REDUNDANT_COORDINATES methods are used with this option.

Note: The NON_REDUNDANT_COORDINATES value replaces the CompareShapes option used previously.

FALSE

Example

Stand-Alone file

Objective

Update features in FeaturesToUpdate.hob using features in UpdateFeatures.hob.

Description

Command Line Syntax

Match features using the OBJNAM attribute.

--match-by OBJNAM

The S-57 ENC 3.1 catalogue is used to define features in the output file.

--feature-catalogue "S-57 ENC 3.1"

The file containing the features to use to update the original features is called UpdateFeatures.hob and is located in the root of the D: drive.

D:\UpdateFeatures.hob

The file containing the original features to be updated is called FeaturesToUpdate.hob and is also located in the root of the D: drive.

D:\FeaturesToUpdate.hob

Command Line

carisbatch --run UpdateFeatures --match-by OBJNAM

--feature-catalogue "S-57 ENC 3.1" D:\UpdateFeatures.hob D:\FeaturesToUpdate.hob