Description
The DifferenceCoverages process subtracts the difference file coverage specified in the options from the input coverage.
Inputs
A point cloud or raster surface in a supported format. Certain coordinate reference systems cannot be written out to CSAR, so BSB and HCRF formats are not supported. A BDB Server URI can be specified as input.
Outputs
A coverage in CSAR format. The coverage type will be determined by the type of the input.
Command Line Syntax
carisbatch --run DifferenceCoverages --difference-type <value> --input-band <value> --difference-file <value> [options] <input> <output>
User Interface Command
Difference Coverage
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--difference-type | d | A string specifying the type of coverage specified in the DifferenceFile. One of: • RASTER: Raster - A raster surface coverage • REFERENCEMODEL: Reference Model - A reference model coverage. This is only available with Engineering Analysis Module licensing. | FALSE | This must be specified explicitly. |
--input-band | i | A string specifying the name of the input band. | FALSE | This must be specified explicitly. |
--difference-file | D | A string specifying the path to the coverage containing the values to be subtracted. | FALSE | This must be specified explicitly. |
--comments | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | ||
DifferenceType = Raster | ||||
--difference-band | e | A string specifying the band name containing the values to be subtracted. | FALSE | This must be specified explicitly. |
DifferenceType = ReferenceModel | ||||
--template-name | n | A string specifying the name of a fully defined template in the reference model file. | FALSE | This must be specified explicitly. |
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to compare the differences between two overlapping coverages. | |
Description | Command Line Syntax | |
The difference type is RASTER. | --difference-type RASTER | |
The input band is Depth. | --input-band Depth | |
The difference file is area1.csar located at D:\BatchSample. | --difference-file D:\BatchSample\area1.csar | |
The difference band is Depth. | --difference-band Depth | |
The source raster surface, area2.csar, is located at D:\BatchSample. | D:\BatchSample\area2.csar | |
The output surface will be named DifferenceCoverages.csar and will be saved to D:\BatchSample. | D:\BatchSample\DifferenceCoverages.csar | |
Command Line |
| |
Outcome | A new difference surface is created. | |
Extra Notes | N/A | |