CARIS Batch Utility : BASE Editor Processes : Update Band Values
 

Update Band Values

Description

The UpdateBandValues process changes values for all nodes that pass the criteria in an expression.

Update

A coverage in CSAR format. Currently, this process is focused on values in point cloud-specific bands.

Outputs

An updated coverage in CSAR format.

Command Line Syntax

carisbatch --run UpdateBandValues [options] <update>

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--band-type

A string specifying the type of band to be updated.

STATUS: A Status band in a point cloud.

FALSE

--expression

e

A string specifying a boolean expression.

The following operations are supported: AND, OR, +, -, *, /, ^ (exponent), <, >, =, and != (not equal). For example, "Depth > 1 AND Std_Dev < 2".

All values representing elevations are entered using the convention that up is positive.

This is optional. If not specified, all band values are considered.

FALSE

BandType = Status Options

--value

The value set for Status for nodes where the expression is satisfied.

ACCEPTED: The points are accepted.

REJECTED: The points are rejected.

FALSE

Example

To use this command refer to the following example.

Example

Objective

You want to reject all points in a point cloud that meet specific criteria.

Description

Command Line Syntax

The band type to be updated is STATUS.

--band-type STATUS

Points will be rejected if they have a depth greater than 1 and a standard deviation less than 2.

--expression "Depth > 1 AND Std_Dev < 2"

All points that meet the specified criteria will have their Status value changed to Rejected.

--value REJECTED

The point cloud to be updated is named InputCloud.csar and is located in the SampleData directory on the D: drive.

D:\SampleData\InputCloud.csar

Command Line

carisbatch --run UpdateBandValues --band-type STATUS --expression "Depth > 1 AND Std_Dev < 2" --value REJECTED D:\SampleData\InputCloud.csar

Outcome

All points in the point cloud with a depth greater than 1 and a standard deviation less than 2 now have a Status value of Rejected.

Extra Notes

N/A