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.

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-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

--coordinate- format

t

A string specifying the format of the coordinates in the output.

GROUND: Ground

LLDG_DMS: Geographic DMS

LLDG_DMS_NO_FORMAT: Geographic DMS (no formatting)

LLDG_DM: Geographic DM

LLDG_DD: Geographic DD

TRUE

This must be specified explicitly. (in CARIS Batch at least)

--coordinate-precision

e

A number specifying the decimal precision of the coordinates in the output.

The default value is 3.

FALSE

--include-attribute

b

A string specifying the name of the attribute to include in the output.

The ALL keyword is used to include all other attributes in the output in alphabetical order. If the ALL keyword is used in conjunction with explicit attribute names, ALL overrides the other attribute options.

TRUE

This must be specified explicitly.

--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: All data - Area of all data being exported will be sampled.

• TRACKLINE: Track line - 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.

-- elevation- unit

E

A string specifying the unit for output elevation values.

The value is converted to the specified unit.  

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

The default value is metres.

FALSE

Valid units are Length type units in unitstable.xml

--coordinate- unit

o

A string specifying the unit for output coordinates. 

The value is converted to the specified unit. The unit is only applicable when CoordinateFormat is set to GROUND.  

The default is the unit of the input CRS.

FALSE

--other- precision

e

A number specifying the decimal precision of the attributes in the output.

The default value is 3.

False

--other-unit

x

A string specifying the unit for any other scalar band values.

The value is converted to the specified unit. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd.

The default is metres.

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