Parameter

Long

Short key

Description

Can Repeat

Notes

Common Options

--bathymetry-type

Choose the type of bathymetry to filter.

• SWATH: Swath - Multibeam, swath interfereometric, Lidar, Laser Scanner systems fall under swath.

• SINGLEBEAM: Single beam - Single beam data has one beam per profile always.

FALSE

This must be specified explicitly.

--accept-data

If set, set filter logic to accept data, otherwise all filtered data will be rejected.

FALSE

--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

--iho-order

A string specifying the name of a filter applied to soundings according to S-44 5th Edition Survey Orders or S-57 CATZOC Zones of Confidence.

• 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)

• S57_A1: Predefined S-57 CATZOC horizontal and vertical error limits for A1 Zone of Confidence

• S57_A2: Predefined S-57 CATZOC horizontal and vertical error limits for A2 Zone of Confidence

• S57_B: Predefined S-57 CATZOC horizontal and vertical error limits for B Zone of Confidence

• S57_C: Predefined S-57 CATZOC horizontal and vertical error limits for C Zone of Confidence

• S57_USER: User defined horizontal and vertical error limits (a, b, horizontal distance limit of depth)

FALSE

--iho-limits

A

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

This is only applicable if IHO Order is not set or is set to S44_USER.

This is also applicable if S57_USER is set for IHO Order.

FALSE

--iho-horizontal-distance-limits

The IHO S-44 Order position limits to be used if user defined is chosen.

<DistanceValue> - Position limit of the depth dependent error

<%Value> - Percentage of depth used to calculate horizontal error

This is only applicable if S44_USER is set for IHO Order.% value does not apply to S-57 Zones of Confidence.

FALSE

--filter

f

Filter the depth values to a min/max range. Valid values are +/- 15000.

<Minimum> - Filter the minimum values in the ObservedDepths.

<Maximum> - Filter the maximum values in the ObservedDepths.

The valid range is +/- 15000.

BathymetryType = SWATH Options

--b2b-slope-across-track-angle

A number that, for each beam on the same swath, calculates the slopes in degrees to the prior and post beams. If both slopes exceed the defined value and are of opposite sign, then it filters the beam.

If not set, the default is to not filter.

FALSE

--b2b-slope-include-rejected

If set, includes previously rejected soundings when recalculating the slopes during multiple runs of the filter.

FALSE

--across-track-distance

Any soundings beyond the specified distance from nadir will be filtered.

<Port> - The port side distance from nadir.

<Starboard> - The starboard side distance from nadir.

If not set, the default is to not filter. The valid range is 0 or greater. Supported units: metres.

FALSE

--across-track-distance-multiplier

Any soundings with an across track distance, from the centre beam, greater than the nadir depth times this number (e.g,. 3.0) are filtered. For example, in 30 metres of water, with a setting of 3.0, all soundings with an across track distance greater than 90.0 metres are filtered.

If not set, the default is to not filter. The valid range is 0 or greater. Supported units: metres.

FALSE

--beam-numbers

A string specifying beams to be rejected. Separate individual beams with a space and specify a range of beams with a hyphen. For example, entering 12 32 56-60 72 rejects beams 12, 32, 56, 57, 58, 59, 60, and 72.

If not set, the default is to not filter.

Values are provided as a list or a range.

FALSE

--nadir-angle

A number specifying the starboard beams that are outside of the designated angles (e.g., 60 degrees). Angles are computed from the nadir using depths and across track distances (roll corrected).

<Port> - The port side angle from nadir.

<Starboard> - The starboard side angle from nadir.

The valid min/max angles allowed are 0/180. If not set, the default is to not filter.

FALSE

--reject-quality

Rejects bathymetry with the numbered quality flag.

Valid values are 0 - 3.

TRUE

--missing-port-starboard

If set, beams are filtered if beams on each side of the swath are rejected. During filtering, only accepted soundings are examined.

Missing neighbours are beams that are rejected during the conversion process into HIPS. This occurs if the beam is disabled in the vessel configuration or if the sonar system flags the beam as a bad detect in the raw data file. Soundings filtered after one filter pass are not considered in the next.

FALSE

--missing-fore-aft

If set, beams are filtered if the adjacent beams in the previous and next swath are rejected.

FALSE

--missing-any-2-of-4

If set, beams are filtered if two of the four neighbouring beams are rejected.

FALSE

BathymetryType = SINGLEBEAM Options

--primary

If set, filters primary soundings with difference values outside of set threshold limits.

FALSE

--secondary

If set, filters secondary soundings with difference values outside of set threshold limits.

FALSE

--selected

If set, filters selected soundings with difference values outside of set threshold limits.

FALSE

--b2b-slope-along-track-angle

A number specifying the degree value for calculating the slopes from each sounding to the previous and next sounding. If both slopes exceed the entered value, and are of opposite sign, then the sounding is filtered.

FALSE

--b2b-slope-include-rejected

If set, includes previously rejected soundings when recalculating the slopes during multiple runs of the filter.

FALSE

--moving-average

A number specifying the number of neighbouring soundings or time in seconds needed to calculate a mean for each sounding.

FALSE

--window-size-type

The type of filter window to apply in the moving average filter.

• SECONDS: Use this time range in seconds for the filter window

• POINTS: Use this time range as a number of points (samples) for the filter window

The default value is POINTS.

FALSE

--threshold

A number specifying the multiple of the standard deviation, as sigma, for the moving average filter.

The default value is 1.

FALSE

Example

Objective

To systematically filter the swath or single beam bathymetry in HIPS data, line by line.

Description

Command Line Syntax

Swath is type of bathymetry to be filtered.

--bathy-type SWATH

Filtering will include only data between -100m and 10m.

--filter -100m -10m

Beam numbers 1 to10, 50 and 78 will be rejected.

--beam-number "1-10 50 78"

Bathymetry flagged 0 will be rejected.

--quality 0

Bathymetry flagged 1 will be rejected.

--quality 1

Bathymetry flagged 2 will be rejected.

--quality 2

The file to update is named input.hips and is located at C:\temp\input\.

C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Command Line

carisbatch --run FilterObservedDepths --bathymetry-type SWATH --filter -100m -10m --beam-number "1-10 50 78" --reject-quality 0 --quality 1 --quality 2 file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome

The data is filtered as specified.

Extra Notes

N/A