Description
The ImportHIPSFromAuxiliary process imports various post‑processed formats into HIPS and SIPS projects.
Update
HIPS track lines.
Inputs
One or more raw data files in a supported format.
Outputs
Updated HIPS track lines and project file.
Command Line Syntax
carisbatch --run ImportHIPSFromAuxiliary --input-format <value> [options] <inputs> <update>
User Interface Command
Import Auxiliary Data
Options
The following table describes the parameters available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short key | Description | Can Repeat | Notes
|
Common Options | ||||
--input-format | I | The format to import. • ASCII: ASCII • APP_POSMV: Applanix POS MV • APP_RMS: Applanix RMS • APP_SBET: Applanix SBET • NAVLAB: Kongsberg Navlab • NOVATEL: NovAtel • PFREEHEAVE: Kongsberg PFreeHeave • STARFIX: Fugro Starfix • TERRAPOS: TerraPos | FALSE | This must be specified explicitly. |
--time-offset | A number specifying the time offset. The default value is 0. Supported units: sec, min, hour, day, week. | FALSE | ||
--time-buffer | A number specifying the time buffer to pad data at the beginning and end of lines. The default value is 0. Supported units: sec, min, hour, day, week. | FALSE | ||
--maximum-gap | A number specifying the maximum allowable time between records. The default value is 2. Supported units: sec, min, hour, day, week. | FALSE | ||
--allow-partial | a | If set, loads data for lines that are only partially covered, otherwise skip loading data for that line. | FALSE | |
InputFormat = ASCII Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation. | FALSE | ||
--gps-height | A number specifying the sampling interval to include GPS height. A value of 0 will use all data. | FALSE | ||
--info-file | s | The path to a file that describes the format of the input ASCII files. | FALSE | This must be specified explicitly. |
InputFormat = APP_POSMV Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation from the Group 1 message. | FALSE | ||
--gyro | A number specifying the sampling interval for including gyro from the Group 1 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch | A number specifying the sampling interval for including pitch from the Group 1 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll | A number specifying the sampling interval for including roll from the Group 1 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height | A number specifying the sampling interval for including GPS height from the Group 1 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--delayed-heave | A number specifying the sampling interval for including delayed heave from the Group 111 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--navigation-rms | A number specifying the sampling interval for including navigation RMS from the Group 2 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gyro-rms | A number specifying the sampling interval for including gyro RMS from the Group 2 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch-rms | A number specifying the sampling interval for pitch RMS from the Group 2 message. A value of 0 will use all data. | FALSE | ||
--roll-rms | A number specifying the sampling interval for including roll RMS from the Group 2 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--delayed-heave-rms | A number specifying the sampling interval for including delayed heave RMS from the Group 111 message. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height-rms | A number specifying the sampling interval for GPS height RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--heave-rms | A number specifying the sampling interval for heave RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. This option is not applicable if GPSHeightRMS is set. | FALSE | ||
--reference-week | A string specifying the manual override for the reference GPS week used to interpret the data time stamps. The date format is "yyyy-mm-dd". If not set, the application will attempt to determine the reference week from the Group 3 message, if present. If this is not found, the application will attempt to determine the reference week from the file name by looking for the pattern YYYY-DDD at the beginning or end of the file name. If this is not found, the application will use the earliest time stamp of the selected track lines to determine a reference week. | FALSE | ||
InputFormat = APP_RMS Options | ||||
--navigation-rms | A number specifying the sampling interval for navigation RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gyro-rms | A number specifying the sampling interval for gyro RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch-rms | A number specifying the sampling interval for pitch RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll-rms | A number specifying the sampling interval for roll RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height-rms | A number specifying the sampling interval for GPS height RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--reference-week | A string specifying the manual override for the reference GPS week used to interpret the data time stamps. The date format is “ If this is not set, the application will attempt to determine the reference week from the file name by looking for the pattern YYYY-DDD at the beginning or end of the file name. If this is not found, the application will use the earliest time stamp of the selected track lines to determine a reference week. | FALSE | ||
InputFormat = APP_SBET Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation. | FALSE | ||
--gyro | A number specifying the sampling interval for gyro. A value of 0 will use all data. A minimum value of 0.02 is recommended. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch | A number specifying the sampling interval for pitch. A value of 0 will use all data. A minimum value of 0.02 is recommended. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll | A number specifying the sampling interval for roll. A value of 0 will use all data. A minimum value of 0.02 is recommended. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height | A number specifying the sampling interval for GPS height. A value of 0 will use all data. A minimum value of 0.02 is recommended. Supported units: sec, min, hour, day, week. | FALSE | ||
--reference-week | A string specifying the manual override for the reference GPS week used to interpret the data time stamps. The date format is “yyyy-mm-dd”. If this is not set, the application will attempt to determine the reference week from the file name by looking for the pattern YYYY-DDD at the beginning or end of the file name. If this is not found, the application will use the earliest time stamp of the selected track lines to determine a reference week. | FALSE | ||
InputFormat = NAVLAB Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation. | FALSE | ||
--gyro | A number specifying the sampling interval for gyro. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch | A number specifying the sampling interval for pitch. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll | A number specifying the sampling interval for roll. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--subsea-depth | A number specifying the sampling interval for subsea depth. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--navigation-rms | A number specifying the sampling interval for navigation RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gyro-rms | A number specifying the sampling interval for gyro RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch-rms | A number specifying the sampling interval for pitch RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll-rms | A number specifying the sampling interval for roll RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--subsea-depth-rms | A number specifying the sampling interval for subsea depth RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
InputFormat = NOVATEL Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation. | FALSE | ||
--gyro | A number specifying the sampling interval for gyro. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch | A number specifying the sampling interval for pitch. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll | A number specifying the sampling interval for roll. A value of 0 will use all data. | FALSE | ||
--gps-height | A number specifying the sampling interval for GPS height. A value of 0 will use all data. | FALSE | ||
--delayed-heave | A number specifying the sampling interval for delayed heave. A value of 0 will use all data. | FALSE | ||
--navigation-rms | A number specifying the sampling interval for navigation RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gyro-rms | A number specifying the sampling interval for gyro RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch-rms | A number specifying the sampling interval for pitch RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll-rms | A number specifying the sampling interval for roll RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height-rms | A number specifying the sampling interval for GPS height RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
InputFormat = PFREEHEAVE Options | ||||
--delayed-heave | A number specifying the sampling interval for delayed heave. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
InputFormat = STARFIX Options | ||||
--navigation | If set, includes navigation. | FALSE | ||
--gyro | A number specifying the sampling interval for gyro. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--pitch | A number specifying the sampling interval for pitch. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--roll | A number specifying the sampling interval for roll. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height | A number specifying the sampling interval for GPS height. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--delayed-heave | A number specifying the sampling interval for delayed heave. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--subsea-depth | A number specifying the sampling interval for subsea depth. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | This must be specified explicitly. |
--vessel-name | A string specifying the name of the vessel. | FALSE | This must be specified explicitly. | |
--navigation-device | A string specifying the name of the navigation device. | FALSE | ||
--heading-device | A string specifying the name of the heading device. | FALSE | ||
--heave-device | A string specifying the name of the heave device. | FALSE | ||
--motion-device | A string specifying the name of the motion device. | FALSE | ||
--subsea-depth-device | A string specifying the name of the subsea depth device. | FALSE | ||
InputFormat = TERRAPOS Options | ||||
--input-crs | p | A string specifying the horizontal coordinate reference system key of the input. The default value is EPSG:4326. For time-dependent coordinate reference systems, the epoch can be specified, typically using the year, as <crs_id>@1997. A fractional year can also be specified, such as <crs_id>@1997.3, if needed. If no epoch is specified, the reference epoch of the coordinate reference system is used. | FALSE | Default is Geographic WGS 84 |
--navigation | If set, includes navigation. | FALSE | ||
--gps-height | A number specifying the sampling interval for GPS height. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--navigation-rms | A number specifying the sampling interval for navigation RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
--gps-height-rms | A number specifying the sampling interval for GPS height RMS. A value of 0 will use all data. Supported units: sec, min, hour, day, week. | FALSE | ||
Example
To use this command, refer to the following example.
Example | ||
|---|---|---|
Objective | To import certain post-processed formats to HIPS data. | |
Description | Command Line Syntax | |
Terrapos data is being imported. | --input-format TERRAPOS | |
Line for which there is only partial auxiliary data will have that data loaded. | --allow-partial navigation | |
All data will be used. | --gps-height 0sec | |
The input file is named inputPOSMV1.pts located in C:\temp\input\. | C:\temp\input\inputPOSMV1.pts\ C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Command Line | carisbatch -run ImportHIPSFromAuxiliary --input-format TERRAPOS --allow-partial --navigation --gps-height file 0sec C:\temp\input\inputPOSMV1.pts ///C:/temp/input/input.hips?Vessel=sample;Day=2000-001 | |
Outcome | The HIPS project data is updated by the imported auxiliary data. | |
Extra Notes | N/A | |