Description
The ImportTideToHIPS process applies tidal observation data.
Update
One or more HIPS track lines.
Outputs
Updated HIPS track lines.
Command Line Syntax
carisbatch --run ImportTideToHIPS --tide-file <value> [options] <update>
User Interface Command
Import Using File > Open and Drag and Drop
Options
The following describes parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short key | Description | Can Repeat | Notes |
--interpolation-type | Apply the tide data to each line from a single tide station (.tid) or Interpolate tide data from multiple tide stations within a tide zone file (.zdf). • SINGLE_STATION: Single Station - Single station interpolation • MULTI_STATION: Multiple Stations - Multiple station interpolation The default value is SINGLE_STATION. | FALSE | ||
--tide-file | The path to the tide station or zone file. | FALSE | ||
InterpolationType = MULTI_STATION | ||||
--weighted-average | If set, calculates the weighted average during multiple tide station interpolation. | FALSE | ||
--compute-errors | If set, computes errors during multiple tide station interpolation. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
|---|---|---|
Objective | To apply tidal observation data to the line data in the HIPS project. | |
Description | Command Line Syntax | |
Data from single tide station is applied to the line data. | --interpolation-type SINGLE_STATION | |
The tide file is named sampleTide.tid and is located at D:\BatchSample. | --tide-file C:\sampleTide.tid | |
The input (line data) 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: | |
Command Line |
| |
Outcome | The line data is updated with the tide values. | |
Extra Notes | N/A | |