Description
The CreateHIPSGrid process creates a raster surface using a HIPS gridding method.
Inputs
One or more HIPS track lines.
Outputs
A raster surface in CSAR format.
Command Line Syntax
carisbatch --run CreateHIPSGrid --gridding-method <value> [options]
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--gridding-method | g | The gridding method used to generate the output raster. • SHOAL_TRUE: Shoalest Depth True Position - Shoalest depth with true positions • SWATH_ANGLE: Swath Angle - Beam geometry weighting • UNCERTAINTY: Uncertainty - TPU weighting • CUBE: CUBE - CUBE algorithm | FALSE | This must be specified explicitly. |
--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 explicitly specified. |
--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. | FALSE | This must be explicitly specified. |
--output-crs | c | A string specifying the horizontal coordinate reference system key of the output. | FALSE | This must be explicitly specified. |
--output-vertical-crs | o | A string specifying the vertical coordinate reference system key of the output. | FALSE | |
--primary-band | m | A string specifying the name given to the primary band of the output. The default value is Depth. | FALSE | |
--compute-band | a | A string specifying an output band to be computed from the input points. One of: • SHOAL: Shoal - Shoalest of all values that contributed to populating the cell • DEEP: Deep - Deepest of all values that contributed to populating the cell • DENSITY: Density - Number of points that contributed to populating the cell • MEAN: Mean - Mean of all values that contributed to populating the cell • STD_DEV: Standard deviation - Standard deviation of all values that contributed to populating the cell | TRUE | |
--polygon-type | Y | A string specifying the type of bounding polygon to generate. • CONVEX: The convex hull of the data is used for the polygon. • BUFFERED: A simplified buffered boundary is used for the polygon. The default value is BUFFERED. | FALSE | |
--comments | C | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | |
--include-flag | A string specifying a status flag to be included for the operation. One of: • 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. | |
--keep-up-to-date | U | If set, disables Keep Up to Date setting. | FALSE | |
GriddingMethod = SHOAL_TRUE Options | ||||
--vertical-uncertainty | T | If set, carries over the Depth TPU of the selected shoal value. | FALSE | |
--horizontal-uncertainty | t | If set, carries over the Horizontal TPU of the selected shoal value. | FALSE | |
--compute-median | I | If set, computes a Median band from the input points. | FALSE | |
GriddingMethod = SWATH_ANGLE Options | ||||
--max-footprint | X | A number specifying the maximum area in which a sounding can be applied to the surface. The default value is 9. Value is set in resolution units. | FALSE | |
--grazing-angle-file | G | The path to the Grazing Angle Weights file. The defaults is to use the system table if not defined. | FALSE | |
--grazing-angle-table | A string encoding a set of Grazing Angle Weights. The default value is to apply full weight from 90 to 75 degrees, 0.01 weight at 15 degrees and 0 weight at 0 degrees. If set, the value overrides the GrazingAngleFile. | FALSE | Default: full weight from 90 to 75 degrees, weight = 0.01 at 15 degrees, and weight = 0 at 0 degrees. If explicitly provided, overrides GrazingAngleFile, and will be set in lineage from table used. | |
GriddingMethod = UNCERTAINTY Options | ||||
--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 | ||
GriddingMethod = CUBE Options | ||||
--iho-order | e | 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: Density - Disambiguate by number of samples. • LOCALE: Locale - Disambiguate by surrounding nodes. • DENSITY_LOCALE: Density and Locale - Disambiguate by a combination of sample count and surrounding nodes. The default value is DENSITY_LOCALE. | FALSE | ||
--cube-config-file | The path to a file specifying the XML document containing CUBE configuration parameters. | FALSE | ||
--cube-config-name | A string specifying the name of the CUBE configuration to be used from the CUBE configuration parameters. | FALSE | ||
--cube-config-settings | A XML string encoding a set of CUBE configuration parameters. If set, overrides the values set in CubeConfigFile and CubeConfigName. | FALSE | ||