Description
The ComputeHIPSSeparationModel process uses HIPS Data with Tide loaded to create a separation model in CSAR format.
Inputs
One or more HIPS track lines.
Outputs
A raster surface in CSAR format.
Command Line Syntax
carisbatch --run ComputeHIPSSeparationModel [options] <inputs> <output>
The following table describes the parameters available for this process.
Parameter | ||||
Long | Short key | Description | Can Repeat | Notes
|
--resolution | R | A number and unit specifying the resolution of the output raster. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | FALSE | This must be explicitly specified. |
--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. One of: • 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: metres. | FALSE | ||
--time-offset | A number specifying the time offset to the GPS Height data. Supported units: seconds. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
Objective | To create a separation model in CSAR format using HIPS Data with Tide loaded. | |
Description | Command Line Syntax | |
The resolution is set to 10m. | --resolution 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 | |
The input file is named input.hips and is located at D:\BatchSample\input. The HIPS file URI filters for the vessel named “sample” and day 2000-001. | file:///D:\BatchSample/input/input.hips?Vessel=sample;Day=2000-001 | |
The output file is namedseparation_model.csar located at D:\BatchSample. | D:\BatchSample\separation_model.csar | |
Command Line |
| |
Outcome | A separation model is created. | |
Extra Notes | N/A | |