Parameter

Long

Short

Description

Can Repeat

Notes

--resolution

R

A number and unit specifying the resolution of the output raster.

Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

FALSE

This must be specified explicitly.

--extent

E

The extents that define the window.

<LowerX> - A number specifying the lower left X origin in the coordinate reference system of the output.

<LowerY> - A number specifying the lower left Y origin in the coordinate reference system of the output.

<UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output.

<UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output.

The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for unprojected data, an angle type unit is required. The order for unprojected coordinates is longitude followed by latitude.

Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

If not set, the extents are computed from the input data.

FALSE

--anchor

A

The point that defines the output raster anchor position.

<LowerX> - A number and unit specifying the lower left X origin in the coordinate reference system of the output.

<LowerY> - A number and unit specifying the lower left Y origin in the coordinate reference system of the output.

The anchor position is a position in the centre of a cell.

HALF_RES is used to calculate a coordinate position for a cell centre that is half the resolution offset from a multiple of the resolution, which creates cells that have their lower left corner at a multiple of the resolution. Typically, the usage in this context is --anchor HALF_RES HALF_RES.

The default value is 0.0 0.0.

FALSE

--output-crs

c

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

If specified, the data will be transformed.

FALSE

--output-vertical-crs

o

A string specifying the vertical coordinate reference system key of the output.

No vertical transformation will be applied even if a value is specified. This value is only used as metadata on the output dataset.

The default value is Unknown.

FALSE

--input-band

i

A string specifying the name of the input band.

An error message will be provided if any input does not contain the band specified.

If not set, the primary elevation band of the source will be used.

FALSE

--primary-band

m

A string specifying the name given to the primary band of the output.

The default value is Depth.

FALSE

--vertical-uncertainty

The name of the band containing vertical uncertainty data for source points.

An error message will be provided if any input does not contain the band specified.

The default value is Uncertainty.

FALSE

--horizontal-uncertainty

The name of the band containing horizontal uncertainty data for source points.

If not set, the default is to ignore horizontal uncertainty.

FALSE

--disambiguation-method

The method used to select a hypothesis from a set. One of:

• DENSITY: Disambiguate by number of samples.

• LOCALE: Disambiguate by surrounding nodes.

• DENSITY_LOCALE: Disambiguate by a combination of sample count and surrounding nodes.

The default value is DENSITY_LOCALE.

FALSE

--cube-config-file

The path to a file specifying the XML document containing CUBE configuration parameters.

FALSE

--cube-config-name

The name of the CUBE configuration to use.

This must be set if CubeConfigFile is set.

FALSE

--cube-config-settings

A string encoding a set of CUBE configuration parameters.

If set, this overrides the values set in CubeConfigFile and CubeConfigName.

FALSE

--iho-order

The IHO S-44 Order to apply.

• S44_SPECIAL: Predefined S-44 horizontal and vertical error limits for Special Survey Order

• S44_1A: Predefined S-44 horizontal and vertical error limits for 1a Survey Order

• S44_1B: Predefined S-44 horizontal and vertical error limits for 1b Survey Order

• S44_2: Predefined S-44 horizontal and vertical error limits for 2 Survey Order

• S44_USER: User defined horizontal and vertical error limits (a,b,horizontal distance limit of depth, horizontal percentage of depth)

If not set, the default is S44_USER, which requires IHOLimits and IHOHorzDistLimits to be set.

FALSE

--iho-limits

The IHO S-44 Order 'a' and 'b' error values to be used if User defined is chosen.

<a value> - Constant error

<b value> - Depth dependent error

This is only applicable if IHO Order is not set or set to S44_USER.

FALSE

--use-chgf-distance

If set, uses the Chebyshev approximation of the Confluent Hypergeometric Function for mean propagation distance of soundings to nodes.

If set, the HorizontalUncertainty must also be set. If not set, the default is to use the horizontal uncertainty propagation in CUBE parameters. This function improves hypothesis generation over slopes and steep features.

FALSE

--comments

General comments to be added to the coverage metadata.

The default value is an empty string.

FALSE

Example

Objective

You want to generate a CUBE surface from a point cloud with uncertainty bands generated from the AddComputedBand process.

Description

Command Line Syntax

The CUBE surface will have a resolution of 5 metres.

--resolution 5m

The elevation values will be taken from the Depth band in the point cloud.

--input-band Depth

Vertical uncertainty data will be applied from the VertUncert band in the point cloud.

--vertical-uncertainty VertUncert

Horizontal uncertainty data will be applied from the HorizUncert band in the point cloud.

--horizontal-uncertainty HorizUncert

The Density and Locale method will be used for disambiguation.

--disambiguation-method DENSITY_LOCALE

The source point cloud is CloudData.csar and is located in the D:\BatchSample directory.

D:\BatchSample\CloudData.csar

The resulting surface will be named CUBESurface.csar and stored in the D:\BatchSample directory.

D:\BatchSample\CUBESurface.csar

Command Line

carisbatch --run GridPointsUsingCUBE --resolution 5m --input-band Depth --vertical-uncertainty VertUncert --horizontal-uncertainty HorizUncert --disambiguation-method DENSITY_LOCALE D:\BatchSample\CloudData.csar D:\BatchSample\CUBESurface.csar

Outcome

A new CUBE surface is generated in the specified location with uncertainty values from the input point cloud.

Extra Notes

N/A