CARIS Batch Utility : BASE Editor Processes : Finalize VR Surface
 

Finalize VR Surface

Description

The FinalizeVRSurface process appends designated soundings to the primary elevation band of a variable resolution surface.

Inputs

A variable resolution surface in CSAR format.

Outputs

A variable resolution surface in CSAR format.

Command Line Syntax

carisbatch --run FinalizeVRSurface [options] <input> <output>

Options

The following table describes the parameters available for this process.

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 numeric value specifying the minimum uncertainty threshold to include nodes in the output.

FALSE

--uncertainty-source

s

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

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 range's lower bound.

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

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

--polygon-type

Y

A string specifying the type of bounding polygon to generate.

CONVEX: The convex hull of the data is used for the polygon.

BUFFERED: A simplified buffered boundary is used for the polygon.

The default value is BUFFERED.

FALSE

--comments

General comments to be added to the coverage metadata.

The default value is an empty string.

FALSE