Description
The RenderRaster process exports a raster band to an image by converting the values into colours. The output raster will have the same dimensions, coordinate reference system and geographic extent as the input.
Inputs
A raster dataset with a numeric band. A BDB Server URI can be specified as input.
Outputs
A raster image in CSAR format. This file can be converted to other image formats using Export Raster if needed.
Command Line Syntax
carisbatch --run RenderRaster ‑‑input-band <value> [options] <input> <output>
User Interface Command
Export Coverage to Image
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--input-band | i | A string specifying the name of the input band. | FALSE | This must be specified explicitly. |
--colour-file | c | The name of the colour map file to use when rendering the raster. The file must be in the directory specified in the Tools > Options > Files and Folders > Folders > Colour Maps, for example Rainbow.cma. The default value is "Rainbow.cma". The default location of the Colour folder is C:\ProgramData\CARIS\BASE Editor\<version>\Colour. | FALSE | |
--colour-range | G | The values that will map onto the first and last colours in the colour map. <MinValue> - A number specifying the value that will map onto the first colour in the colour map. <MaxValue> - A number specifying the value that will map onto the last colour in the colour map. | FALSE | |
--reverse-colours | R | If set, the colour map is applied in the reverse order. | FALSE | |
--enable-shading | e | If set, shading is applied. | FALSE | |
--shading | s | The sun shading parameters used when rendering the raster. <AzimuthAngle> - A number specifying the azimuth angle applied for sun shading in degrees. <ElevationAngle> - A number specifying the elevation angle applied for shading in degrees. <Exaggeration> - A number specifying the multiplier for each band value. This must be a positive number. The default value is 45.0 45.0 1.0. | FALSE | |
-exaggeration | A number specifying the multiplier for each band value. This must be a positive number. The default value is 1.0. | FALSE | ||
--filter | f | Filter the input bands by setting those outside the specified range to NO-DATA. <MinValue> - A number specifying the range's lower bound. <MaxValue> - A number specifying the range's upper bound. | FALSE | |
--transparency | t | A number specifying the transparency, as a percentage. The default value is 0, no transparency. 100 is fully transparent. 0 is fully opaque. | FALSE | |
--z-convention | z | A string specifying the output Z-axis convention. • UP: Z axis positive up • DOWN: Z axis positive down The default value is DOWN. | FALSE | |
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to export a raster band to an image. | |
Description | Command Line Syntax | |
The input raster band is depth. | --input-band Depth | |
The 10colours.cma colour map is applied to the output. | --colour-file 10colours.cma | |
Shading is enabled. | --enable-shading | |
For shading, the azimuth angle is 30, the elevation angle is 40 and the exaggeration is 2. | --shading 30 40 2 | |
The source surface, Surface1.csar, is located at D:\BatchSample. | D:\BatchSample\Surface1.csar | |
The resulting CSAR raster will be created in the D:\BatchSample directory with the name Rendered.csar. | D:\BatchSample\Rendered.csar | |
Command Line |
| |
Outcome | A CSAR raster image is created in the specified folder. | |
Extra Notes | N/A | |