Caris Hips and Sips Vessel Editor
Caris Hips and Sips Vessel Editor
3 Vessel Editor
Reference Guide
Trademarks owned by Teledyne CARIS, Inc.
This is a listing of USPTO-registered trademarks and trademarks owned by Teledyne CARIS, Inc. and
might also be trademarks or registered trademarks in other countries. Please note that laws concerning
use and marking of trademarks or product names vary by country. Consult a local attorney for
additional guidance. Teledyne CARIS, Inc. permits the use of its trademarks and registered trademarks
only where they are used in reference to Teledyne CARIS, Inc. and its products, the markings used are
appropriate to the country or countries of publication, and Teledyne CARIS, Inc. is explicitly
acknowledged as the owner of the mark. Teledyne CARIS, Inc. reserves the right to withdraw this
permission at its sole discretion for any use it feels is inappropriate or adverse to its interests. Teledyne
CARIS, Inc. otherwise prohibits the use of any of its registered symbols, insignia, or other identifying
marks without express written approval. Violations are subject to liability for damages, injunctive relief,
attorney's fees and other penalties.
Not all trademarks used by Teledyne CARIS, Inc. are listed in this document. Failure of a mark to
appear on this page does not mean that Teledyne CARIS, Inc. does not use the mark nor does it mean
that the product is not actively marketed or is not significant within its relevant market. The absence of
a product or service name or logo from this list or the absence of a TM or TM Reg. USPTO notation
against a product or phrase listed below does not constitute a waiver by Teledyne CARIS, Inc. of its
trademark or other intellectual property rights concerning that name or logo.
Those trademarks followed by or footnoted as TM Reg. USPTO later in this document are registered
trademarks of Teledyne CARIS, Inc. in the United States; those followed by or footnoted as TM Reg.
CIPO
are registered trademarks of Teledyne CARIS, Inc. in Canada; those followed by or footnoted as
either TM Reg. USPTO and CIPO or TM Reg. USPTO, CIPO are registered trademarks of Teledyne CARIS, Inc.
in both the United States and Canada; those followed by or footnoted as TM are trademarks or common
law marks of Teledyne CARIS, Inc. in Canada and the United States, and in other countries.
The trademarks and names of other companies and products mentioned herein are the property of
their respective owners.
Sensor
Time stamps
Reference point
Once the vessel file is created you can enter the sensor position
data using a 3D outline for the vessel. See “CREATE VESSEL SHAPE
OUTLINE” ON PAGE 38.
Then you can enter or edit sensor information for the active
sensors as determined by the sensor parameters selected when
the vessel file was created. You can also designated other
sensors as active. See “SENSOR CONFIGURATION” ON PAGE 41
Vessel Configuration Files that were created in previous versions of HIPS and
SIPS can be opened and edited in Vessel Editor. The files are automatically
re-saved as HIPS Vessel Files.
3D Display Controls
The outline displayed in the editor can be rotated, zoomed and
panned using the compass (control axes), keyboard, and mouse.
Compass Rotation along the X-Y-Z axis is handled by moving the arrow
heads at the ends of the compass.
1. To rotate the image up to 90º along the Z-axis, click the middle arrow
head and drag the cursor upward so that the image is rotated.
2. To rotate the image up to 360º along the X-Y axis, click any of the other
arrow heads and drag the arrow head in a left-right or up-down
direction.
Modify Toolbar
The Vessel Editor toolbar is visible below the menu bar when the
application is opened. The toolbar can be un-docked from this
location and positioned within the interface, or on your desktop.
You can also hide the default toolbar by removing the check
mark next to Toolbar on the View menu.
To make the toolbar visible again,
1. Select Toolbar from the View menu so it is checked.
Move toolbars Toolbars can be moved to any location on the desktop:
1. Position the cursor over any area of the toolbar not covered by a
button,
2. Press and hold the mouse button while dragging the toolbar to a new
location.
3. Release the mouse button to position the toolbar.
Toolbars will automatically dock when they are close to certain
areas of the interface. To stop the toolbar from automatically
docking, hold down the <Ctrl> key while moving the toolbar.
Modify appearance You can alter the appearance and size of toolbar buttons.
1. Select the Customize command.
Menu
3. For each interface element, select a colour from the pull-down palette,
or create a custom colour from the standard Windows colour picker.
4. Click OK to activate the changes and close the Options dialog.
Vessel Files
The vessel file (HVF) in HIPS and SIPS describes the location
and calibration of sensor equipment installed on the survey
vessel. It defines the offsets and any associated error estimates
for each of the sensors.
For a description of the coordinate system upon which the vessel
configuration is based, see VESSEL COORDINATE SYSTEM.
The HVF is created in the HIPS Vessel Editor, and saved to the
folder …\HDCS_Data\VesselConfig.
If you create other data directories, the name of the
VesselConfig folder must not be changed and it always has to
be located inside the Raw Data directory on the same level as the
project directories.
In previous versions of HIPS and SIPS, a text file called the Vessel
Configuration File (VCF) was used. VCF files can still be opened and edited in
Vessel Editor, but when the file is re-saved, it is converted to HVF format.
New file
Tools > Editors >
Menu
In Vessel Editor:
2. Select the New Vessel File command.
Menu
File > New The Vessel Wizard - Step 1 (Vessel Information) dialog box is
displayed.
Tool
Type of Survey
The Step 2 dialog box prompts you to enter the sonar type used
in the survey.
Motion Sensors
This dialog box determines which attitude sensors are displayed
in the HVF.
1. Create entries for any (or all) of the following sensors by clicking the
appropriate check box:
• heave
• pitch
• roll
2. Select the Apply in Post Processing option to apply the motion data
during the Merge process or during Sound Velocity Correction.
3. Click Next.
Continue with CONFIGURATION OPTIONS.
Edit > Vessel Shape 1. Open the vessel file if it is not already open.
2. Select the Vessel Shape command.
Tool
The Plan View Shape dialog box is used for entering width and
length of the vessel.
1. Enter a width for the vessel in metres, measured from port to starboard.
2. Enter vessel length for the vessel from stern to the base of the bow.
3. Enter the length from the stern to the tip of the bow.
4. Click Next.
The Plan View PR dialog box is displayed. It is used to set the
position of the Reference Point (RP).
Reference point
Active sensors
To add or remove sensors from the list of active sensors:
Menu
Time Stamp
A vessel’s configuration changes over time. Different draft
settings may be used in a survey, or the position of the
transducers on a boom may change, or a different ellipsoid may
be used. A time stamp is used to keep track of these changes.
The time stamp records the time from which a configuration is
valid and is recorded with each entry to the HVF. Below is an
example of time stamps showing changes in vessel
configuration.
Time Correction
In the HVF, most sensors have a Time Correction field that contains
the time difference between the sensor clock and the reference
clock. Sensors are time tagged and all clocks are compared to the
reference clock so sensor readings can be synchronized.
The Time Correction field is specified in seconds and is positive if
ahead of the reference clock:
Transducer
The swath or multibeam sonar typically has beams that form a
fan shape, radiating from the centre of the transducer.
1. Click Transducer1 in the Sensors list box to highlight the selection and
display the swath data fields.
2. Type data as needed in the following fields:
• Date: The year and Julian day of current swath time stamp.
• Time: The hour and minute of the current swath time stamp.
• Time Correction: The time correction value.
The X-Y-Z fields set the location of the transducer from the
Reference Point (0).
• X: The athwart-ship distance of the transducer, positive to
starboard.
• Y: The along-ship distance of the transducer, positive to the
bow.
• Z: The vertical distance of the transducer, positive into the
water.
The Pitch, Roll and Yaw fields refer to misalignment of the
transducer, during mounting, from the vessel coordinate system.
Since the Kongsberg data read into HIPS is already corrected, the Transducer
values in the HVF must be set as follows:
• The X/Y/Z offsets are zero because the Kongsberg data
acquisition has already applied static draft and shifted the swath
profile to the vessel reference point.
• The Roll /Pitch /Yaw transducer mounting rotations are typically
zero because the Kongsberg data acquisition has already
applied patch test calibration results.
Sources
2. Select the Add Navigation Sources command.
The Add Navigation Sources dialog box is displayed.
Tool
3. Select the sources for the project from the list of available formats.
4. Click OK.
If you will be applying GPS tide data it must use the ellipsoid selected here.
4. Type new values in the Gyro and Error fields and click OK.
The Error Table is closed.
5. Type data as needed in the following fields:
• Manufacturer: The maker of the sensor equipment.
• Model: The particular make of sensor equipment.
• Serial Number: The serial number of the sensor equipment.
Heave
The heave sensor records the vertical motion of the vessel.
Although the heave sensor has its own section in the Vessel
Editor, it is part of the same sensor package as Pitch and Roll in
most survey configurations.
Kongsberg systems apply dynamic Heave, Pitch, and Roll values to the swath
data during survey. Therefore, the HVF must be set up with the Apply switches
for Heave, Pitch, and Roll set to '”No” so these values are not applied twice.
Pitch
Pitch refers to the rotational motion of the vessel around the X-
axis (port/starboard). Although the pitch sensor has its own
section in the Vessel Editor, it is part of the same sensor package
as roll and heave in most survey configurations.
1. Click Pitch in the Sensors list box so the selection is highlighted and the
data fields are displayed.
2. Type data (as needed) in the following fields:
• Date: The year and Julian day of the current pitch time stamp.
Kongsberg systems apply dynamic Heave, Pitch, and Roll values to the swath
data during survey. Therefore, the HVF must be set up with the Apply switches
for Heave, Pitch, and Roll set to '”No” so these values are not applied twice.
Roll
Roll refers to the rotational motion of the vessel around the Y-
axis (fore/aft). Although the roll sensor has its own section in the
Vessel Editor, it is part of the same sensor package as pitch and
heave in most survey configurations.
1. Click Roll in the Sensors list box to highlight selection and display the
roll data fields.
2. Type data (as needed) in the following fields:
• Date: The year and Julian day of the current roll time stamp.
• Time: The hour and minute of the current roll time stamp.
• Time Correction: The time correction value.
• Error: The applied instantaneous values for the roll sensor are
computed by subtracting the appropriate errors from the recorded
values:
Applied Roll = Recorded Roll - Roll Error.
• Apply: Select Yes to apply the roll data in the merge process.
• Manufacturer: The maker of the sensor equipment.
• Model: The particular make of the sensor equipment.
• Serial Number: The serial number of the sensor equipment.
The location of the roll sensor is indicated in the Vessel Editor by
a coloured dot.
Kongsberg systems apply dynamic Heave, Pitch, and Roll values to the swath
data during survey. Therefore, the HVF must be set up with the Apply switches
for Heave, Pitch, and Roll set to '”No” so these values are not applied twice.
SVP
A sound velocity profile (SVP) records the speed of sound at
various depths in the water column. HIPS lets you apply SVP
data in sound velocity corrections, but not for all types of sonars
because some sonar data logging systems compensate for sound
velocity during data acquisition.
To ensure the SVP is accurately applied in HIPS, the transducer
X-Y-Z offset values must be entered.
1. Click SVP 1 in the Sensors list box.
The selection is highlighted and the SVP transducer data fields
are visible. If there is a second transducer then click SVP 2 and
complete the same procedures as listed below.
2. Type data as needed in the following fields:
• Date: The year and Julian day of the current SVP pole time stamp.
• Time: The hour and minute of the current SVP pole time stamp.
3. Select Yes if there are dual transducers or No if there is only a single
transducer.
The following three fields are for entering the X-Y-Z coordinates
of the pole. All coordinates are measured from the Reference
Point.
4. Type the transducer’s X-Y-Z offsets in the following fields:
• X: The athwart-ship distance of the transducer, positive to
starboard.
• Y: The along-ship distance of the transducer, positive to the bow.
• Z: The vertical distance of the transducer, positive into the water.
Sweep
Sweep systems typically contain multiple vertical beam
transducers mounted on a boom and pointed straight down. The
reference point for a sweep system can be anywhere on the X-Y
plane, but must be on the water surface.
1. Click Sweep in the Sensors list box to highlight the selection and display
the data fields.
Towed Sensors
If a towed sensor such as a side scan sonar is used on a survey,
then HIPS and SIPS can compute the sensor’s position relative
to the ship's position by calculating the horizontal layback and a
direction to the sensor.
1. Click Towed in the Sensors list box to highlight the selection and display
the Towed data fields.
2. Type data as needed in the following fields:
• Date: The year and Julian day of the current towed sensor time
stamp.
• Time: The hour and minute of the current towed sensor time stamp.
• Time Correction: The time correction value.
• Layback Error: The error in the computed or recorded horizontal
layback. This can be used, for example, to compensate the
recorded layback data or tow cable length for the distance between
the origin of the measurements and the defined tow point location in
the tow cable length. This value is subtracted from the computed
horizontal layback.
• X: Offset of the tow point from the vessel’s reference position.
• Y: Offset of the tow point from the vessel’s reference position.
• Z: Height of the tow point (negative upwards) in relation to the
datum that is referenced to the sensor depth (in most cases, this is
the waterline height).
• Manufacturer: The maker of the towed sensor.
Waterline Height
This section of the vessel file defines long-period changes in the
vessel's draft due to fuel burn or other loading changes.
Specifically, it defines the height of the waterline below the
Reference Point.
If the Waterline Height is not defined here, HIPS uses a default
of zero as the height.
If you want waterline height to be applied during sound velocity
correction, there must be a value in the Waterline Height section
of the HVF.
1. Click Waterline Height in the Sensors list box to highlight the selection
and display the waterline data fields.
2. Type data (as needed) in the following fields:
Date: The year and Julian day of the current waterline time stamp.
Time: The hour and minute of the current waterline time stamp.
Waterline: The distance from the RP, positive when below the RP.
Apply: Select Yes to apply the waterline data in the Merge process.
Comments: A text field for your use.
For Kongsberg data, the Waterline value must be set to the same value
recorded as WLZ in the Kongsberg Installation Datagram.
This Waterline value will only be used during Sound Velocity Correction.
Set the Apply switch to “No”. If it is set to “Yes”, it will be applied twice, once in
SVC and again in Merge.
Reference Point Sensor positions are described using X-Y-Z axis coordinates
relative to a Reference Point (RP). The RP is a location from
which all other positions are derived.
The location of the RP depends upon the type of sonar system
used in the survey. Its location is usually at the centre of gravity
of the ship. This position is used as the centre of the ship’s
rotation when applying the pitch/heave/roll parameters, and
must be applied as accurately as possible.
Coordinate definitions The axes are defined as follows:
• The Y-axis is oriented along the vessel’s fore/aft axis, positive
forward.
• The X-axis is oriented along the vessel’s port/starboard axis,
perpendicular to the Y-axis, positive to the starboard.
• The Z-axis is perpendicular to the X-Y plane, and positive into
the water.
This is illustrated in the following image.