Description
The CombineToRaster process creates a new raster by computing the value in each raster cell using a logical operation executed over the points falling within each raster cell. The output raster is generated with user-specified geographic extents and resolution. This is done to either combine overlapping coverages or regenerate a coverage using different settings.
Inputs
One or more raster surfaces, point clouds and/or variable resolution surfaces. The locations can be specified by file paths or URIs.
Outputs
A raster surface in CSAR format. The location can be specified by a file path or a URI.
Command Line Syntax
carisbatch --run CombineToRaster --extent <value> --resolution <value> --output-crs <value> --contributor-attribute <value> [options] <inputs> <output>
User Interface Command
Combine Coverages
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--recompute-stats | s | If set, values in statistical bands present in the output are recomputed. The bands that are recomputed are Density, Mean, Standard Deviation, Shoal and Deep. | FALSE | |
--rule-file | U | The path to the CRFX file containing rules for conflict resolution. The CRFX file must be one created for deconfliction in the combine dialog box. Other CRFX files, such as ones to perform queries on a database, cannot be used for this purpose. | FALSE | |
--override-ambiguity | a | If set, the first input point that meets all criteria in the rules is selected to populate the output cell, even if there are unresolved conflicts. | FALSE | |
--confine-metadata-rules | f | A string specifying how to consider holes as valid data when applying metadata rules. One of: • POLYGON: Based on bounding polygon • HOLIDAY: Based on holiday band If not specified, holes are not considered as valid data when applying metadata rules. | FALSE | |
--recurse | u | If set, files that match the input description in any subfolders are also included. | FALSE | |
--use-cell-centres | n | If set, the input raster cell centre is used as the position for the input raster cell. If this option is specified, true position information in the input raster surfaces is ignored. | FALSE | |
--contributor-attribute | C | A string specifying an attribute value to be included in the Contributor layer. Supported attributes include: • uri • SurfaceResolution • VerticalCoordinateSystem • StartDate • EndDate • CreationDate • SoftwareName • SoftwareVersion • PlatformName • Comments The Contributor for each node is populated with a list of the local CSAR metadata values from the source that is selected to be copied to the output raster surface. If not specified, the default value is uri. | 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. |
--anchor | A | The point that defines the output raster anchor position. <LowerX> - A number and unit specifying the lower left X origin in the coordinate reference system of the output. <LowerY> - A number and unit specifying the lower left Y origin in the coordinate reference system of the output. The anchor position is a position in the centre of a cell. HALF_RES is used to calculate a coordinate position for a cell centre that is half the resolution offset from a multiple of the resolution, which creates cells that have their lower left corner at a multiple of the resolution. Typically, the usage in this context is --anchor HALF_RES HALF_RES. The default value is 0.0 0.0. | FALSE | |
--extent | E | The extents that define the window. <LowerX> - A number specifying the lower left X origin in the coordinate reference system of the output. <LowerY> - A number specifying the lower left Y origin in the coordinate reference system of the output. <UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output. <UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output. The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for unprojected data, an angle type unit is required. The order for unprojected coordinates is longitude followed by latitude. 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. |
--primary-band | m | A string specifying the name of the primary elevation band of the output. The default value is Depth. | FALSE | |
--map-band | A string specifying the band with values to be replaced and the band with replacement values. <Source Band> - The name of the band that, if it exists, replaces the destination band. <Destination Band> - The name of the band whose values are replaced if the source band exists. The source band is never created in the output raster as any values it has are used to populate the destination band. | FALSE | ||
--output-crs | c | A string specifying the horizontal coordinate reference system key of the output. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | This must be specified explicitly. |
--output-vertical-crs | o | A string specifying the vertical coordinate reference system key of the output. No vertical transformation will be applied even if a value is specified. This value is only used as metadata on the output dataset. | 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 combine two raster surfaces into a single raster surface. | |
Description | Command Line Syntax | |
The output coordinate system is UTM-19N. | --output-crs UTM-19N | |
The resolution of the output surface will be 10 metres. | --resolution 10m | |
The primary elevation band will be labelled Depth. | --primary-band Depth | |
Statistical layers will be recomputed. | --recompute-stats | |
The Contributor layer in the output needs to include the surface resolution and the URI of the input sources. | --contributor-attribute SurfaceResolution --contributor-attribute uri | |
The extents to be included are: • lower-left X: 676075.91 • lower-left Y: 5547040.53 • upper-right X: 691477.29 • upper-right Y: 5565051.44 | --extent 676075.91 5547040.53 691477.29 5565051.44 | |
The file, leastdepth.crfx, located at D:\BatchSample, will be used for conflict resolution. | --rule-file D:\BatchSample\leastdepth.crfx | |
The Override Ambiguity option will be used for conflicts that are not resolved by the rule file. | --override-ambiguity | |
The source surfaces to be combined are Surface1.csar and Surface2.csar located at D:\BatchSample. | D:\BatchSample\Surface1.csar D:\BatchSample\Surface2.csar | |
The output surface will be named Combined.csar, and saved to the same location as the source files. | D:\BatchSample\Combined.csar | |
Command Line |
| |
Outcome | A new, combined raster surface is created. | |
Extra Notes | N/A | |