Description
The CreateVRSurface process creates an empty variable resolution CSAR file, setting extents and resolutions based on provided source data.
Inputs
Source points in a point cloud or raster surface in CSAR format, or one or more HIPS track lines.
Outputs
An empty variable resolution CSAR file with a valid resolution map.
Command Line Syntax
carisbatch --run CreateVRSurface --estimation-method <value> --include-flag <value> [options] <inputs> <output>
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
|
--estimation-method | e | Method used to estimate tile resolutions. One of: • CALDER_RICE: Estimate resolution based on point density and coverage area. • CARIS_DENSITY: Estimate resolution based on point density and distribution. • RANGE: Assign resolutions based on a list of value ranges and associated resolution. | FALSE | This must be specified explicitly. |
--extent | E | The extents that defines 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. If not set, the extents are computed from input data. | FALSE | |
--keep-partial-bins | If set, keeps estimated resolution values instead of adjusting to give an exact gridding of resolution tiles. If not set, the default is to adjust resolution estimates by an exact gridding per tile. | FALSE | ||
--max-grid-size | A number specifying the upper limit for the number of rows/columns each resolution tile can support. The default value is 64. The valid range is 4 to 256. The value must be larger than the MinGridSize. | FALSE | ||
--min-grid-size | A number specifying the lower limit for the number of rows/columns each resolution tile can support. The default value is 4. The valid range is 4 to 256. The value must be smaller than the MaxGridSize. | FALSE | ||
--output-crs | c | A string specifying the horizontal coordinate reference system key of the output. If not set, the default is to use the reference system of the first source. 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 | |
--output-vertical-crs | A string specifying the vertical coordinate reference system key of the input. No vertical transformation will be applied even if a value is specified. This value is only used as metadata on the output dataset. The default value is Unknown. | 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. | |
EstimationMethod = CALDER_RICE Options | ||||
--area | The method used to estimate tile coverage area from a set of soundings. One of: • SOUNDING: Use an area estimate aggregated from individual sounding depths • SWATH: Use an area estimate based on multibeam swath coverage and mean depth • ELLIPTICAL: Use elliptical fitting to approximate the area of coverage • BOX: Use the bounding box of the soundings in each tile The default value is SOUNDING. SWATH is only available on point clouds imported from HDCS. | FALSE | ||
--finest-resolution | A number specifying the smallest spacing between nodes. The default value is 0.01 m. The valid range is 0 or greater. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
-coarsest-resolution | A number specifying the largest spacing between nodes. The default value is 1000 m. The valid range is a value greater than FinestResolution. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--supergrid-size | A number specifying the initial size of resolution tiles. The default value is 32.0 m. The valid range is greater than 2 times the FinestResolution. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--points-per-cell | A number specifying the target number of points per cell to use for resolution estimation. The default value is 20. The valid range is 2 to 1024. | FALSE | ||
--beam-width | A number specifying the assumed width of a beam. The default value is 1.0 deg. The valid range is 0 to 90 (non-inclusive). Supported units: degrees. The value is used to compute area estimates when using SOUNDING and SWATH methods. It is ignored by ELLIPTICAL and BOX area estimates. Supported units: deg and rad. | FALSE | ||
EstimationMethod = CARIS_Density Options | ||||
--finest-resolution | A number specifying the smallest spacing between nodes. The default value is 0.01 m. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--coarsest-resolution | A number specifying the largest spacing between nodes. The default value is 1000 m. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--points-per-cell | A number specifying the target number of points per cell to use for resolution estimation The default value is 20. | FALSE | ||
EstimationMethod = RANGE Options | ||||
--input-band | i | A string specifying the name of the input band. The value must exist in the first input source. If not, the primary elevation band of the first input source is used. | FALSE | |
--range-file | The path to a file specifying the value ranges and associated resolutions. If no values are provided for RangeTable, this file will be used to populate the range option. Values are read as meters. | FALSE | ||
--range-table | A pair of values describing an entry in the range table. <Minimum> - Smallest value of the range being described. <Resolution> - Resolution (in meters) to use at the specified range. If any ranges are specified, RangeFile will be ignored. Depth values must be provided as negative heights. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | TRUE | ||
--range-method | The method used to classify a tile of points as belonging to a range. One of: • MEAN: Use range containing the average value of the tile • MODE: Use range with the highest number of values in the tile. • PERCENTILE: Use the range containing a specific percentile of the data from minimum value to maximum value. The default value is PERCENTILE. | FALSE | ||
--range-percentile | The percentile of data within a resolution tile, from minimum to maximum, that will be used to select a range. The default value is 50. The valid range is 0 to 100. This option will only be used if RangeMethod is set to PERCENTILE. | FALSE | ||
Example: Calder Rice Estimation Method
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | To setup a variable resolution coverage suitable to store some near-shore with shallow depth and greater data density some offshore with greater depth and lower data density | |
Description | Command Line Syntax | |
The estimation method for determining tile resolution is CALDER_RICE. | --estimation-method CALDER_RICE | |
The output coordinate reference system is WG84 | --output-crs WG84 | |
The area estimation method being used is SOUNDING. | --area SOUNDING | |
The finest resolution is 0.01m | --finest-resolution 0.01m | |
The coarsest resolution is 500m | --coarsest-resolution 500m | |
The supergrid size is 15m | --supergrid-size 15m | |
The number of points per cell to use for resolution estimation is 5. | --points-per-cell 5 | |
The width of the beam is 4.3 deg. | --beam-width 4.3deg | |
The input file is named SourceSurface.csar and located at D:\BatchSample. | D:\BatchSample\SourceSurface.csar | |
The output file will be named CreateVR.csar | D:\BatchSample\CreateVR.csar | |
Command Line |
| |
Outcome | An empty variable resolution surface, with the desired extents and resolution, is created. | |
Notes | N/A | |
Example: Range Estimation Method
To use this command refer to the following example.
Example | ||
|---|---|---|
Objective | To create an empty variable resolution surface using a list of value ranges and associated resolutions. | |
Description | Command Line Syntax | |
The estimation method for determining tile resolution is RANGE. | --estimation-method RANGE | |
The output coordinate reference system is WG84 | --output-crs WG84 | |
The ranges and their resolutions are: • Depths 0m-49m have a resolution of 1m. • Depths 50m-99m have a resolution of 2.5m. • Depths 100m and greater have a resolution of 5m. | --range-table 0m 1m --range-table 50m 2.5m --range-table 100m 5m | |
The Percentile method will be used for range estimation. | --range-method PERCENTILE | |
The range percentile to be used is 50. | --range-percentile 50 | |
The input file is named SourceSurface.csar and located at D:\BatchSample. | D:\BatchSample\SourceSurface.csar | |
The output file will be named CreateVR.csar | D:\BatchSample\CreateVR.csar | |
Command Line |
| |
Outcome | An empty variable resolution surface, with the desired extents and resolution, is created. | |
Notes | N/A | |