CARIS Batch Utility : HIPS Processes : Georeference Bathymetry
 

Georeference Bathymetry

Description

The GeoreferenceHIPSBathymetry process optionally uses ray tracing algorithms to create along track/across track depths from raw range and angle information and then merge all sensor data into latitude, longitude, and depth using horizontal and vertical offsets from the HIPS vessel file. This geographically references the sounding position and depth. Optionally tidal or GPS measurements can be used to vertically adjust the data. Finally, if total propagated uncertainty is required, it will compute the depth and horizontal uncertainty values during processing.

Inputs

One or more HIPS track lines.

Outputs

One or more processed HIPS track lines.

Command line syntax

carisbatch --run GeoreferenceHIPSBathymetry file:///C:/temp/input/input.hips?Vessel=sample

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

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

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

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

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

User Interface Command

Georeference Bathymetry

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short key

Description

Can Repeat

Notes

 

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.

ProfileSelectionMethod

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.

ResteerBeamAngles

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.

HeaveSource

Type of heave to be applied during merge.

HEAVE: Realtime - Original heave data will be used

DELAYED_HEAVE: Delayed heave data will be used

The defaults value is HEAVE.

FALSE

This option is used with ComputeSVC and Merge

VehicleDepth

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

ComputeTPU

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

FALSE

TideMeasured

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.

TideZoning

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.

SVMeasured

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.

SVSurface

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.

SweepMaxHeave

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.

SweepMaxPitch

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.

SweepMaxRoll

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.

SourceSonar

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.

SourceNavigation

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.

SourceGyro

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.

SourcePitch

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.

SourceRoll

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.

SourceHeave

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.

SourceTide

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.

VerticalDatumReference

The type of tide to be applied.

NONE: None - No tidal correction will be applied

TIDE: Tide - Observed tidal corrections will be applied

GPS: GPS - GPS tidal corrections will be applied

The default value is NONE.

FALSE

TideFile

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.

WeightedAverage

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

FALSE

Use when VerticalDatumReference = TIDE and ZDF file is set.

ComputeErrors

If set, computes errors during multiple tide station interpolation.

FALSE

Use when VerticalDatumReference = TIDE and ZDF file is set.

ComputeGPSVerticalAdjustment

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

FALSE

Use when VerticalDatumReference= GPS

SmoothHeight

If set, applies smoothing to GPS height.

FALSE

DatumModelFile

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 TIN, raster surface or point cloud.

FALSE

Use when VerticalDatumReference= GPS and ComputeGPSVerticalAdjustment is set.

DatumModelBand

A string specifying the datum model band name.

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

FALSE

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

InfoFile

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

InputCRS

p

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

FALSE

This must be explicitly set.

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

OutputComponents

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.

VerticalOffset

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.

ApplyRefractionCoeff

If set, applies refraction coefficients.

FALSE

BeamShift

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

BeamShiftFile

The path to the beam shift file.

FALSE

Use when BeamShift = STATIC or RELATIVE.

SmoothSensor

If set, applies smoothing coefficients to the specified data.

GYRO: Gyro - Smoothes the gyro data.

HEAVE: Heave - Smoothes the heave data.

PITCH: Pitch - Smoothes the pitch data.

ROLL: Roll - Smoothes the roll data.

SOW: Speed over water - Smoothes the speed over water data.

DELTA_DRAFT: Delta draft - Smoothes the delta draft/subsea depth data.

GPS_TIDE: GPS tide - Smoothes the GPS tide data.

TIDE: Tide - Smoothes the tide data.

GPS_HEIGHT: GPS height - Smoothes the GPS Height data.

TRUE