Description
The ComputeHIPSGPSTide process provides an alternative to normal tidal observation for reducing soundings to the sounding datum. A single sounding datum height, or a datum model file with a grid of datum heights, can be applied with the GPS height during the computation.
Update
One or more HIPS track lines.
Outputs
Updated HIPS track lines.
Command Line Syntax
carisbatch --run ComputeHIPSGPSTide [options] <update>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short key | Description | Can Repeat | Notes
|
Common Options | ||||
--datum-separation-type | The type of datum separation to apply. • FIXED: Fixed Height - A fixed separation is used. • MODEL: Datum Model - A sounding datum model is used. The default value is FIXED. | FALSE | ||
--smooth-height | If set, applies smoothing to GPS height. | FALSE | ||
--dynamic-heave | Type of dynamic heave to be applied. One of. • NONE: No dynamic heave will be used • HEAVE: Original heave data will be used • DELAYED_HEAVE: Delayed heave data will be used. The default value is NONE. | FALSE | ||
--MRU-remote-heave | If set, applies remote heave resulting from vessel roll/pitch on an offset-mounted MRU. | FALSE | ||
-antenna-offset | If set, applies the offset of the GPS antenna from the reference point. | FALSE | ||
--dynamic-draft | If set, applies dynamic draft. Either as a result of interpolating the draft table from the HIPS Vessel File (HVF) or as stored in HIPS as time series data. | FALSE | ||
--waterline | Type of waterline offset to apply. • NONE: No waterline will be used • VESSEL: Apply the waterline offset from the HIPS Vessel File • REALTIME: Apply the waterline value from the InstallationParameters.xml file generated by the converter. The default value is NONE. | FALSE | ||
--height-correction | A number specifying the height correction as a static offset to the GPS antenna. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
--time-offset | A number specifying the time offset to the GPS Height data. Supported units: sec, min, hour, day, week. | FALSE | ||
--output-components | If set, an ASCII text file (GPSTideComponents.txt) is created in the line folder with all the components extracted/interpolated during the process. | FALSE | ||
DatumSeparationType = FIXED Options | ||||
--datum-fixed-height | A number specifying the single value for datum height. The default value is 0. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd and yd. | FALSE | ||
DatumSeparationType = MODEL Options | ||||
--datum-model-file | The file path to the datum model. The datum model can be one of type TIN, raster surface or point cloud. | FALSE | ||
--datum-model-band | A string specifying the datum model band name. Only applicable when DatumModelPath is provided a raster surface or point cloud in the CSAR format. | FALSE | ||
--info-file | s | The path to the file that describes the format of the input ASCII files. This must be set when DatumModelPath is provided an ASCII XYZ file. | FALSE | |
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. This must be set when DatumModelPath is provided an ASCII XYZ file. | FALSE | This must be explicitly set. |
Example
To use this command, refer to the following example.
Example | ||
Objective | To apply a tide correction to HIPS track line data using a single sounding datum height with a grid of datum heights. | |
Description | Command Line Syntax | |
Use a Fixed separation height. | --datum-separation-type FIXED | |
The fixed height is 10 m. | --datum-fixed-height 10m | |
The dynamic heave is set to delayed heave. | --dynamic-heave DELAYED_HEAVE | |
Apply the remote heave resulting from vessel roll/pitch. | --mru-remote-heave | |
Apply the waterline offset from the HIPS vessel file. | --waterline VESSEL | |
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 day 2000-001. | file:///C:/temp/input/input.hipsVessel=sample;Day=2000-001 | |
Command Line |
| |
Outcome | The selected HIPS track line is updated using with the tide data correction. | |
Extra Notes | N/A | |