Description
The FinalizeRaster process embeds designated soundings into the primary elevation band of the raster dataset.
Inputs
A raster surface.
Outputs
A raster surface in CSAR format.
Command Line Syntax
carisbatch --run FinalizeRaster [options] <input> <output>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all other bands in the output. | TRUE | |
--apply-designated | a | If set, designated soundings from the source of the input are applied to the output. Designated soundings in the source of the input raster surface override the depth value at their respective positions in the primary elevation band of the output. | FALSE | |
--min-uncertainty | m | A number specifying the override value for any Uncertainty value below this threshold. | FALSE | |
--uncertainty-source | s | A string specifying the source of the uncertainty value in the input to include in the output. One of: • UNCERT: Uncertainty • STD_DEV: Standard deviation (scaled to 95% CI) • GREATER: Greater of the two values | FALSE | |
--filter | f | Filter applied to primary elevation band values. <MinValue> - A number specifying the lower bound of the range. <MaxValue> - A number specifying the upper bound of the range. Values falling outside the specified minimum and maximum range are set to no data. Equivalent cells in other bands included in the output are also set to no data. | FALSE | |
--comments | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | ||
Example
To use this command refer to the following example.
Example | ||
Objective | You want to finalize a raster surface. | |
Description | Command Line Syntax | |
In addition to the Depth band, all other bands will be included in the output. | --include-band ALL | |
The designated soundings from the source of the input raster surface will be applied to the resulting surface. | --apply-designated | |
The data included in the resulting surface must be within the range of -0.5 metres to 100.0 metres. | --filter -0.5 100 | |
The source raster surface is named Surface1.csar located in the D:\BatchSample directory. | D:\BatchSample\Surface1.csar | |
The resulting raster surface will be called Finalized.csar located in the D:\BatchSample directory. | D:\BatchSample\Finalized.csar | |
Command Line |
| |
Outcome | A new CSAR raster will be created with the same bands as Surface1.csar. The values of the Depth band in Surface1.csar will be used to filter the values in all bands; no band will have a value in any location that the Depth is less than -0.5 or greater than 100. Designated soundings from the source of Surface1.csar will also be applied to the Depth values. | |
Extra Notes | N/A | |