Description
The AddEmptyBand process creates a new band with no data values at every node. This process is expected to be used in process models together with the UpdateBandValues process to create and populate a new permanent band in a coverage.
Update
A coverage in CSAR format.
Command Line Syntax
carisbatch --run AddEmptyBand --category <value> --band-name <value> [options] <update>
User Interface Command
N/A
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--category | A string specifying the category of the band to create. One of the following: • SCALAR: Single scalar value. Has a unit key and direction. | FALSE | ||
--band-name | A string specifying the name to be used for the new band. This name must be different from the band names already present in the coverage. Reserved band names, such as Status, cannot be used. | FALSE | This must be specified explicitly. | |
--unit | A string specifying the unit of data in the band. Elevation bands must have a length unit, which is metres (m) by default. If the z-axis convention is None, the default unit key is CARIS:NONE and the band is created as a unitless band. Supported units: all units defined in the units table support file, and CARIS:NONE. | FALSE | ||
--direction-type | A string specifying the direction type of data in the band. One of the following: • ELEVATION: Positive band values are heights. Elevations are always internally stored in CSAR files as up-is-positive values. • NONE: Band values are numeric and represent neither heights nor depths. The default value is NONE. | FALSE | ||
--numeric-type | A string specifying the numeric type of data in the band. One of the following: • INT8: 8-bit signed integer. Valid values are -128 to 127 inclusive. • UINT8: 8-bit unsigned integer. Valid values are 0 to 255 inclusive. • INT16: 16-bit signed integer. Valid values are -32,768 to 32,767 inclusive. • UINT16: 16-bit unsigned integer. Valid values are 0 to 65,535 inclusive. • INT32: 32-bit signed integer. Valid values are -2,147,483,648 to 2,147,483,647 inclusive. • UINT32: 32-bit unsigned integer. Valid values are 0 to 4,294,967,295 inclusive. • INT64: 64-bit signed integer. Valid values are -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 inclusive. • UINT64: 64-bit unsigned integer. Valid values are 0 to 18,446,744,073,709,551,615 inclusive. • FLOAT32: 32-bit floating point number. Used for general floating point values. Valid values are 3.4E +/- 38 (7 digits). Floating point numbers are always signed, i.e. can be negative or positive. • FLOAT64: 64-bit floating point number. Used for high precision floating point values. Valid values are 1.7E +/- 308 (15 digits). Floating point numbers are always signed, i.e. can be negative or positive. Elevation bands must be floating point. The default value is FLOAT32. | FALSE | ||
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to add an empty elevation band to a coverage. | |
Description | Command Line Syntax | |
The new band will be of scalar type. | --category SCALAR | |
The band will be named "Specified_Values" | --band-name "Specified_Values" | |
The band will be populated with elevation type data. | --direction-type ELEVATION | |
The data will be in units of feet. | --unit ft | |
The data will be in 64-bit floating point number format. | --numeric-type float64 | |
The band will be added to the PointCloud.csar coverage located in D:\SampleData. | D:\SampleData\PointCloud.csar | |
Command Line |
| |
Outcome | A new Specified_Values band is added to PointCloud.csar and can be populated with elevation data using units of feet. | |
Extra Notes | N/A | |