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 --band-type <value> [options] <update>
User Interface Command
None.
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. • NUMERIC: A scalar or other numeric band in a process. • 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 | |
--geometry | G | A geometry with its coordinate reference system to identify which points are to be updated. <WKT> - A string specifying the shape of the geometry. <CRS> - A string specifying the horizontal coordinate reference system key of the geometry. The geometry can be composed of one or more polygons that contain one or more holes. This is optional. If neither Geometry or Geometry File are specified, no geometry-based filtering is performed and all values may be updated. | FALSE | |
--geometry-file | A WKT file containing the geometry to identify which points are to be updated. The WKT file must contain both the geometry and coordinate reference system and must be formatted appropriately. The geometry can be composed of one or more polygons that contain one or more holes. This is optional. If neither Geometry or Geometry File are specified, no geometry-based filtering is performed and all values may be updated. If both Geometry and Geometry File are specified, the geometry file is ignored. | FALSE | ||
--geometry-type | g | A string specifying the area where points are to be updated. • INCLUSIVE: Update all data inside the geometry. • EXCLUSIVE: Update all data outside the geometry. The default value is INCLUSIVE. | FALSE | |
BandType = NUMBERIC Options | ||||
--input-band | i | A string specifying the band to update. | FALSE | |
--value | The value set for the band for nodes where the expression is satisfied and/or are within a geometry. This can be a value, such as 0 or NO_DATA, or a mathematical expression such as Depth + 2. If using the geometries as a filter, and they have a single common Z‑value, the Z‑value can be used in the expression as GEOMETRY_Z. The expression must be written using the positive-up convention for any elevation bands. | 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 examples.
Example | ||
|---|---|---|
Objective | You want to identify and label all points within a geometry as no-data points in a point cloud. | |
Description | Command Line Syntax | |
The band type to be updated is NUMERIC. | --band-type NUMERIC | |
The points are to be updated in the Depth band. | --input-band Depth | |
A geometry file, ClipDepthWithinArea.wkt, will be used to filter the points to be updated. The file is located in the SampleData directory on the D: drive. | --geometry-file D:\SampleData\ClipDepthsWithinArea.wkt | |
Points will be updated if they have a depth less than 0. | --expression "Depth < 0" | |
All points that meet the specified criteria are to be flagged as NO_DATA points. | --value NO_DATA | |
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 |
| |
Outcome | All points in the Depth band within the specified geometry that have a depth less than 0 are now flagged as no-data points. | |
Extra Notes | N/A | |
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 less than 1 and a standard deviation greater than 1. | --expression "Depth < 1 AND Std_Dev > 1" | |
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 |
| |
Outcome | All points in the point cloud with a depth less than 1 and a standard deviation greater than 1 now have a Status value of Rejected. | |
Extra Notes | N/A | |