Common Options

--output-format

O

A string specifying the format in which the output cloud is generated.

• ASCII: ASCII text format.

• GSF: Generic Sensor Format used by many acquisition and processing systems.

• ExportHIPSTrackLineFeatures: A features format.

FALSE

Output Format - ASCII Options

--single-file

A string specifying the filename to output all of the HIPS data into in the output folder. If set, all HIPS data will export into a single file.

FALSE

--overwrite

If set, when there is an existing file with the same name as the new single file, it will be overwritten.

FALSE

Disabled when Single File is not set

--nadir-depth-only

If set, only the depth value at nadir is exported.

FALSE

--include

n

The position or attribute to include in the output. It requires the following arguments:

• <Type> - The type of data to export. One of {POSITION, ATTRIBUTE}.

• <PosName> - The name of the specific Position data to export. Use CARIS:NONE when using AttName.

• <AttName> - The name of the specific Attribute data to export. Use CARIS:NONE when using PosName.

• <Decimal-Precision> - A number specifying the decimal precision for floating point numeric values in the output. Use CARIS:NONE when not applicable for AttName.

• <Unit> - The unit for numeric values in the output. Use CARIS:NONE when not applicable for AttName.

• Using the Include option also requires explicitly specifying which position components (X, Y, Lat, or Lon) to include in the export.

• The Include option may be specified multiple times with the same type and name, using the same or different precision and/or unit.

• If Type is POSITION, Name can be X, Y, Lat, or Lon. If Type is ATTRIBUTE, Name can be any attribute name.

Note: POSITION names are entered using a short form. If the ASCII file includes a header, these names are displayed differently in their full length form. For example, X and Y export as Easting and Northing.

If Type is ATTRIBUTE:

• Decimal-Precision and Unit are optional and defaults to a precision of 0 and unit of metres, respectively. Unit, if set, is one of {cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd}.

• Attributes available to export include:

• INDEX - Index

• DEPTH_PRO - Depth (Processed)

• DEPTH_OBS - Depth (Observed)

• DATE_REGIONAL - Date (Regional)

• DATE_JULIAN - Date (YYYY - DDD)

• YEAR - Year

• DAY - Day

• TIME - Time

• HIPS_FILE - HIPS File name

• VESSEL - Vessel

• LINE - Line

• PROFILE - Profile

• BEAM - Beam

• TIDE - Tide

• ACCURACY - Accuracy

• STATUS - Status

• AMPLITUDE_DB - Amplitude (db)

• AMPLITUDE_BYTE - Amplitude (byte)

• DEPTH_TPU - Depth TPU

• POSITION_TPU - Position TPU

• TIMESTAMP - Caris Timestamp

• ELEVATION - Elevation

• ANGLES - Angles

• GPS_WEEK - GPS week

• GPS_SECONDS - GPS seconds

• PRIMARY_DEPTH - Primary depth

• SECONDARY_DEPTH - Secondary Depth

• TRAVEL_TIME - Two way travel time

If Type is POSITION, Unit can also be one of:

• DD: Geographic decimal degrees, formatted with +/- and spaces (" ").

• deg: Geographic decimal degrees, formatted with +/- and spaces (" "). Equivalent to DD.

• D-M: Geographic degrees minutes, formatted with N,S,E,W and dashes (-).

• D-M-S: Geographic degrees minutes seconds, formatted with N,S,E,W and dashes (-).

• DMS: Geographic degrees minutes seconds, formatted with +/- and spaces (" ").

Note: If exporting geographic data (latitudes/longitudes), the selected unit will be included in the header of the output file, if a header is used, in the general form of DD, DM or DMS.

TRUE

--include-flag

A string specifying a status flag to be included for the operation.

ACCEPTED: Accepted status flag

EXAMINED: Examined status flag

OUTSTANDING: Outstanding status flag

REJECTED: Rejected status flag

SUPPRESSED: Suppressed status flag

TRUE

This must be specified explicitly in CARIS Batch.

--include-header

a

If set, the header is included in the output

FALSE

--delimiter

d

The delimiter character used to delineate columns in output.

Single characters are specified directly. For a single space, use “ " or the keyword space. For a tab, use \t or the keyword tab.

The default value is a comma.

FALSE

--output-crs

c

A string specifying the horizontal coordinate reference system key of the output.

If specified, the data is transformed.

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

--z-axis- convention

z

A string specifying the output Z-axis convention.

UP: Z axis positive up

DOWN: Z axis positive down

The default value is DOWN.

FALSE

--attribute-filter

A string specifying a filter to apply to input attribute values.

The following operations are supported:

IF, THEN, ELSE, AND, OR, NOT, IN, +, -, *, /, ^ (exponent), <, >, =, and != (not equal). For example, “Depth > 1".

FALSE

Elevation bands used in the expression will honour the application's Z-axis convention (but is always up is positive for CARIS Batch).

--sample

s

The sample size with its sampling method.

<SampleSize> - A number specifying the output sample size.

<SampleMethod> - A string specifying the output sampling method. One of {MIN, MAX }.

<SampleArea> - A string specifying the area to apply the sample to. One of {ALLDATA, TRACKLINE}.

• MIN: Minimum node value which is equivalent to shoalest when Z down convention applied.

• MAX: Maximum node value which is equivalent to deepest when Z down convention applied.

• ALLDATA: Area of all data being exported will be sampled.

• TRACKLINE: Area of data in each track line is sampled before being exported.

The sample size unit must be specified. If the input is a raster, the sample size must be equivalent to or larger than the resolution of the input.

Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

Valid units are Length type units in unitstable.xml.

Output Format = GSF Options

--ignore-disabled-beams

If set, disabled beams are not included in the output.

FALSE

--exclude-raw-sensor-data

Export only the Position and Depth information, exclude any raw sensor datagrams, such as Motion and Range and Angle. This will result in a reduced size for easy transfer, but still allow viewing the processed data.

FALSE

--tide-corrector-source

The Corrector flag to apply to the pings in the exported GSF file.

• USE_GSF: Use original GSF setting. If the data was imported via GSF and re-exported to GSF, the original GSF setting for the Tide Corrector source will be used. If another format was used, Unknown is set.

• UNKNOWN: The Tide Corrector source in the output GSF file is set as Unknown.

• PREDICTED: The Tide Corrector source in the output GSF file is set as Predicted.

• OBS_PRELIM: The Tide Corrector source in the output GSF file is set as Observed, preliminary.

• OBS_VERIF: The Tide Corrector source in the output GSF file is set as Observed, verified.

If not set, this will default to UNKNOWN, which will set the tide corrector source flag as unknown.

If GPS tide was used in the data, this option is ignored.

FALSE

--reference-vertical-datum

The definition of the reference vertical datum for the depths in the exported GSF file.

• UNKNOWN - Unknown vertical datum

• MLLW - Mean lower low water

• MLW - Mean low water

• ALAT - Aprox Lowest Astronomical Tide

• ESLW - Equatorial Springs Low Water

• ISLW - Indian Springs Low Water

• LAT - Lowest Astronomical Tide

• LLW - Lowest Low Water

• LNLW - Lowest Normal Low Water

• LWD - Low Water Datum

• MLHW - Mean Lower High Water

• MLLWS - Mean Lower Low Water Springs

• MLWN - Mean Low Water Neap

• MSL- Mean Sea Level

• ALLW - Approximate Lowest Low Water

• LNT- Lowest Normal Tide

• AMLWS - Approximate Mean Low Water Springs

• AMLLW - Approximate Mean Lower Low Water

• MLWS - Mean Low Water Spring

• AMSL - Approximate Mean Sea Level

• AMLW - Approximate Mean Low Water

• AISLW - Approximate Indian Springs Low Water

• ALLWS - Approximate Lower Low Water Springs

If not set, this will default to UNKNOWN, which will set the TIDAL_DATUM as UNKNOWN.

If GPS tide was used in the data, this option is ignored.

FALSE

--positioning-system-type

The definition of the positioning system type for the navigation data in the exported GSF file.

• UNKNOWN - Unknown positioning system type

• GPSU - GPS Position, unknown positioning service

• PPSD - Precise positioning service - differential

• PPSK - Precise positioning service - kinematic

• PPSS - Precise positioning service - standalone

• PPSG - Precise positioning service - gypsy

• SPSD - Standard positioning service - differential

• SPSK - Standard positioning service - kinematic

• SPSS - Standard positioning service - standalone

• SPSG - Standard positioning service - gypsy

• GPPP - Post Processing - Precise Point Positioning

• GPPK - Post Processing - Post Processed Kinematic

• INUA - Inertial measurements only, unaided

• INVA - Inertial measurements with absolute velocity aiding

• INWA - Inertial measurements with water-relative velocity aiding

• LBLN - One or more long-baseline acoustic navigation lines of position

• USBL - Ultra-short baseline acoustic navigation

• PIUA - Post-processed inertial measurements only, unaided

• PIVA - Post-processed Inertial measurements with absolute velocity aiding

• PIWA - Post-processed Inertial measurements with water-relative velocity aiding

• PLBL - Post-processed One or more long-baseline acoustic navigation lines of position

• PSBL - Post-processed ultra-short baseline acoustic navigation

If not set, this will default to UNKNOWN, which will set the POSITION_TYPE as UNKNOWN.

FALSE

--dual-as-separate

If specified, when input HIPS data has a dual head setup, each head will be exported to a separate GSF file per head with ' (Head#)_MBE' appended to the filename.

FALSE

Output Format - Track Line Features Options

--navigation-output-reference-position

A string specifying the reference location on the vessel that will be used to calculate the output positions for the track line navigation data.

• RAW: The original imported position as it was stored in the raw data.

• RP: The Reference Point (0,0,0) in the vessel file.

• SONAR_1_TRANSXYZ: The Transducer 1 section.

• SONAR_1_TX: The SVP1 section for single head or Transmitter 1 section of the installationparamter.xml for dual head.

• SONAR_1_RX: The SVP2 section for single head or SVP1 section for dual head.

• SONAR_2_TRANSXYZ: The Transducer 2 section.

• SONAR_2_TX: The Transmitter 2 section of the installationparamter.xml.

• SONAR_2_RX: The SVP2 section.

• IMU: The Heave section.

• TOW_POINT: The Tow Point section.

• CUSTOM: Custom XYZ offsets to any location on the vessel.

The default is RAW.

FALSE

--starboard

A number specifying the offset from reference point for the new calculated depths.

This option is only to be used when the navigation output reference position is set to Custom. This applies the upside down left hand rule.

The default is 0.

The unit must be specified. Supported units include: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

--forward

A number specifying the offset from reference point for the new calculated depths.

This option is only used when the navigation output reference position is set to Custom. This applies the upside down left hand rule.

The default is 0.

The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

--down

A number specifying the offset from reference point for motion calculations.

This option is only used when the navigation output reference position is set to Custom. This applies the upside down left hand rule.

The default is 0.

The unit must be specified. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

--include-point-features

If set, point features are output along with the track line.

Point features are features that the process outputs to the hob file based on the vertices of the track line that is output. These features will be created with the same attributes as the track line that is created.

FALSE

--interval-type

A string specifying the type of interval to use. The options are:

• TIME: The search time to find that points along the track line that are to be kept in the exported object(s).

• DISTANCE: The search distance to find points along the track line that are to be kept in the exported object(s).

FALSE

--search-inteval-time

A number specifying the time between the last value exported and the next value to export. The closest point along the track line found by this time is exported.

This option is only used when the Interval Type option is set to TIME.

The unit must be specified. Supported units include: seconds, minutes

FALSE

--search-interval-distance

A number specifying the distance between the last value exported and the next value to export. The closest point along the track line found by this distance is exported.

This option is only used when the Interval Type option is set to DISTANCE.

The unit must be specified. Supported units include: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

FALSE

--include-extended-attributes

If set, extended attributes are added to the track line and/or point features.

Extended attributes are all the attributes that the process finds when going through the various HIPS related files. All attributes found here are in the HIPS Line Report tool.

Enabling this option will increase the processing time considerably.

FALSE

--feature-catalogue

F

A string specifying the name of the catalogue that defines the features and attributes in a vector dataset. One of { list dynamically populated from the catalogue control file }.

The names of the available catalogues can be accessed through application via the Object Catalogue environment variable in Tools > Options. The available catalogues are controlled by the Catalogue Control file. An example of a catalogue name is "S-57 ENC 3.1".

A catalogue is only used when the input is a HOB file. The default value is Bathy DataBASE.

FALSE

This must be specified explicitly.

--track-line-feature

The path to the mapping file used to create the feature.

The default value is the trklne.xml file in the system location.

The specified acronym must be present in the specified catalogue.

FALSE

This must be specified explicitly.

Objective

To export the HIPS data to ASCII format.

Description

Command Line Syntax

The output format will be ASCII..

--output-format ASCII

Include points with the flags Accepted, Examined, Outstanding.

--include-flag ACCEPTED --include-flag EXAMINED --include-flag OUTSTANDING

The header will be included in the output.

--include-header

The output should overwrite the existing file in the output location.

--overwrite

A comma will be used for the delimiter in the output file.

--delimiter ","

The output CRS will be EPSG:4326.

--output-crs EPSG:4326

The data will be exported for Position 9 using Latitude and Longitude coordinates in Geographic decimal degrees.

--include POSITION LAT CARIS:None 9 DD --include POSITION LON CARIS:None 9 DD

The Depth (Processed) attribute data will be included in the export.

--include ATTRIBUTE CARIS:None DEPTH_PRO 3 m

The input file is named CUBE Training 2024.hips and is located at C:\temp\input\. The HIPS file URI filters for the day 2011-090.

C:\temp\input\CUBE Training 2024.hips

The output files will be exported to the C:\Data\Training directory.

C:\Data\Training

Command Line

carisbatch --run ExportHIPS --output-format ASCII --include-flag ACCEPTED --include-flag EXAMINED --include-flag OUTSTANDING --include-header --overwrite --delimiter "," --output-crs EPSG:4326 --include POSITION LAT CARIS:None 9 DD --include POSITION LON CARIS:None 9 DD --include ATTRIBUTE CARIS:None DEPTH_PRO 3 m file:///"CUBE Training 2024.hips?Day=2011-090" C:\Data\Training

Outcome

HIPS track lines are exported as ASCII feature data.

Extra Notes

N/A