--computesvc

Use a ray tracing algorithm to apply sound velocity profiles to the final depths.

FALSE

--svp

The path to the sound velocity profiles in a file or folder.

If not set, uses the SVP already loaded in the HIPS data for the track lines passed to the process.

TRUE

Not used when ComputeSVC is false.

--ssp-as-backup-svp

If set, when sound velocity profile (SVP) is not available, surface sound speed (SSP), if available, is used as a full SVP during sound velocity correction.

False

--profile-selection-method

Method for selection of which sound velocity profile to apply for each ping, when multiple profiles are available.

• PREVIOUS_IN_TIME: Previous in Time

• NEAREST_IN_TIME: Nearest in Time

• NEAREST_IN_DISTANCE: Nearest in Distance

• NEAREST_IN_DISTANCE_WITHIN: Nearest in Distance Within Time

• USE_LAST_METHOD: Use Last Method

The defaults value is PREVIOUS_IN_TIME.

FALSE

Not used when ComputeSVC is false.

--nearest-distance-hours

A number specifying the number of hours for use with the nearest in distance within time profile selection method.

The default value is 1.

FALSE

Use when ProfileSelectionMethod = NEAREST_IN_DISTANCE or NEAREST_IN_DISTANCE_WITHI.

--ssp

If set, surface sound speed (SSP), when available, is inserted into the sound velocity profile (SVP) used during sound velocity correction. When not available, SVP is used without any changes.

FALSE

--resteer-beam-angles

If set, performs an additional re-computation of the steered beam angles based on a new surface sound speed that will be interpolated from the sound velocity profile (compatible systems are listed in the online help). This is only available when the Surface Sound Speed is used.

The recorded SSP (known to be incorrect) along with the sound speed interpolated from SVP (assumed to be correct), will be used to compute new beam angle data. Ray-tracing will then proceed without insertion of the SSP into the SVP. Used only if SSP is applied. For compatible systems only.

FALSE

Not used when SSP is false.

--heave-source

Type of heave to be applied when georeferencing bathymetry.

• HEAVE: Original (realtime) heave data will be used.

• DELAYED_HEAVE: Delayed heave data will be used.

The defaults value is HEAVE.

If this is set to DELAYED_HEAVE but no delayed heave data is available, the process will use realtime heave data instead.

Note: During Georeference Bathymetry, HIPS will apply the difference between delayed heave and realtime heave only if all of the following are true:

• Data has not undergone sound velocity correction, and;

• In the vessel file, the Heave sensor has Apply set to NO, and;

• In Georeference Bathymetry, --heave-source is set to DELAYED_HEAVE, and;

• Both realtime heave values and delayed heave values exist for the line.

If data has already undergone sound velocity correction, no dynamic heave (realtime or delayed) will be applied.

FALSE

This option is used with ComputeSVC and Merge

--vehicle-depth

If set, delta draft/subsea depth is applied to the processed data.

If ComputeSVC is set, delta draft/subsea depth is used to position the sonar in the water column during Sound Velocity Correction.

FALSE

--compute-tpu

Calculate a total depth and position uncertainty for all soundings from a combination of individual uncertainty sources.

FALSE

--tide-measured

A number specifying the error value for the tide station. It is equivalent to the standard deviation of the tide gauge measurements. The value is Ignored if tide source is real time.

The default value is 0.

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

FALSE

Use when ComputeTPU is TRUE.

-tide-zoning

A number specifying the value for the vertical uncertainty in the range calculation for a tide zone file.

The default value is 0.

HIPS does not model the TPU for the tide zone. Instead a single user-defined value may be used here.

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

FALSE

Use when ComputeTPU is TRUE.

--source-gps-height

Source of the uncertainty values for the GPS height.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

--gps-sounding-datum

A number specifying the value for the vertical uncertainty in the range calculation for a GPS sounding datum model.

The default value is 0.

HIPS does not model the TPU for the GPS sounding datum model. Instead a single user‑defined value may be used here.

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

FALSE

Use when ComputeTPU is TRUE.

--sv-measured

A number specifying the value for the uncertainty of inaccuracies in SVP measurements.

The default value is 0.

Supported units: ft/s, km/h, kn, m/s, mi/h, usft/s and usmi/h.

FALSE

Use when ComputeTPU is TRUE.

--sv-surface

A number specifying the surface offset value used to account for errors in surface sound speed measurements that alter the beam angle. (This parameter is only applicable to systems that require accurate surface sound speed measurements.)

The default value is 0.

Supported units: ft/s, km/h, kn, m/s, mi/h, usft/s and usmi/h.

FALSE

Use when ComputeTPU is TRUE.

--sweep-max-heave

A number specifying the maximum uncertainty value for the estimated observed heave of the transducer boom.

The default value is 0.

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

FALSE

Use when ComputeTPU is TRUE.

--sweep-max-pitch

A number specifying the maximum uncertainty value for the estimated observed pitch of the transducer boom.

The default value is 0.

Supported units: deg and rad.

FALSE

Use when ComputeTPU is TRUE.

--sweep-max-roll

A number specifying the maximum uncertainty value for the estimated observed roll of the transducer boom.

The default value is 0.

Supported units: deg and rad.

FALSE

Use when ComputeTPU is TRUE.

--source-sonar

Source of the uncertainty values for the sonar.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

--source-navigation

Source of the uncertainty values for the navigation.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

-source-gyro

Source of the uncertainty values for the gyro.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

-source-pitch

Source of the uncertainty values for the pitch.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

--source-roll

Source of the uncertainty values for the roll.

• VESSEL: Use the static model value from the vessel configuration

• REALTIME: Use the stored real-time value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

--source-heave

Source of the uncertainty values for the heave.

• VESSEL: Use the static model value from the vessel configuration

• HEAVE: Use the stored real-time heave value

• DELAYED: Use the stored real-time delayed heave value

The default value is VESSEL.

FALSE

Use when ComputeTPU is TRUE.

--source-tide

Source of the uncertainty values for the tide.

• STATIC: Use a static value - comes from the dialog

• REALTIME: Use the stored real-time value - can be created by user control when loading tide

The default value is STATIC.

FALSE

Use when ComputeTPU is TRUE.

--vertical-datum-reference

The type of tide to be applied.

• NONE: No tidal correction will be applied

• TIDE: Observed tidal corrections will be applied

• GPS: GPS tidal corrections will be applied

The default value is NONE.

FALSE

--tide-file

The path to the tide station or zone file.

FALSE

Use when VerticalDatumReference = TIDE.

If TIDE is set and TideFile is a ZDF format, uses Multiple Stations.

--weighted-average

If set, calculates the weighted average during multiple tide station interpolation.

FALSE

Use when VerticalDatumReference = TIDE and ZDF file is set.

--compute-errors

If set, computes errors during multiple tide station interpolation.

FALSE

Use when VerticalDatumReference = TIDE and ZDF file is set.

--compute-gps-vertical-adjustment

If set, computes a vertical adjustment for the soundings using the ellipsoid as reference.

FALSE

Use when VerticalDatumReference= GPS

--smooth-height

If set, applies smoothing to GPS height.

FALSE

--sounding-datum-offset

If set, applies a single static datum offset to the GPS height.

The default value is 0.

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

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set.

--datum-model-file

The file path to the datum model.

If not set when using a TideSource of GPS, VerticalOffset is used for the static datum offset.

The datum model can be one of type ASCII (TIN), raster surface or point cloud.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set.

--datum-model-band

A string specifying the datum model band name.

Only applicable when DatumModelPath is provided as a raster surface or point cloud in the CSAR format.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set and VerticalDatumReference = <model file>.

--info-file

s

The path to the file that describes the format of the input ASCII files.

This must be set when DatumModelPath is provided an ASCII XYZ file.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set and VerticalDatumReference = <model file>.

--input-crs

p

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

This must be set when DatumModelPath is provided an ASCII XYZ file.

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 explicitly set.

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set and VerticalDatumReference = <model file>.

--output-components

If set, an ASCII text file (GPSTideComponents.txt) is created in the line folder with all the components extracted/interpolated during the process.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set.

--gps-vertical-components

If set to Custom, it will use the Antenna Offset, Dynamic Heave, MRU Remote Heave, Dynamic Draft, Delta Draft/Subsea Depth and Waterline settings to apply the GPS Vertical Adjustment.

• SYSTEM: Uses the default system settings for computing GPS vertical adjustment.

• CUSTOM: Uses the custom settings in the process applied by the user.

The default value is SYSTEM.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set.

--gps-component-antenna-offset

If set, applies the offset of the GPS antenna from the reference point.

FALSE

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--gps-component-dynamic-heave

Type of dynamic heave to be applied.

• 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

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--gps-component-mru-remote-heave

If set, applies remote heave resulting from vessel roll/pitch on an offset-mounted MRU.

FALSE

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--gps-component-dynamic-draft

If set, applies dynamic draft as a result of interpolating the draft table from the HIPS Vessel File (HVF).

FALSE

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--gps-component-vehicle-depth

If set, delta draft/subsea depth is applied to the processed data.

FALSE

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--gps-component-waterline

Type of waterline offset to apply.

• 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

Use when VerticalDatumReference= GPS, ComputeGPSVerticalAdjustment is set and GPSVerticalComponents = CUSTOM.

--vertical-offset

A number specifying the vertical offset as a static offset to the processed depths.

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

The default value is 0.

FALSE

Use when TideSource = GPS.

--apply-refraction-coeff

If set, applies refraction coefficients.

FALSE

--beam-shift

The type of beam shift to be applied during merge.

• NONE: No beam shift will be applied

• STATIC: Static beam shifts will be applied

• RELATIVE: Relative beam shifts will be applied

The default value is NONE.

FALSE

--beam-shift-file

The path to the beam shift file.

FALSE

Use when BeamShift = STATIC or RELATIVE.

-smooth-sensor

If set, applies smoothing coefficients to the specified data.

• GYRO: Smoothes the gyro data.

• HEAVE: Smoothes the heave data.

• PITCH: Smoothes the pitch data.

• ROLL: Smoothes the roll data.

• SOW: (Speed over water) Smoothes the speed over water data.

• DELTA_DRAFT: Smoothes the delta draft/subsea depth data.

• GPS_TIDE: Smoothes the GPS tide data.

• TIDE: Smoothes the tide data.

• GPS_HEIGHT: Smoothes the GPS Height data.

TRUE

Objective

To correct data and geographically reference sounding positions and depths of bathymetry data, also applying sound velocity correction.

Description

Command Line Syntax

Data is being georeferenced.

--run GeoreferenceHIPSBathymetry

Sound velocity correction is computed and applied with specified SVP files.

--compute-svc --svp C:\svpfile1.svp --svp C:\svpfile1.svp --svp C:\svpfiles\

Input 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:/temp/input/input.hips?Vessel=sample;Day=2000-001

Command Line

carisbatch --run GeoreferenceHIPSBathymetry --compute-svc --svp C:\svpfile1.svp --svp C:\svpfile1.svp --svp C:\svpfiles\ file:///file:///C:/temp/input/input.hips?Vessel=sample;Day=2000-001

Outcome

The data is corrected and georeferenced with the values set by user.

Extra Notes

N/A

Objective

To correct data and geographically reference sounding positions and depths of bathymetry data, including computing and applying total propagated uncertainty values.

Description

Command Line Syntax

Data is being georeferenced.

--run GeoreferenceHIPSBathymetry

Total propagated uncertainty is computed and applied with specified values

--compute-tpu --tide-measured 0.01 --sv-measured 0.02 --source-sonar REALTIME

Input 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:/temp/input/input.hips?Vessel=sample

Command Line

carisbatch --run GeoreferenceHIPSBathymetry --compute-tpu --tide-measured 0.01 --sv-measured 0.02 --source-sonar REALTIME file:///C:/temp/input/input.hips?Vessel=sample

Outcome

The data is corrected and georeferenced with the values set by user.

Extra Notes

N/A

Objective

To correct data and geographically reference sounding positions and depths of bathymetry data, applying a GPS vertical adjustment using a tide file.

Description

Command Line Syntax

Data is being georeferenced.

--run GeoreferenceHIPSBathymetry

Tide values are applied from a tide file.

--vertical-datum-reference TIDE --tide-file file:///C:/temp/input/tide.tid file:///

Input 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:/temp/input/input.hips?Vessel=sample

Command Line

carisbatch --run GeoreferenceHIPSBathymetry --vertical-datum-reference TIDE --tide-file file:///C:/temp/input/tide.tid file:///C:/temp/input/input.hips?Vessel=sample

Outcome

The data is corrected and georeferenced with the values set by user.

Extra Notes

N/A

Objective

To correct data and geographically reference sounding positions and depths of bathymetry data, and applying GPS vertical adjustments using vertical offset values.

Description

Command Line Syntax

Data is being georeferenced.

--run GeoreferenceHIPSBathymetry

GPS vertical adjustment is applied using vertical offset values.

--vertical-datum-reference GPS --compute-gps-vertical-adjustment --vertical-offset -22m

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

file:///C:/temp/input/input.hips?Vessel=sample

Command Line

carisbatch --run GeoreferenceHIPSBathymetry --vertical-datum-reference GPS --compute-gps-vertical-adjustment --vertical-offset -22m file:///C:/temp/input/input.hips?Vessel=sample

Outcome

The data is corrected and georeferenced with the values set by user.

Extra Notes

N/A

Objective

To correct data and geographically reference sounding positions and depths of bathymetry data, and applying a GPS vertical adjustment using a datum model file.

Description

Command Line Syntax

Data is being georeferenced.

--run GeoreferenceHIPSBathymetry

GPS vertical adjustment is applied using a datum model file.

--vertical-datum-reference GPS --compute-gps-vertical-adjustment --datum-model-file

GPS vertical adjustment is applied using a datum model band depth file.

C:/temp/input/myDatum.csar --datum-model-band DEPTH file:

Input 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:/temp/input/input.hips?Vessel=sample

Command Line

carisbatch --run GeoreferenceHIPSBathymetry --vertical-datum-reference GPS --compute-gps-vertical-adjustment --datum-model-file file:///C:/temp/input/myDatum.csar --datum-model-band DEPTH file:///C:/temp/input/input.hips?Vessel=sample

Outcome

The data is corrected and georeferenced with the values set by user.

Extra Notes

N/A