Description
The FilterHIPSAttitude process allows for attitude filtering in the HIPS data automatically, line by line.
Update
One or more HIPS track lines.
Outputs
Updated HIPS track lines.
Command Line Syntax
carisbatch --run FilterHIPSAttitude --sensor-type <value> [options] <update>
User Interface Command
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short key | Description | Can Repeat | Notes
|
Common Options | ||||
--sensor-type | S | The type of attitude to filter. One of: • DELAYED_HEAVE: Delayed Heave • DELTA_DRAFT: Delta Draft • GPS_HEIGHT: GPS Height • GPS_TIDE: GPS Tide • GYRO: Gyro • HEAVE: Heave • NAVIGATION_CMG: Navigation Course Made Good • NAVIGATION_DISTANCE: Navigation Distance • NAVIGATION_SPEED: Navigation Speed • NAVIGATION_HDOP: Navigation Horizontal Dilution of Precision • NAVIGATION_VDOP: Navigation Vertical Dilution of Precision • NAVIGATION_HEIGHT: Navigation GPS Height • NAVIGATION_NUMSATS: Navigation Number of Satellites • NAVIGATION_PDOP: Navigation Position Dilution of Precision • NAVIGATION_STDLAT: Navigation Standard Deviation of Latitude • NAVIGATION_STDLON: Navigation Standard Deviation of Longitude • PITCH: Pitch • ROLL: Roll • SURFACE_SOUND_SPEED: Surface Sound Speed • SPEED_OVER_WATER: Speed Over Water • SSS_CABLE_OUT: Side Scan Cable Out • SSS_GYRO: Side Scan Gyro • SSS_SENSOR_DEPTH: Side Scan Sensor Depth • SSS_SENSOR_HEIGHT: Side Scan Sensor Height • TIDE: Tide | FALSE | This must be specified explicitly. |
--enable-filtering | If set, enables filtering of the sensor data. | FALSE | ||
--enable-smoothing | If set, enables smoothing of the sensor data. | FALSE | ||
--filter-break-interpolation | If set, disables interpolation across gaps created by rejecting filtered data. Interpolation is applied by default. | FALSE | ||
--filter-type | The type of filter/smoothing to apply. One of: • MOVING_AVERAGE: Moving Average • FFT: Fast Fourier The default value is MOVING_AVERAGE. | FALSE | ||
--window-size-type | The type of filter window to apply. One of: • 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 When FilterType is set to MOVING_AVERAGE, the window size is used for averaging the data. When FilterType is set to FFT, the window size is used to derive the cut-off frequency that is applied to all data. The default value is POINTS. | FALSE | ||
--threshold | A number specifying the multiple of the standard deviation, as sigma, for the filter or smooth cut-off. The default value is 1. | FALSE | ||
WindowSizeType = SECONDS Options | ||||
--window-size-time | A number specifying the number of seconds to use in the Filter window for Moving Average or Fast Fourier. The valid range is 1 or greater. The default value is 1. | FALSE | ||
WindowSizeType = POINTS Options | ||||
--window-size-sample | A number specifying the number of points to use in the Filter window for Moving Average or Fast Fourier. The valid range is 3 or greater. Only odd numbers are valid. The default value is 3. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
|---|---|---|
Objective | To automatically filter the attitude in HIPS data, line by line. | |
Description | Command Line Syntax | |
The type of attitude to filter is GPS_TIDE. | --sensor-type GPS_TIDE | |
The sensor data will be smoothed. | --enable smoothing | |
A Moving Average filter will be applied. | --filter-type MOVING_AVERAGE | |
The filter window will use a time range in seconds. | --window-size-type SECONDS | |
10 seconds will define the filter window size. | --window-size 10 | |
The threshold for filtering is set to 3 sigma. | --threshold 3 | |
The input file is named input.hips and is located at C:\temp\input\. The HIPS file URI filters for the vessel named “sample” and the day 2000-001. | C:\temp\input\ | |
Command Line |
| |
Outcome | HIPS track lines are updated by attitude filtering. | |
Extra Notes | N/A | |