Description
The GeneralizeRaster process modifies elevation values to produce a smoother surface. A 3D double buffering rolling ball algorithm is applied.
Inputs
A raster surface. A BDB Server URI can be specified as input.
Outputs
A raster surface in CSAR format. The output will have the same CRS and approximately the same extents as the input.
Command Line Syntax
carisbatch --run GeneralizeRaster --resolution <value> --radius <value> [options] <input> <output>
User Interface Command
Generalize Raster
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 | |
--resolution | R | A number and unit specifying the resolution of the output raster. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | FALSE | This must be specified explicitly. Changing the resolution causes the WarpRaster process to be run. |
--radius | a | A number specifying the radius that can affect an output cell. Input cells within this radius of an output cell are considered by the 3D double buffering (rolling ball) generalization algorithm and may affect the output cell. The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | FALSE | This must be specified explicitly. |
--defocus-radius | d | A number specifying the radius of the footprint of shoal input cells. Shoal input cells are enlarged to this size; this value must be greater than or equal to the output resolution. This can be used to represent the horizontal positioning uncertainty of the shoal values. If this value is not set, defocusing is not applied. The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | FALSE | This is optional. |
--apply-designated | g | If set, designated soundings from the input will be applied. | 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 create a product surface by generalizing an existing raster surface. | |
Description | Command Line Syntax | |
The generalization radius is 400 metres. | --radius 400m | |
The resolution to be used for the resulting surface is 20 metres. | --resolution 20m | |
Designated soundings are to be retained in the resulting surface. | --apply-designated | |
The source surface is Surface.csar located in the D:\BatchSample directory. | D:\BatchSample\Surface.csar | |
The resulting surface will be called Generalized.csar, and located in the D:\BatchSample directory. | D:\BatchSample\Generalized.csar | |
Command Line |
| |
Outcome | A new, generalized CSAR raster is created. | |
Notes | N/A | |