Description
The FilterProcessedDepths process can be done by a Surface or Polygon. With Surface it uses an input surface and a scaled standard deviation or uncertainty threshold to reject HIPS data (HDCS soundings) that fall outside the specified threshold. You can also filter by a direct threshold amount. With Polygon it uses a polygon geometry to accept/reject HIPS data (HDCS soundings) that fall inside/outside the polygon.
Update
One or more HIPS track lines.
Outputs
Updated HIPS track lines.
Command Line Syntax
carisbatch --run FilterProcessedDepths [options] <update>
User Interface Command
Filter Processed Depths
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short key | Description | Can Repeat | Notes |
Common Options | ||||
--filter-type | The type of filtering to apply to the HDCS ProcessedDepths. • SURFACE: Surface - a csar surface that covers an area within the data • POLYGON: Polygon - a wkt geometry of a polygon boundary | |||
--protective-radius | A number specifying a protective radius around critical soundings to protect any neighbouring soundings within the sphere from being filtered. If not set, the default is to not filter. The valid range is 0 or greater. | FALSE | ||
--protective-radius-designated | If set, applies the radius to soundings flagged as Designated during filtering. Only applicable if ProtectiveRadius is set. | FALSE | ||
--protective-radius-examined | If set, applies the radius to soundings flagged as Examined during filtering. Only applicable if ProtectiveRadius is set. | FALSE | ||
--protective-radius-outstanding | If set, applies the radius to soundings flagged as Outstanding during filtering. Only applicable if ProtectiveRadius is set. | FALSE | ||
FilterType = SURFACE Options | ||||
--surface | The path to the surface used to calculate the threshold. The default elevation band will be used. | FALSE | ||
--include-rejected | If set, includes data that was previously rejected by this filter. | FALSE | ||
--threshold-type | A string specifying the Threshold Type according to the surface used as input. If the Surface has standard deviation/uncertainty, set to a scaled standard deviation or uncertainty threshold, otherwise a direct threshold amount can be used for any surface. This setting will reject all soundings that fall outside the specified threshold. One of: • STANDARD_DEVIATION: Standard Deviation • UNCERTAINTY: Uncertainty • GREATER: Greater of Uncertainty and Standard Deviation • LESSER: Lesser of Uncertainty and Standard Deviation • STATIC_VALUE: Static Value | FALSE | ||
--threshold | Value to use when specifying the scalar or static value to apply as a threshold in the filter. One of: • <Scalar> - scalar value to apply to the standard deviation • <StaticValue> - A number specifying the static threshold value to apply in the filter Scalar is used when ThresholdType is not set to STATIC_VALUE. For the StaticValue, supported units are: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--reject-no-data-soundings | If set, rejects soundings that are offset from the surface. | FALSE | ||
FilterType = POLYGON Options | ||||
--geometry | G | The geometry with its coordinate reference system. <WKT> - A string specifying the shape of the geometry. <CRS> - A string specifying the horizontal coordinate reference system key of the geometry. The geometry can be composed of one or more polygons that contain one or more holes. The geometry must be specified as a WKT string. | FALSE | The geometry must be specified as a WKT string. |
--extract-type | g | A string specifying the area for the filtering to be performed. • INCLUSIVE: Inclusive - Filter all data inside the geometry, including data that touches the geometry. • EXCLUSIVE: Exclusive - Filter all data outside the geometry. The default value is INCLUSIVE. | FALSE | |
--accept-data | If set, set filter logic to accept data, otherwise all filtered data will be rejected. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
|---|---|---|
Objective | To reject soundings in a surface that fall outside a specified standard deviation or uncertainty threshold, or by a direct threshold amount. A polygon can be used to define the area of the surface to accept or reject soundings) that fall inside/outside the polygon. | |
Description | Command Line Syntax | |
The filtering of processed depths will be applied to a surface. | --filter-type SURFACE | |
Either the uncertainty or standard deviation value will be used, whichever is greater. | --threshold-type GREATER | |
The threshold value of 2.0 multiplies either the uncertainty or standard deviation value, which ever is greater, to arrive at a filter value. | --threshold-value 2.0 | |
The surface to be filtered is named C:\surface.csar and is located at C:\temp\input\. The HIPS file URI filters for the vessel named “sample” and the day 2000-001. | --surface C:\surface.csar | |
Command Line |
| |
Outcome | The filtered surface is updated. | |
Extra Notes | N/A | |