OMG Code Usage Guide

This guide provides information on how to use the various tools in the OMG codebase. The information here is extracted from the legacy TiddlyWiki files.

Getting Started

How to obtain and compile the code

The code lives on a subversion server located in the OMG offices at UNB. To download the code with read only permissions (you can’t commit your changes) use the following commands:

sudo apt-get install subversion subversion-tools
mkdir ~/code
cd ~/code
svn checkout svn+ssh://omg_user@amundsen.omg.unb.ca/drives/amundsen/disk1/code

To enable commit permissions use your OMG account name instead of ‘omg_user’ or contact someone at OMG:

Ian Church: ianc@omg.unb.ca
James Muggah: jmuggah@unb.ca
Steve Brucker: steveb@omg.unb.ca

Adding new sounder tool types

This section documents how to add support for a new sonar system.

Edit OMG_HDCS_jversion.h to include support for a new tool

1a. Increment the number of tools by 1.
```
#define NO_TOOLS      47        /* currently */
```
1b. Add the new tooltype in the various “tool_def” arrays in OMG_HDCS_jversion.h, for this you need to know the MAXIMUM number of beams that the system can support.

1c. Add a tool number definition for the new tool.
```
#define ODOM_ES3        46
```
1d. Add a human-readable tool name in the tool_names array.

1e. Compile to catch any syntax errors, etc:
```
make -B OMG_HDCS_jversion.o
```
Add V4 initialization support for the new tool type in OMG_HDCS_jversion.c by editing the OMG_HDCS_initiate_V4_summary function.
Add support for new data type in SwathEd by updating SE_mainwin.h, SE_mainwin.c, SE_omgIOwin.c and SE_listwin.c.
Write a program to convert the raw data into OMG format. Examples can be found in 7k2omg.c, hypack2omg.c, xtf2omg_reson.c, gsf2omg.c.
Add support for the tool type in newMergeAtt by updating OMG_get_rational_beams in OMG_HDCS_jversion.c and get_sounding_geometry.c in sonar_geometry.c.
Recompile all the OMG programs.

Tool Reference

SVP Tool & WOD

Introduction The OMG SVP Toolkit is used to visualize, manipulate and analyze large volume sound speed profile data sets. It has functionality to access the World Ocean Database (WOD).

Environment Variables