Description
The DetectHIPSCriticalSoundings process uses an input raster to contour in-memory and determine the Shoalest/Deepest soundings from a HIPS data source within the isolations. Depending on the options used, each or both can be flagged as critical soundings in the HIPS data.
Update
One or more HIPS track lines.
Outputs
Updated HIPS track lines and project file.
Command Line Syntax
carisbatch --run DetectHIPSCriticalSoundings
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--surface | The path to the surface used to calculate the threshold. The default elevation band will be used. | FALSE | This must be specified explicitly. | |
--input-band | i | A string specifying the name of the input band. | This must be specified explicitly. | |
--output-shoal-status | The type of Shoal sounding status. • NONE: (None) - No Shoal status set. • DESIGNATED: Designated - Status for soundings considered of special significance. • OUTSTANDING: Outstanding - Status for soundings considered for further investigation. • EXAMINED: Examined - Status for soundings considered investigated. The default value is DESIGNATED. | FALSE | ||
--output-deep-status | A type of Deep sounding status. • NONE: (None) - No Deep status set. • DESIGNATED: Designated - Status for soundings considered of special significance. • OUTSTANDING: Outstanding - Status for soundings considered for further investigation. • EXAMINED: Examined - Status for soundings considered investigated. The default value is OUTSTANDING. | FALSE | ||
--shoal-attributes | Name/value pairs representing non-system attributes to be set on the detected Shoals. | TRUE | ||
--deep-attributes | Name/value pairs representing non-system attributes to be set on the detected Deeps. | TRUE | ||
--contour-interval-type | The method used to contour. • HALF_RESOLUTION: Half Source Resolution - The interval is a value equal to half the resolution of the selected surface. • USER_INTERVAL: User-defined Value - Applies a set value to use as the contour interval. • LEVELS_FILE: Levels File - Applies a depth list file. The default value is HALF_RESOLUTION. | FALSE | ||
--max-isolations | Maximum number of isolations allowed to be processed. The default value is 100000. | FALSE | ||
--radius-filter | The type of radius filter to apply. • NONE: (None) - No filter applied. • RADIUS_VALUE: Distance - The filter radius. • RADIUS_TABLE: Table File - The filter table file containing minimum/maximum depth range with applicable radius. The default value is NONE. | FALSE | ||
ContourIntervalType = USER_INTERVAL Options | ||||
--interval | A number specifying a fixed value to use as the contour interval. When ContourIntervalType is set to USER_INTERVAL, Interval must be set. | FALSE | ||
ContourIntervalType = LEVELS_FILE Options | ||||
--contour-levels-file | A string specifying the name of a depth list file containing the contour interval/depth pairs. When ContourIntervalType is set to LEVELS_FILE, ContourLevelsFile must be set. | FALSE | ||
RadiusFilter = RADIUS_VALUE Options | ||||
--radius-value | A number specifying a fixed value to use as the filter radius. When RadiusFilter is set to RADIUS_VALUE, RadiusValue must be set | FALSE | ||
RadiusFilter = RADIUS_TABLE Options | ||||
--radius-table-file | A string specifying the name of a radius table file containing the minimum/maximum depth range/radius pairs. When RadiusFilter is set to RADIUS_TABLE, RadiusTableFile must be set. | FALSE | ||