Process Designer : CARIS Batch Utility : BASE Editor Processes : Add Computed Band
 

Add Computed Band

Description

The AddComputedBand process adds a band to an existing coverage by applying an expression to the existing data.

Update

A raster surface, point cloud, or variable resolution surface in CSAR format.

Outputs

An updated coverage in CSAR format.

Command Line Syntax

carisbatch --run AddComputedBand --compute-band <value> --z-axis-convention <value> --computed-band-type <value> [options] <update>

User Interface Command

Add Computed Band

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--compute-band

a

A string specifying the name of the output band to be computed from the input points.

FALSE

This must be specified explicitly.

--expression

e

A string specifying a numeric expression.

The following operations are supported: IF, THEN, ELSE, AND, OR, NOT, IN, +, -, *, /, ^ (exponent), <, >, =, and != (not equal). For example, "Depth + 1" or "If (Depth = NO_DATA) Then NO_DATA Else If (Depth < 40) Then 0 Else If (Depth < 20) Then 1 Else If (Depth < 0) Then 2 Else 3.

FALSE

--expression-file

A file containing the expression.

If an expression is also specified, an expression file is ignored.

FALSE

--z-axis-convention

z

A string specifying the Z-axis convention of the expression.

UP: Any elevation band values in the expression are treated as heights.

DOWN: Any elevation band values in the expression are treated as depths.

FALSE

This must be specified explicitly.

--computed-band-type

A string specifying the type of data in the output band.

Elevation: The output band contains elevation values.

Numeric: The output band contains numeric values.

FALSE

This must be specified explicitly.

Example

To use this command, refer to the following example.

Example

Objective

You want to add a band to your point cloud that displays only data that has been classified as Low Point (noise). Also, all data on this band is to have its elevation values shifted by -10m.

Description

Command Line Syntax

The new band will be called LowPoints.

--compute-band LowPoints

The following expression will be used to populate the new band:

IF (Classification = 'Low Point (noise)') THEN Depth-10

--expression IF (Classification = 'Low Point (noise)') THEN Depth-10

The new band will use the Z-axis convention of up is positive.

--z-axis-convention UP

The new band will contain elevation values.

--computed-band-type Elevation

The band will be added to PointCloud.csar located in the D:\SampleData directory.

D:\SampleData\PointCloud.csar

Command Line

carisbatch --run AddComputedBand --compute-band LowPoints --expression IF (Classification = 'Low Point (noise)') THEN Depth-10 --z-axis-convention UP --computed-band-type Elevation D:\SampleData\PointCloud.csar

Outcome

A new band is added to the point cloud and displayed in the Layers window with the assigned name. This band will display only points that have been assigned the classification Low Point (noise) and the values of the points will be 10m less than the points in the original source data.

Extra Notes

N/A