Parameter

Long

Short

Description

Can Repeat

Notes

--include-band

b

A string specifying the name of a band to include in the output.

The ALL keyword is used to include all other bands in the output.

TRUE

--apply-designated

a

If set, designated soundings will be retrieved from the sources used to construct the input surface and appended to the points of the output.

Designated soundings included in a variable resolution mesh will, by default, be added to surface triangulations; options are available to either ignore designated soundings or to have them suppress non-designated points.

FALSE

--include-designated-bands

d

If set, additional attributes of designated soundings from source datasets will be copied into applied designated soundings.

This option only applies if ApplyDesignated is set to true.

FALSE

--min-uncertainty

m

A number specifying the override value for any Uncertainty value below this threshold.

FALSE

--uncertainty-source

s

A string specifying the source of the uncertainty value in the input to include in the output. One of:

• UNCERT: Uncertainty

• STD_DEV: Standard deviation (scaled to 95% CI)

• GREATER: Greater of the two values

FALSE

--filter

f

Filter applied to primary elevation band values.

<MinValue> - A number specifying the lower bound of the range.

<MaxValue> - A number specifying the upper bound of the range.

Values falling outside the specified minimum and maximum range are set to no data. Equivalent cells in other bands included in the output are also set to no data.

FALSE

--comments

General comments to be added to the coverage metadata.

The default value is an empty string.

FALSE

Example

Objective

You want to add designated soundings to a variable resolution surface.

Description

Command Line Syntax

The Depth band is to be included in the output.

--include-band Depth

Designated soundings are to be retrieved from the sources used to create the variable resolution surface.

--apply-designated

Attributes for designated soundings from the source datasets are to be included.

--include-designated-bands

Any data with an uncertainty less than 0.5 will be assigned this threshold value.

--min-uncertainty 0.5

Uncertainty in the source data will be determined using the GREATER option.

--uncertainty-source GREATER

The input surface is named OriginalVR.csar and is in the BatchSample directory on the D: drive.

D:\BatchSample\OriginalVR.csar

The output surface will be named FinalizedVR.csar and will be in the source directory.

D:\BatchSample\FinalizedVR.csar

Command Line

carisbatch --run FinalizeVRSurface --include-band Depth --apply-designated --include-designated-bands --min-uncertainty 0.5 --uncertainty-source GREATER D:\BatchSample\OriginalVR.csar D:\BatchSample\FinalizedVR.csar

Outcome

A new surface is created in the specified location. This surface will contain the designated soundings and their attributes from all datasets used to create the variable resolution surface. All data with an uncertainty of less than 0.5 will be set as having an uncertainty of 0.5.

Notes