Description
The CalculateCoverageVolumes process compares elevation data in a coverage with a model to determine the volume of the difference between them.
Inputs
A point cloud or raster surface in a supported format. A BDB Server URI can be specified as input.
Outputs
A volume results XML file.
Command Line Syntax
carisbatch --run CalculateCoverageVolumes
User Interface Command
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--calculation-type | y | The type of calculation. One of: • HYPERBOLIC: Hyperbolic - Calculate based on a smooth model of the terrain with hyperbolic paraboloids modelling each set of four points. • RECTANGULAR: Rectangular - Calculate based on a stepped model of the terrain with a rectangular prism representing each node. Hyperbolic and rectangular volume calculations can only be used for raster surface inputs. | FALSE | This must be specified explicitly. |
--model-type | m | The type of model. One of: • FILE: File - A reference model file • PLANE: Plane - A single horizontal plane Options specific to each model type are specified below. | FALSE | This must be specified explicitly. |
--input-band | i | A string specifying the name of the input band. This band must contain elevation values. | FALSE | This must be specified explicitly. |
--allowance-algorithm | g | A string specifying the allowance algorithm. One of: • NONE: None - No allowance calculation is performed. • ALL_TERRAIN: All - The volume of the terrain between a plane at the specified elevation and a plane at an elevation of elevation-allowance is calculated. • WHERE_ABOVE: Above - The volume of the terrain between a plane at the specified elevation and a plane at an elevation of elevation-allowance is calculated, but only where the terrain is above the specified elevation. • FULL: Full - The volume between a plane at the specified elevation and a plane at an elevation of elevation-allowance is calculated. The default value is NONE. | FALSE | |
ModelType = File Options | ||||
--model-file | d | A path to a reference model file. CARIS reference models and LandXML reference models are supported. | FALSE | This must be specified explicitly. |
--template-name | n | A string specifying the name of a fully defined template in the reference model file. None of the specified templates or surfaces are allowed to overlap. This ensures that the total volume reported does not double-count any areas. | TRUE | At least one template or surface must be specified. |
--surface-name | s | A string specifying the name of a fully defined surface in the reference model file. None of the specified templates or surfaces are allowed to overlap. This ensures that the total volume reported does not double-count any areas | TRUE | At least one template or surface must be specified. |
ModelType = Plane Options | ||||
--elevation | V | A number and unit specifying the elevation of the horizontal plane. All values representing elevations are entered using the convention that up is positive. The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, and yd. | FALSE | This must be specified explicitly. |
--allowance-value | a | A number and unit specifying the size of the allowance below the plane. The allowance must be a positive number, or 0. The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, and yd. The default value is 0.0m. | FALSE | |
Example
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | You want to compare the volume difference between a coverage and a reference model. | |
Description | Command Line Syntax | |
The calculation type is HYPERBOLIC. | --calculation-type HYPERBOLIC | |
A reference model file will be used. | --model-type FILE | |
The model file is named ReferenceModel.xml and is located at D:\BatchSample. | --model-file D:\BatchSample\ReferenceModel.xml | |
The reference model template to use for the calculation is Template1N. | --template-name Template1N | |
The reference model surface to use for the calculation is Surface1. | --surface-name Surface1 | |
The input band is Depth. | --input-band Depth | |
The input file is named RasterSurface.csar and located at D:\BatchSample. | D:\BatchSample\RasterSurface.csar | |
The output file is named VolumeResults.xml and location at D:\BatchSample. | D:\BatchSample\VolumeResults.xml | |
Command Line |
| |
Outcome | An XML file containing the volume results is created. | |
Extra Notes | The results file can be opened in the application and exported to a text file or as a publication using a custom template, if needed. | |