Description
The PopulateVRSurface process populates an empty variable resolution csar file with values to treat as a variable resolution surface, or with interpolated nodes based on one or more sources. Several node creation options are available.
Update
An empty variable resolution surface with a valid resolution map.
Inputs
Source points in a point cloud or raster surface in CSAR format or one or more HIPS track lines.
Outputs
An updated variable resolution surface based on the input variable resolution surface in CSAR format.
Command Line Syntax
carisbatch --run PopulateVRSurface --population-method <value> --include-flag <value> [options] <inputs> <update>
User Interface Command
New Variable Resolution Surface
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes
|
--population-method | P | The method used to populate nodes for surface creation. One of: • USE_ORIGINAL: Keep the original source points with no re-sampling • MEAN: Interpolate points using simple mean • IDW: Interpolate points using inverse distance weighting • UNCERTAINTY: Interpolate points using TPU weighted mean • CUBE: Generate hypotheses using CUBE algorithms • SELECT: Sample the shoalest or deepest point per bin • SWATH_ANGLE: Interpolate points using Swath Angle weighting | FALSE | This must be specified explicitly. |
--input-band | i | A string specifying the name of the input band. If not set, the primary elevation band of the source will be used. | FALSE | |
--include-flag | A string specifying a status flag to be included for the operation. • ACCEPTED: Accepted status flag • EXAMINED: Examined status flag • OUTSTANDING: Outstanding status flag • REJECTED: Rejected status flag • SUPPRESSED: Suppressed status flag | TRUE | This must be explicitly specified. | |
--primary-band | m | A string specifying the name given to the primary band of the output. The default value is Depth. | FALSE | |
--keep-up-to-date | If set, enables the Keep Up to Date setting. | FALSE | ||
--comments | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | ||
PopulationMethod = MEAN Options | ||||
--neighbourhood-shape | The shape of the neighbourhood used to compute the points in the variable resolution surface. One of: • SQUARE: Use grid-aligned neighbourhoods • CIRCLE: Use radius-based neighbourhoods The default value is SQUARE. | FALSE | ||
--neighbourhood-fixed | The fixed size component, as a distance, of the neighbourhood used to compute the points in the variable resolution surface. This option can be combined with NeighbourhoodBins. The default value is 0.0. The value can be any positive number. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd. | FALSE | ||
--neighbourhood-bins | The bin-size component, as a radius based on a number of bins, of the neighbourhood used to compute the points in the variable resolution surface. This option can be combined with NeighbourhoodFixed. The default value is 1. The value can be any positive number. | FALSE | ||
--minimum-samples | A number specifying the minimum samples for an interpolation node to be considered valid. The default value is 1. The value can be any positive number. | FALSE | ||
PopulationMethod = IDW Options | ||||
--neighbourhood-shape | The shape of the neighbourhood used to compute the points in the VR surface. One of: • SQUARE: Use grid-aligned neighbourhoods. • CIRCLE: Use radius-based neighbourhoods. The default value is SQUARE. | FALSE | ||
--neighbourhood-fixed | The fixed size component, as a distance, of the neighbourhood used to compute the points in the variable resolution surface. This option can be combined with NeighbourhoodBins. The default value is 0.0. The value can be any positive number. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd. | FALSE | ||
--neighbourhood-bins | The bin-size component, as a radius based on a number of bins, of the neighbourhood used to compute the points in the variable resolution surface. This option can be combined with NeighbourhoodFixed. The default value is 1. The value can be any positive number. | FALSE | ||
--idw-power | A number specifying the exponent to use for inverse distance weighting. The default value is 1.0. The value can be any positive number. | FALSE | ||
--minimum-samples | A number specifying the minimum samples for an interpolation node to be considered valid. The default value is 1. The value can be any positive number. | FALSE | ||
PopulationMethod = UNCERTAINTY Options | ||||
--vertical-uncertainty | The name of the band containing vertical uncertainty data for source points. If not set, the default is to estimate vertical uncertainty from depth using the IHO parameters. If set, the value must be a valid band. | FALSE | ||
--horizontal-uncertainty | The name of the band containing horizontal uncertainty data for source points. If not set, the default is to ignore horizontal uncertainty. | FALSE | ||
--iho-order | The IHO S-44 Order to apply. • S44_SPECIAL: Predefined S-44 horizontal and vertical error limits for Special Survey Order • S44_1A: Predefined S-44 horizontal and vertical error limits for 1a Survey Order • S44_1B: Predefined S-44 horizontal and vertical error limits for 1b Survey Order • S44_2: Predefined S-44 horizontal and vertical error limits for 2 Survey Order • S44_USER: User defined horizontal and vertical error limits (a,b,horizontal distance limit of depth, horizontal percentage of depth) If not set, the default is S44_USER, which requires IHOLimits and IHOHorzDistLimits to be set. | FALSE | ||
--iho-limits | The IHO S-44 Order 'a' and 'b' error values to be used if user defined is chosen. <a value> - Constant error <b value> - Depth dependent error Only applicable if IHO Order is not set or set to S44_USER. | FALSE | ||
--minimum-samples | A number specifying the minimum samples for an interpolation node to be considered valid. The default value is 1. The value can be any positive number. | FALSE | ||
PopulationMethod = CUBE Options | ||||
--vertical-uncertainty | The name of the band containing vertical uncertainty data for source points. If not set, the default is to estimate vertical uncertainty from depth using the IHO parameters. | FALSE | ||
--horizontal-uncertainty | The name of the band containing horizontal uncertainty data for source points. If not set, the default is to ignore horizontal uncertainty. | FALSE | ||
--iho-order | The IHO S-44 Order to apply. • S44_SPECIAL: Predefined S-44 horizontal and vertical error limits for Special Survey Order • S44_1A: Predefined S-44 horizontal and vertical error limits for 1a Survey Order • S44_1B: Predefined S-44 horizontal and vertical error limits for 1b Survey Order • S44_2: Predefined S-44 horizontal and vertical error limits for 2 Survey Order • S44_USER: User defined horizontal and vertical error limits (a,b,horizontal distance limit of depth, horizontal percentage of depth) If not set, the default is S44_USER, which requires IHOLimits and IHOHorzDistLimits to be set. | FALSE | ||
--iho-limits | The IHO S-44 Order 'a' and 'b' error values to be used if user defined is chosen. <a value> - Constant error <b value> - Depth dependent error Only applicable if IHO Order is not set or set to S44_USER. | FALSE | ||
--disambiguation-method | The method used to select a hypothesis from a set. One of: • DENSITY: Disambiguate by number of samples. • LOCALE: Disambiguate by surrounding nodes. • DENSITY_LOCALE: Disambiguate by a combination of sample count and surrounding nodes. | FALSE | This must be specified explicitly. | |
--cube-config-file | The path to a file specifying the XML document containing CUBE configuration parameters. | FALSE | ||
--cube-config-name | The name of the CUBE configuration to use. This must be set if CubeConfigFile is set. | FALSE | ||
--cube-config-settings | A string encoding a set of CUBE configuration parameters. If set, this overrides the values set in CubeConfigFile and CubeConfigName. | FALSE | ||
--use-chgf-distance | If set, uses the Chebyshev approximation of the Confluent Hypergeometric Function for mean propagation distance of soundings to nodes. If set, the HorizUncert must be set. If not set, the default is to use the horizontal uncertainty propagation in CUBE parameters. This function improves hypothesis generation over slopes and steep features. | FALSE | ||
PopulationMethod = SELECT Options | ||||
--bin-selection | The sounding to select from all soundings in a resolution bin. One of: • SHOAL: Use shoalest point per bin. • DEEP: Use deepest point per bin. The default value is SHOAL. | FALSE | ||
--node-position | The type of position to use for selected soundings. One of: • ORIGINAL: Use the original location of the selected sounding. • CENTER: Use the center of the resolution bin. The default value is ORIGINAL. | FALSE | ||
--include-band | b | A string specifying the name of a band to include in the output. | TRUE | |
--minimum-samples | A number specifying the minimum samples for an interpolation node to be considered valid. The default value is 1. The valid range is 0 or greater. | FALSE | ||
PopulationMethod = SWATH_ANGLE Options | ||||
--angle-band | The name of the band containing beam angle data for source points. If not set, the default is to assume all points are vertical. | FALSE | ||
--footprint-band | The name of the band containing footprint radius data for source points. If not set, the default is to use an approximate radius from BeamWidth. | FALSE | ||
--beam-width | A number specifying the approximate width of a sonar beam. Used as a fallback if footprint radius data is not available. The default value is 1.0 degree. The valid range is 0 to 90 (non-inclusive). Supported units: degrees. | |||
--max-footprint | A number specifying the upper bound on footprint radius. Measured in multiples of tile resolution. The default value is 3. The value can be any positive number. | FALSE | ||
--grazing-angle-file | The path to the Grazing Angle Weights file. A file is mandatory if and only if no values are set for GrazingAngleTable. The supplied file will be used to populate the GrazingAngleTable setting in the lineage. | FALSE | ||
--grazing-angle-table | A pair of values describing an entry in the grazing angle weight table. <Angle> - Angle in degrees of a specific weight. <Weight> - Statistical weight of the specified angle. If any entries are specified, GrazingAngleFile will be ignored. Angles in between specified entries will be interpolated. Valid weights are between 0 and 1 inclusive. | TRUE | ||
--minimum-samples | A number specifying the minimum samples for an interpolation node to be considered valid. The default value is 1. The value can be any positive number. | FALSE | ||
To use this command refer to the following examples.
Example: CUBE Population Method
Example | ||
|---|---|---|
Objective | You want to populate an empty variable resolution map using the CUBE method. | |
Description | Command Line Syntax | |
The population method is CUBE. | --population-method CUBE | |
The Density and Locale disambiguation method is being used. | --disambiguation-method DENSITY_AND_LOCALE | |
The IHO Order being used is S44_1A. | --iho-order S44_1A | |
The trackline data with which to populate the VR map is: file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001. | file:///D:/BatchSample/input/input.hips?Vessel=sample;Day=2000-001 | |
The variable resolution map is named VRSurface.csar and is located at D:\BatchSample. | D:\BatchSample\VRSurface.csar | |
Command Line |
| |
Outcome | The source data is added to the variable resolution map to create a variable resolution surface. | |
Extra Notes | N/A | |
Example: MEAN Population Method
Example | ||
|---|---|---|
Objective | You want to populate an empty variable resolution map using the MEAN population method. | |
Description | Command Line Syntax | |
The population method is MEAN. | --population-method MEAN | |
The neighbourhood shape used to compute the points in the VR is CIRCLE. | --neighbourhood-shape CIRCLE | |
The variable resolution map is named VRSurface.csar and is located at D:\BatchSample. | D:\BatchSample\VRSurface.csar | |
The input source file containing the points to populate the VR is SourcePoints.csar and is located at D:\BatchSample. | D:\BatchSample\SourcePoints.csar | |
Command Line |
| |
Outcome | The source data is added to the variable resolution map to create a variable resolution surface. | |
Extra Notes | N/A | |