Description
The ServerCombineToRaster 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 in a database. The input can be specified by object BOIDs and/or CRFX query files.
Outputs
A raster surface in CSAR format. The location can be specified by a file path or a URI.
Command Line Syntax
carisbatch --run ServerCombineToRaster --extent <value> --output-crs <value> --resolution <value> --contributor-attribute <value> --login <value> --database-name <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
|
--database-name | D | The name of the database server instance containing the inputs. All input raster surfaces, point clouds, and variable resolution surfaces must be in the specified database. | FALSE | This must be specified explicitly. |
--login | L | The node manager login credentials. Specified as either username/password or username/password@hostname. Omitting @hostname is equivalent to using @localhost. | FALSE | This must be specified explicitly. |
--recompute-stats | s | If set, statistical bands in the output surface 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 rules in the combine dialog. Other CRFX files, such as ones to perform queries on a database, cannot be used for this purpose. | FALSE | This must be specified explicitly. |
--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 | |
--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. The Contributor for each node is populated with a list of the object attribute values from the source that is selected to be copied to the output raster surface. The default value is boid. | 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 database surfaces, with specified geographic extents, into a new CSAR raster. | |
Description | Command Line Syntax | |
The user name and password to access the database on the local machine is the default user account. | --login dba/sql@localhost | |
The source surfaces are located on the Database2 database. | --database-name Database2 | |
No-data areas in Holidays bands will be preserved in the output surface if the surface containing the holidays is determined to be the winner during conflict resolution. | --confine-metadata-rules HOLIDAY | |
The extents to be included in the new surface are: lower-left X: 418449.0 lower-left Y: 5579149.5 upper-right X: 418849.0 upper-right Y: 5579549.5 | --extent 418449.0 5579149.5 418849.0 5579549.5 | |
The resolution of the output surface will be 20 metres. | --resolution 20m | |
The output coordinate system will be UTM-30N. | --output-crs UTM-30N | |
The Contributor layer of the output surface will include the feature object ID (BOID), object name (OBJNAM) and source date (SORDAT) attributes. | --contributor-attribute BOID --contributor-attribute OBJNAM ‑‑contributor-attribute SORDAT | |
The servercombinerules2.crfx rule file, located at D:\BatchSample, will be used to select winning nodes. | --rule-file D:\BatchSample\servercombinerules2.crfx | |
The override ambiguity option will be used for other conflicts. | --override-ambiguity | |
The raster surfaces to be combined are called Surface1 and Surface2. The object BOID for each surface is 02000001 and 02000002, respectively. | 02000001 02000002 | |
The resulting CSAR file, named Database_Combined.csar, will be saved to the D:\BatchSample folder. | D:\BatchSample\Database_Combined.csar | |
Command Line |
| |
Outcome | The surfaces matching the criteria in the input rule file are combined into a single surface and saved to the local machine. | |
Notes | N/A | |