Description
The ExportRaster process exports a raster dataset in one format to another format. The output raster will have the same coordinate reference system, geographic extents and values as the input raster.
Inputs
A raster dataset in a supported format.
Outputs
A raster dataset in the specified output format.
Command Line Syntax
carisbatch --run ExportRaster --output-format <value> ‑‑include-band <value> [options] <input> <output>
User Interface Command
Export Raster
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--output-format | O | A string specifying the format in which the output is generated. One of: • BAG: The Bathymetry Attributed Grid raster surface format. • ESRI_ASCII: The ESRI ASCII raster surface format. • USGS_DEM: The USGS Digital Elevation Map raster surface format. • GEOTIFF: The GeoTIFF raster format. This may be a raster surface or a raster image, depending on the input. • PNG: The Portable Network Graphics raster image format. • JPEG: The JPEG raster image format, with a compression factor of 75%. • CSAR: The CSAR raster format. This may be a raster surface or a raster image, depending on the input. Options specific to each format are specified below. | FALSE | This must be specified explicitly. |
ExportRasterTo = BAG | ||||
--include-band | b | A string specifying the name of a band to include in the output. The band must contain elevation data. | FALSE | This must be specified explicitly. |
--uncertainty | t | A string specifying the name of the uncertainty band in the input. | FALSE | |
--compress-level | o | A number specifying the level of compression applied to the output. The default value is 1. The valid range is 0 to 9, not compressed to highly compressed. | FALSE | |
Refer to Export Coverage Metadata for additional BAG metadata profile details. | ||||
ExportRasterTo = ESRII ASCII | ||||
--include-band | b | A string specifying the name of a band to include in the output. | FALSE | This must be specified explicitly. |
--decimal-precision | d | A number specifying the decimal precision for floating point numeric values. The default value is 3. | FALSE | |
ExportRasterTo = USGS_DEM | ||||
--include-band | b | A string specifying the name of a band to include in the output. | FALSE | This must be specified explicitly. |
--decimal-precision | d | A number specifying the decimal precision for floating point numeric values. The default value is 3. | FALSE | |
ExportRasterTo = GEOTIFF | ||||
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all bands in the output. | TRUE | At least one band must be specified. |
--compression | C | A string specifying the type of compression applied to the output GeoTIFF. One of: • NONE: No compression. • LZW: Lossless LZW compression. • DEFLATE: Lossless Deflate compression. • JPEG: Lossy JPEG compression. Compression 85%. The default is LZW, where applicable. JPEG compression is only supported if the input band is an RGB or RGBA colour band | FALSE | |
--create-tfw | If set, georeferencing information is also written to a TFW file. This allows using the resulting GeoTIFF in third‑party applications that do not read the georeferencing information embedded in the GeoTIFF file. | FALSE | ||
ExportRasterTo = PNG | ||||
--include-band | b | A string specifying the name of a band to include in the output. | FALSE | This must be specified explicitly. |
ExportRasterTo = JPEG | ||||
--include-band | b | A string specifying the name of a band to include in the output. | FALSE | This must be specified explicitly. |
ExportRasterTo = CSAR | ||||
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all bands in the output. | TRUE | At least one band must be specified. |
Example
To use this command refer to the following example.
Example | ||
Objective | You want to export a gridded surface to ESRI ASCII format. | |
Description | Command Line Syntax | |
The output format will be ESRI ASCII. | --output-format ESRI_ASCII | |
The Depth attribute of the source surface is to be exported. | --include-band Depth | |
The source surface is Surface.csar, located in the D:\BatchSample directory. | D:\BatchSample\Surface.csar | |
The resulting output will be created in the D:\BatchSample directory with the name ESRIASCII_Export.asc. | D:\BatchSample\ESRIASCII_Export.asc | |
Command Line |
| |
Outcome | The source surface is exported to the selected format according to the options specified. | |
Extra Notes | N/A | |